#include <IPoints.h>

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

Collaboration 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 ()
	IPointsSchema (const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
	IPointsSchema (const ICompoundProperty iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
	IPointsSchema (const IPointsSchema &iCopy)
	Copy constructor.
size_t	getNumSamples () const
	Default assignment operator used.
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 ()
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 ()
virtual	~ISchema ()
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
	ICompoundProperty ()
	ICompoundProperty (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument())
	ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
	ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
	ICompoundProperty (const IObject &iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
	ICompoundProperty (const IObject &iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
	~ICompoundProperty ()
size_t	getNumProperties () const
	Returns the number of properties contained in this ICompoundProperty.
const AbcA::PropertyHeader &	getPropertyHeader (size_t i) const
const AbcA::PropertyHeader *	getPropertyHeader (const std::string &iName) const
ICompoundProperty	getParent () const
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
const AbcA::PropertyHeader &	getHeader () const
const std::string &	getName () const
AbcA::PropertyType	getPropertyType () const
bool	isScalar () const
bool	isArray () const
bool	isCompound () const
bool	isSimple () const
const AbcA::MetaData &	getMetaData () const
const AbcA::DataType &	getDataType () 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
ErrorHandler &	getErrorHandler () 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 ()
Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
	Base ()
	Base (ErrorHandler::Policy iPolicy)
	Base (const Base &iCopy)
Base &	operator= (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)
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

◆ this_type

typedef IPointsSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::this_type

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

◆ IPointsSchema() [1/4]

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

inline

The default constructor creates an empty OPointsSchema ...

Definition at line 106 of file IPoints.h.

Referenced by IPointsSchema().

Here is the caller graph for this function:

◆ IPointsSchema() [2/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema	(	const ICompoundProperty &	iParent,
		const std::string &	iName,
		const Abc::Argument &	iArg0 = Abc::Argument(),
		const Abc::Argument &	iArg1 = Abc::Argument() )

inline

This constructor creates a new points reader. The first argument is the parent ICompoundProperty, from which the error handler policy for is derived. The second argument is the name of the ICompoundProperty that contains this schemas properties. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 114 of file IPoints.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::IGeomBaseSchema(), and init().

Here is the call graph for this function:

◆ IPointsSchema() [3/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema	(	const ICompoundProperty	iProp,
		const Abc::Argument &	iArg0 = Abc::Argument(),
		const Abc::Argument &	iArg1 = Abc::Argument() )

inline

This constructor wraps an existing ICompoundProperty as the points reader, and the error handler policy is derived from it. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 128 of file IPoints.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::IGeomBaseSchema(), and init().

Here is the call graph for this function:

◆ IPointsSchema() [4/4]

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

inline

Copy constructor.

Definition at line 137 of file IPoints.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::IGeomBaseSchema(), and IPointsSchema().

Here is the call graph for this function:

Member Function Documentation

◆ ALEMBIC_OVERRIDE_OPERATOR_BOOL()

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

unspecified-bool-type operator overload. ...

References valid().

Here is the call graph for this function:

◆ get()

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

inline

Definition at line 173 of file IPoints.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_ids, m_idsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_positions, m_positionsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_selfBounds, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::m_selfBoundsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_velocities, and m_velocitiesProperty.

Referenced by getValue().

Here is the caller graph for this function:

◆ getIdsProperty()

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

inline

Definition at line 208 of file IPoints.h.

References m_idsProperty.

◆ getNumSamples()

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 153 of file IPoints.h.

References m_idsProperty, and m_positionsProperty.