ILight.h
Go to the documentation of this file.
//-*****************************************************************************
//
// Copyright (c) 2009-2012,
// 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_ILight_h
#define Alembic_AbcGeom_ILight_h
#include <Alembic/Util/Export.h>
#include <Alembic/AbcGeom/ICamera.h>
#include <Alembic/AbcGeom/Foundation.h>
#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
namespace Alembic {
namespace AbcGeom {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT ILightSchema : public Abc::ISchema<LightSchemaInfo>
{
//-*************************************************************************
// LIGHT SCHEMA (container schema which has a camera schema)
//-*************************************************************************
public:
typedef ILightSchema this_type;
//-*************************************************************************
// CONSTRUCTION, DESTRUCTION, ASSIGNMENT
//-*************************************************************************
ILightSchema() {}
ILightSchema( const ICompoundProperty &iParent,
const std::string &iName,
const Abc::Argument &iArg0 = Abc::Argument(),
const Abc::Argument &iArg1 = Abc::Argument() )
: Abc::ISchema<LightSchemaInfo>( iParent, iName, iArg0, iArg1 )
{
init( iArg0, iArg1 );
}
explicit ILightSchema( const ICompoundProperty &iProp,
const Abc::Argument &iArg0 = Abc::Argument(),
const Abc::Argument &iArg1 = Abc::Argument() )
: Abc::ISchema<LightSchemaInfo>( iProp, iArg0, iArg1 )
{
init( iArg0, iArg1 );
}
ILightSchema(const ILightSchema& iCopy)
: Abc::ISchema<LightSchemaInfo>()
{
*this = iCopy;
}
ICameraSchema getCameraSchema() const { return m_cameraSchema; }
Abc::IBox3dProperty getChildBoundsProperty() const
{
return m_childBoundsProperty;
}
AbcA::TimeSamplingPtr getTimeSampling() const;
bool isConstant() const;
size_t getNumSamples() const;
// compound property to use as parent for any arbitrary GeomParams
// underneath it
ICompoundProperty getArbGeomParams() const { return m_arbGeomParams; }
ICompoundProperty getUserProperties() const { return m_userProperties; }
void reset()
{
m_childBoundsProperty.reset();
m_arbGeomParams.reset();
m_userProperties.reset();
m_cameraSchema.reset();
Abc::ISchema<LightSchemaInfo>::reset();
}
bool valid() const
{
return ( Abc::ISchema<LightSchemaInfo>::valid() );
}
ALEMBIC_OVERRIDE_OPERATOR_BOOL( ILightSchema::valid() );
protected:
void init( const Abc::Argument& iArg0,
const Abc::Argument& iArg1 );
Abc::IBox3dProperty m_childBoundsProperty;
Abc::ICompoundProperty m_arbGeomParams;
Abc::ICompoundProperty m_userProperties;
Alembic::AbcGeom::ICameraSchema m_cameraSchema;
};
//-*****************************************************************************
// SCHEMA OBJECT
//-*****************************************************************************
typedef Abc::ISchemaObject< ILightSchema > ILight;
typedef Util::shared_ptr< ILight > ILightPtr;
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace AbcGeom
} // End namespace Alembic
#endif
Foundation.h
SchemaInfoDeclarations.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ICamera.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema
Definition: ICamera.h:51
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema
Definition: ILight.h:51
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getCameraSchema
ICameraSchema getCameraSchema() const
Access to the camera schema.
Definition: ILight.h:103
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::this_type
ILightSchema this_type
Definition: ILight.h:58
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_cameraSchema
Alembic::AbcGeom::ICameraSchema m_cameraSchema
Definition: ILight.h:151
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL
ALEMBIC_OVERRIDE_OPERATOR_BOOL(ILightSchema::valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ILight.h:87
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_childBoundsProperty
Abc::IBox3dProperty m_childBoundsProperty
Definition: ILight.h:147
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getNumSamples
size_t getNumSamples() const
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getChildBoundsProperty
Abc::IBox3dProperty getChildBoundsProperty() const
Access to the child bounds property.
Definition: ILight.h:106
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::isConstant
bool isConstant() const
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition: ILight.h:134
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema()
Definition: ILight.h:66
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema(const ILightSchema &iCopy)
Copy constructor.
Definition: ILight.h:96
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_arbGeomParams
Abc::ICompoundProperty m_arbGeomParams
Definition: ILight.h:148
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ILight.h:74
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_userProperties
Abc::ICompoundProperty m_userProperties
Definition: ILight.h:149
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::init
void init(const Abc::Argument &iArg0, const Abc::Argument &iArg1)
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getArbGeomParams
ICompoundProperty getArbGeomParams() const
Definition: ILight.h:119
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::reset
void reset()
Definition: ILight.h:124
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getUserProperties
ICompoundProperty getUserProperties() const
Definition: ILight.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition: Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >::reset
void reset()
Definition: IBaseProperty.h:160
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition: ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition: ISchemaObject.h:56
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema
Definition: ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedScalarProperty< Box3dTPTraits >
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightPtr
Util::shared_ptr< ILight > ILightPtr
Definition: ILight.h:159
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILight
Abc::ISchemaObject< ILightSchema > ILight
Definition: ILight.h:157
Alembic::Abc::ALEMBIC_VERSION_NS
Definition: ArchiveInfo.h:48
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46