HdInstancedBySchema Class Reference

#include <instancedBySchema.h>

Inheritance diagram for HdInstancedBySchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdPathArrayDataSourceHandle	GetPaths () const
HD_API HdPathArrayDataSourceHandle	GetPrototypeRoots () 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 ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static HD_API const HdDataSourceLocator &	GetPathsLocator ()
	Prim-level relative data source locator to locate paths. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdPathArrayDataSourceHandle &paths, const HdPathArrayDataSourceHandle &prototypeRoots)

Schema retrieval
	HdInstancedBySchema (HdContainerDataSourceHandle container)
static HD_API HdInstancedBySchema	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 65 of file instancedBySchema.h.

Constructor & Destructor Documentation

HdInstancedBySchema::HdInstancedBySchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "instancedBy" from the parent container and constructs a HdInstancedBySchema 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 71 of file instancedBySchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdInstancedBySchema::BuildRetained ( const HdPathArrayDataSourceHandle &  paths, const HdPathArrayDataSourceHandle &  prototypeRoots  )

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& HdInstancedBySchema::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 HdInstancedBySchema HdInstancedBySchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "instancedBy" from the parent container and constructs a HdInstancedBySchema 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 HdPathArrayDataSourceHandle HdInstancedBySchema::GetPaths

(

)

const

static HD_API const HdDataSourceLocator& HdInstancedBySchema::GetPathsLocator ( )

static

Prim-level relative data source locator to locate paths.

HD_API HdPathArrayDataSourceHandle HdInstancedBySchema::GetPrototypeRoots

(

)

const

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