Alembic Version 1.1
Loading...
Searching...
No Matches
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema Class Reference

#include <OPoints.h>

+ Inheritance diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema:
+ Collaboration diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema:

Classes

class  Sample
 

Public Types

typedef OPointsSchema this_type
 
- Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PointsSchemaInfo >
typedef PointsSchemaInfo info_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PointsSchemaInfo >
typedef PointsSchemaInfo info_type
 
typedef OSchema< PointsSchemaInfo > 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::CompoundPropertyWriterPtrthis_type
 
typedef OBasePropertyT< AbcA::CompoundPropertyWriterPtroperator_bool_base_type
 

Public Member Functions

 OPointsSchema ()
 
 OPointsSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument(), const Abc::Argument &iArg3=Abc::Argument())
 
 OPointsSchema (Abc::OCompoundProperty iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
 OPointsSchema (const OPointsSchema &iCopy)
 Copy constructor.
 
AbcA::TimeSamplingPtr getTimeSampling () const
 Default assignment operator used.
 
size_t getNumSamples () const
 
void set (const Sample &iSamp)
 Set a sample.
 
void setFromPrevious ()
 
void setTimeSampling (uint32_t iIndex)
 
void setTimeSampling (AbcA::TimeSamplingPtr iTime)
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (OPointsSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PointsSchemaInfo >
 OGeomBaseSchema ()
 
 OGeomBaseSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
 
 OGeomBaseSchema (const OGeomBaseSchema &iCopy)
 Copy constructor.
 
Abc::OCompoundProperty getArbGeomParams ()
 
Abc::OCompoundProperty getUserProperties ()
 
Abc::OBox3dProperty getChildBoundsProperty ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PointsSchemaInfo >
 OSchema ()
 
 OSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
 
 OSchema (OCompoundProperty iParent, const std::string &iName, 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 ()
 
 OCompoundProperty (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 OCompoundProperty (OCompoundProperty iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 OCompoundProperty (AbcA::CompoundPropertyWriterPtr iProp, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 OCompoundProperty (AbcA::CompoundPropertyWriterPtr iProp, WrapExistingFlag iWrapFlag=kWrapExisting, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 OCompoundProperty (OObject iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 OCompoundProperty (OObject iObject, TopFlag iTopFlag=kTop, 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::string & getName () 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
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PointsSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getSchemaBaseType ()
 
static const char * getDefaultSchemaName ()
 
static bool replaceOnSparse ()
 
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::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PointsSchemaInfo >
void init (uint32_t iTsIndex, bool isSparse)
 
void createSelfBoundsProperty (uint32_t iTsIndex, size_t iNumSamples)
 Creates the self bounds.
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::CompoundPropertyWriterPtr iPtr, 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 inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PointsSchemaInfo >
Abc::OBox3dProperty m_selfBoundsProperty
 
Abc::OBox3dProperty m_childBoundsProperty
 
Abc::OCompoundProperty m_arbGeomParams
 
Abc::OCompoundProperty m_userProperties
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr m_property
 

Detailed Description

Definition at line 51 of file OPoints.h.

Member Typedef Documentation

◆ this_type

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

Definition at line 148 of file OPoints.h.

Constructor & Destructor Documentation

◆ OPointsSchema() [1/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::OPointsSchema ( )
inline

The default constructor creates an empty OPointsSchema ...

Definition at line 156 of file OPoints.h.

◆ OPointsSchema() [2/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::OPointsSchema ( AbcA::CompoundPropertyWriterPtr iParent,
const std::string & iName,
const Abc::Argument & iArg0 = Abc::Argument(),
const Abc::Argument & iArg1 = Abc::Argument(),
const Abc::Argument & iArg2 = Abc::Argument(),
const Abc::Argument & iArg3 = Abc::Argument() )

This constructor creates a new poly mesh writer. The first argument is an CompoundPropertyWriterPtr to use as a parent. The next is the name to give the schema which is usually the default name given by OFaceSet (.geom) The remaining optional arguments can be used to override the ErrorHandlerPolicy, to specify MetaData, specify sparse sampling and to set TimeSampling.

◆ OPointsSchema() [3/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::OPointsSchema ( Abc::OCompoundProperty iParent,
const std::string & iName,
const Abc::Argument & iArg0 = Abc::Argument(),
const Abc::Argument & iArg1 = Abc::Argument(),
const Abc::Argument & iArg2 = Abc::Argument() )

This constructor creates a new poly mesh writer. The first argument is an OCompundProperty to use as a parent, and from which the ErrorHandlerPolicy is derived. The next is the name to give the schema which is usually the default name given by OFaceSet (.geom) The remaining optional arguments can be used to specify MetaData, specify sparse sampling and to set TimeSampling.

◆ OPointsSchema() [4/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::OPointsSchema ( const OPointsSchema & iCopy)
inline

Copy constructor.

Definition at line 189 of file OPoints.h.

Member Function Documentation

◆ ALEMBIC_OVERRIDE_OPERATOR_BOOL()

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

unspecified-bool-type operator overload. ...

◆ getNumSamples()

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

Get number of samples written so far. ...

Definition at line 220 of file OPoints.h.

◆ getTimeSampling()

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

Default assignment operator used.

Return the time sampling

Definition at line 202 of file OPoints.h.

◆ reset()

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

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

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

Definition at line 240 of file OPoints.h.

◆ set()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::set ( const Sample & iSamp)

Set a sample.

◆ setFromPrevious()

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

Set from previous sample. Will apply to each of positions, ids, velocities, and widths

◆ setTimeSampling() [1/2]

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::setTimeSampling ( AbcA::TimeSamplingPtr iTime)

◆ setTimeSampling() [2/2]

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPointsSchema::setTimeSampling ( uint32_t iIndex)

◆ valid()

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

Valid returns whether this function set is valid.

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

Definition at line 252 of file OPoints.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< INFO >::valid().

+ Here is the call graph for this function:

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