Visibility.h

//-*****************************************************************************
//
// Copyright (c) 2009-2011,
//  Sony Pictures Imageworks, Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************
 
#ifndef Alembic_AbcGeom_Visibility_h
#define Alembic_AbcGeom_Visibility_h
 
#include <string.h>
#include <Alembic/Util/Export.h>
#include <Alembic/AbcGeom/Foundation.h>
#include <Alembic/Abc/OSchemaObject.h>
 
 
 
namespace Alembic {
namespace AbcGeom {
namespace ALEMBIC_VERSION_NS {

enum ObjectVisibility
{
    kVisibilityDeferred = -1,

    kVisibilityHidden = 0,

    kVisibilityVisible = 1,
};

static const std::string kVisibilityPropertyName = "visible";
 
typedef Abc::ICharProperty IVisibilityProperty;
typedef Abc::OCharProperty OVisibilityProperty;
 
 
// For Writer code:

ALEMBIC_EXPORT OVisibilityProperty
CreateVisibilityProperty( OObject & iObject,
                          uint32_t iTimeSamplingID );

ALEMBIC_EXPORT OVisibilityProperty
CreateVisibilityProperty( OObject & iObject,
                          AbcA::TimeSamplingPtr iTimeSampling );
 
// For Reader code:

ALEMBIC_EXPORT IVisibilityProperty
GetVisibilityProperty( IObject & schemaObject );

ALEMBIC_EXPORT ObjectVisibility
GetVisibility( IObject & schemaObject,
               const Abc::ISampleSelector &iSS =
               Abc::ISampleSelector () );

ALEMBIC_EXPORT bool
IsAncestorInvisible( IObject schemaObject,
                     const Abc::ISampleSelector &iSS =
                     Abc::ISampleSelector () );
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcGeom
} // End namespace Alembic
 
#endif