HdPrimIdSchema Class Reference

Unique id assigned to all imageable prims. More...

#include <primIdSchema.h>

Inheritance diagram for HdPrimIdSchema:

Classes
class	Builder
	Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More...

Public Member Functions
Member accessor
HD_API HdPrimIdDataSourceHandle	GetPrimId () 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.
HD_API bool	IsDefined () const
	operator bool () const
	Returns true if this schema is applied on top of a non-null container.

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdPrimIdDataSourceHandle &primId)

Schema retrieval
	HdPrimIdSchema (HdContainerDataSourceHandle container)
static HD_API HdPrimIdSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "primId" from the parent container and constructs a HdPrimIdSchema instance.

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Unique id assigned to all imageable prims.

Inverse map is in SceneGlobals. For example, these can be assigned by the HdsiPrimIdSceneIndex and used for an Id buffer for picking.

Definition at line 53 of file primIdSchema.h.

Constructor & Destructor Documentation

HdPrimIdSchema()

HdPrimIdSchema ( HdContainerDataSourceHandle container )

inline

Definition at line 59 of file primIdSchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdPrimIdDataSourceHandle & primId )

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.

GetDefaultLocator()

static HD_API const HdDataSourceLocator & GetDefaultLocator ( )

static

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

GetFromParent()

static HD_API HdPrimIdSchema GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

Retrieves a container data source with the schema's default name token "primId" from the parent container and constructs a HdPrimIdSchema instance.

Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

GetSchemaToken()

static HD_API const TfToken & 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/primIdSchema.h