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

#include <OLight.h>

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

Public Types

typedef OLightSchema this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< LightSchemaInfo >
typedef LightSchemaInfo info_type
 
typedef OSchema< LightSchemaInfo > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
typedef OCompoundProperty this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
this_type
 
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
operator_bool_base_type
 

Public Member Functions

 OLightSchema ()
 
template<class CPROP_PTR >
 OLightSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
template<class CPROP_PTR >
 OLightSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
 OLightSchema (const OLightSchema &iCopy)
 Copy constructor. More...
 
AbcA::TimeSamplingPtr getTimeSampling () const
 Default assignment operator used. More...
 
size_t getNumSamples ()
 
void setCameraSample (const CameraSample &iSamp)
 Set a sample. More...
 
void setFromPrevious ()
 Set from previous sample. More...
 
void setTimeSampling (uint32_t iIndex)
 
void setTimeSampling (AbcA::TimeSamplingPtr iTime)
 
Abc::OCompoundProperty getUserProperties ()
 
Abc::OCompoundProperty getArbGeomParams ()
 
Abc::OBox3dProperty getChildBoundsProperty ()
 
void reset ()
 
bool valid () const
 Returns whether this function set is valid. More...
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (OLightSchema::valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< LightSchemaInfo >
 OSchema ()
 
 OSchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OSchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
virtual ~OSchema ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
 OCompoundProperty ()
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 OCompoundProperty (OBJECT_PTR iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~OCompoundProperty ()
 
size_t getNumProperties () const
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
OBaseProperty getProperty (size_t i) const
 
OBaseProperty getProperty (const std::string &iName) const
 
OCompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
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
 
OObject getObject () const
 
AbcA::CompoundPropertyWriterPtr 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 Attributes

AbcA::TimeSamplingPtr m_tsPtr
 
Abc::OBox3dProperty m_childBoundsProperty
 
Abc::OCompoundProperty m_userProperties
 
Abc::OCompoundProperty m_arbGeomParams
 
AbcGeom::OCameraSchema m_cameraSchema
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr m_property
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< LightSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getSchemaBaseType ()
 
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 Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::CompoundPropertyWriterPtriPtr, WrapExistingFlag, 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 ()
 

Detailed Description

Definition at line 51 of file OLight.h.

Member Typedef Documentation

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

Definition at line 59 of file OLight.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::OLightSchema ( )
inline

The default constructor creates an empty OLightMeshSchema ...

Definition at line 67 of file OLight.h.

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

This templated, primary constructor creates a new camera 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 77 of file OLight.h.

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

Definition at line 108 of file OLight.h.

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

Copy constructor.

Definition at line 138 of file OLight.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

Abc::OCompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getArbGeomParams ( )
Abc::OBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getChildBoundsProperty ( )
size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getNumSamples ( )

All of our properties are not mandatory so we'll just use the child bounds.

AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getTimeSampling ( ) const
inline

Default assignment operator used.

Return the time sampling.

Definition at line 151 of file OLight.h.

Abc::OCompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getUserProperties ( )
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::reset ( )
inline

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

Definition at line 181 of file OLight.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::setCameraSample ( const CameraSample iSamp)

Set a sample.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::setFromPrevious ( )

Set from previous sample.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::setTimeSampling ( uint32_t  iIndex)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::setTimeSampling ( AbcA::TimeSamplingPtr  iTime)
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::valid ( ) const
inline

Returns whether this function set is valid.

Definition at line 191 of file OLight.h.

Member Data Documentation

Abc::OCompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::m_arbGeomParams
protected

Definition at line 207 of file OLight.h.

AbcGeom::OCameraSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::m_cameraSchema
protected

Definition at line 209 of file OLight.h.

Abc::OBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::m_childBoundsProperty
protected

Definition at line 204 of file OLight.h.

AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::m_tsPtr
protected

Definition at line 202 of file OLight.h.

Abc::OCompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::m_userProperties
protected

Definition at line 206 of file OLight.h.


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