HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema Class Reference

#include <ILight.h>

+ Inheritance diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema:

Public Types

typedef ILightSchema this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< LightSchemaInfo >
typedef LightSchemaInfo info_type
 
typedef ISchema< LightSchemaInfo > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty this_type
 

Public Member Functions

 ILightSchema ()
 
template<class CPROP_PTR >
 ILightSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 ILightSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 ILightSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing ILight object. More...
 
 ILightSchema (const ILightSchema &iCopy)
 Copy constructor. More...
 
ICameraSchema getCameraSchema () const
 Access to the camera schema. More...
 
Abc::IBox3dProperty getChildBoundsProperty () const
 Access to the child bounds property. More...
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
bool isConstant () const
 
size_t getNumSamples () const
 
ICompoundProperty getArbGeomParams () const
 
ICompoundProperty getUserProperties () const
 
void reset ()
 
bool valid () const
 Returns whether this function set is valid. More...
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (ILightSchema::valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< LightSchemaInfo >
 ISchema ()
 
 ISchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR iProperty, WrapExistingFlag iFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
virtual ~ISchema ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
 ICompoundProperty ()
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0=Argument())
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 ICompoundProperty (OBJECT_PTR iThisObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~ICompoundProperty ()
 
size_t getNumProperties () const
 Returns the number of properties contained in this ICompoundProperty. More...
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
ICompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
const AbcA::PropertyHeadergetHeader () const
 
const std::stringgetName () const
 
AbcA::PropertyType getPropertyType () const
 
bool isScalar () const
 
bool isArray () const
 
bool isCompound () const
 
bool isSimple () const
 
const AbcA::MetaDatagetMetaData () const
 
const AbcA::DataTypegetDataType () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
IObject getObject () const
 
AbcA::CompoundPropertyReaderPtr getPtr () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OPERATOR_BOOL (valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
ErrorHandlergetErrorHandler () const
 
ErrorHandler::Policy getErrorHandlerPolicy () const
 

Protected Member Functions

void init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::CompoundPropertyReaderPtriPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
 Base ()
 
 Base (ErrorHandler::Policy iPolicy)
 
 Base (const Base &iCopy)
 
Baseoperator= (const Base &iCopy)
 
bool valid () const
 
void reset ()
 

Protected Attributes

Abc::IBox3dProperty m_childBoundsProperty
 
Abc::ICompoundProperty m_arbGeomParams
 
Abc::ICompoundProperty m_userProperties
 
Alembic::AbcGeom::ICameraSchema m_cameraSchema
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
AbcA::CompoundPropertyReaderPtr m_property
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< LightSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getDefaultSchemaName ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 
- Protected Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
operator_bool_base_type
 

Detailed Description

Definition at line 50 of file ILight.h.

Member Typedef Documentation

By convention we always define this_type in AbcGeom classes. Used by unspecified-bool-type conversion below

Definition at line 58 of file ILight.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema ( )
inline

The default constructor creates an empty OLightMeshSchema ...

Definition at line 66 of file ILight.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema ( CPROP_PTR  iParent,
const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inline

This templated, primary constructor creates a new light writer. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an CompoundPropertyWriterPtr to use as a parent, from which the error handler policy for inheritance is also derived. The remaining optional arguments can be used to override the ErrorHandlerPolicy, to specify MetaData, and to set TimeSampling.

Definition at line 76 of file ILight.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema ( CPROP_PTR  iParent,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inlineexplicit

Definition at line 86 of file ILight.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema ( CPROP_PTR  iThis,
Abc::WrapExistingFlag  iFlag,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inlineexplicit

Wrap an existing ILight object.

Definition at line 96 of file ILight.h.

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema ( const ILightSchema iCopy)
inline

Copy constructor.

Definition at line 106 of file ILight.h.

Member Function Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL ( ILightSchema::  valid())

unspecified-bool-type operator overload. ...

ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getArbGeomParams ( ) const
inline

Definition at line 129 of file ILight.h.

ICameraSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getCameraSchema ( ) const
inline

Access to the camera schema.

Definition at line 113 of file ILight.h.

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getChildBoundsProperty ( ) const
inline

Access to the child bounds property.

Definition at line 116 of file ILight.h.

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getNumSamples ( ) const
AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getTimeSampling ( ) const
ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getUserProperties ( ) const
inline

Definition at line 130 of file ILight.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::init ( const Abc::Argument iArg0,
const Abc::Argument iArg1 
)
protected
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::isConstant ( ) const
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::reset ( )
inline

Reset returns this function set to an empty, default state.

Definition at line 134 of file ILight.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::valid ( ) const
inline

Returns whether this function set is valid.

Definition at line 144 of file ILight.h.

Member Data Documentation

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_arbGeomParams
protected

Definition at line 158 of file ILight.h.

Alembic::AbcGeom::ICameraSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_cameraSchema
protected

Definition at line 161 of file ILight.h.

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_childBoundsProperty
protected

Definition at line 157 of file ILight.h.

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::m_userProperties
protected

Definition at line 159 of file ILight.h.


The documentation for this class was generated from the following file: