HdInstanceSchema Class Reference

#include <instanceSchema.h>

Inheritance diagram for HdInstanceSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdPathDataSourceHandle	GetInstancer () const
HD_API HdIntDataSourceHandle	GetPrototypeIndex () const
HD_API HdIntDataSourceHandle	GetInstanceIndex () const
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdPathDataSourceHandle &instancer, const HdIntDataSourceHandle &prototypeIndex, const HdIntDataSourceHandle &instanceIndex)

Schema retrieval
	HdInstanceSchema (HdContainerDataSourceHandle container)
static HD_API HdInstanceSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 56 of file instanceSchema.h.

Constructor & Destructor Documentation

HdInstanceSchema::HdInstanceSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "instance" from the parent container and constructs a HdInstanceSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 62 of file instanceSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdInstanceSchema::BuildRetained ( const HdPathDataSourceHandle &  instancer, const HdIntDataSourceHandle &  prototypeIndex, const HdIntDataSourceHandle &  instanceIndex  )

static

Deprecated:

Use Builder instead.

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

static HD_API const HdDataSourceLocator& HdInstanceSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static HD_API HdInstanceSchema HdInstanceSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "instance" from the parent container and constructs a HdInstanceSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API HdIntDataSourceHandle HdInstanceSchema::GetInstanceIndex

(

)

const

Index into int array within the vector data source at instancer's instancerTopology's instanceIndices to find entry corresponding to this instance.

HD_API HdPathDataSourceHandle HdInstanceSchema::GetInstancer

(

)

const

Path to instancer for which a (sub-)entry was added to its instancerTopology's instanceIndices during instance aggregation to account for this instance. Note that instanceIndices is nested, that is a vector data source containing integer arrays, one for each prototype the instancer is instancing. Thus, we need two indices to identify the entry: prototypeIndex is the outer index and instanceIndex the inner index.

HD_API HdIntDataSourceHandle HdInstanceSchema::GetPrototypeIndex

(

)

const

Index into vector data source at instancer's instancerTopology's instanceIndices to find entry corresponding to this instance.

static HD_API const TfToken& HdInstanceSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

---

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

• pxr/imaging/hd/instanceSchema.h