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

#include <IPoints.h>

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

Classes

class  Sample
 

Public Types

typedef IPointsSchema this_type
 
- Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >
typedef PointsSchemaInfo info_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< PointsSchemaInfo >
typedef PointsSchemaInfo info_type
 
typedef ISchema< PointsSchemaInfo > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty this_type
 

Public Member Functions

 IPointsSchema ()
 
template<class CPROP_PTR >
 IPointsSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IPointsSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
 IPointsSchema (const IPointsSchema &iCopy)
 Copy constructor. More...
 
size_t getNumSamples () const
 Default assignment operator used. More...
 
bool isConstant () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
void get (Sample &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Sample getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Abc::IP3fArrayProperty getPositionsProperty () const
 
Abc::IV3fArrayProperty getVelocitiesProperty () const
 
Abc::IUInt64ArrayProperty getIdsProperty () const
 
IFloatGeomParam getWidthsParam () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (IPointsSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >
 IGeomBaseSchema ()
 
 IGeomBaseSchema (CPROP_PTR iParentCompound, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IGeomBaseSchema (CPROP_PTR iParentCompound, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IGeomBaseSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing schema object. More...
 
 IGeomBaseSchema (const IGeomBaseSchema &iCopy)
 Copy constructor. More...
 
void init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
Abc::IBox3dProperty getSelfBoundsProperty () const
 
Abc::IBox3dProperty getChildBoundsProperty () const
 
ICompoundProperty getArbGeomParams () const
 
ICompoundProperty getUserProperties () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< PointsSchemaInfo >
 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::IP3fArrayProperty m_positionsProperty
 
Abc::IUInt64ArrayProperty m_idsProperty
 
Abc::IV3fArrayProperty m_velocitiesProperty
 
IFloatGeomParam m_widthsParam
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >
Abc::IBox3dProperty m_selfBoundsProperty
 
Abc::IBox3dProperty m_childBoundsProperty
 
Abc::ICompoundProperty m_arbGeomParams
 
Abc::ICompoundProperty m_userProperties
 
- 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< PointsSchemaInfo >
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 51 of file IPoints.h.

Member Typedef Documentation

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

Definition at line 98 of file IPoints.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema ( )
inline

The default constructor creates an empty OPointsSchema ...

Definition at line 106 of file IPoints.h.

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

This templated, explicit function creates a new scalar property reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an CompoundPropertyReaderPtr 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 TimeSamplingType.

Definition at line 116 of file IPoints.h.

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

This constructor is the same as above, but with default schema name used.

Definition at line 130 of file IPoints.h.

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

Copy constructor.

Definition at line 140 of file IPoints.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::get ( Sample oSample,
const Abc::ISampleSelector iSS = Abc::ISampleSelector() 
) const
inline

Definition at line 176 of file IPoints.h.

Abc::IUInt64ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getIdsProperty ( ) const
inline

Definition at line 211 of file IPoints.h.

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getNumSamples ( ) const
inline

Default assignment operator used.

Return the number of samples contained in the property. This can be any number, including zero. This returns the number of samples that were written, independently of whether or not they were constant.

Definition at line 156 of file IPoints.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getPositionsProperty ( ) const
inline

Definition at line 201 of file IPoints.h.

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

Time sampling Information.

Definition at line 166 of file IPoints.h.

Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getValue ( const Abc::ISampleSelector iSS = Abc::ISampleSelector()) const
inline

Definition at line 194 of file IPoints.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getVelocitiesProperty ( ) const
inline

Definition at line 206 of file IPoints.h.

IFloatGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getWidthsParam ( ) const
inline

Definition at line 216 of file IPoints.h.

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

Ask if we're constant - no change in value amongst samples, regardless of the time sampling.

Definition at line 162 of file IPoints.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::reset ( )
inlinevirtual

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

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >.

Definition at line 229 of file IPoints.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::valid ( ) const
inlinevirtual

Valid returns whether this function set is valid.

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >.

Definition at line 241 of file IPoints.h.

Member Data Documentation

Abc::IUInt64ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_idsProperty
protected

Definition at line 257 of file IPoints.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_positionsProperty
protected

Definition at line 256 of file IPoints.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_velocitiesProperty
protected

Definition at line 258 of file IPoints.h.

IFloatGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_widthsParam
protected

Definition at line 259 of file IPoints.h.


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