HdInstanceProxySchema Class Reference

A schema for marking a prim as an instance proxy. More...

#include <instanceProxySchema.h>

Inheritance diagram for HdInstanceProxySchema:

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 HdPathDataSourceHandle	GetPrototypePath () const
	The path to the propagated prototype prim that this instance proxy prim represents.
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 HdPathDataSourceHandle &prototypePath)

Schema retrieval
	HdInstanceProxySchema (HdContainerDataSourceHandle container)
static HD_API HdInstanceProxySchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "instanceProxy" from the parent container and constructs a HdInstanceProxySchema 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

A schema for marking a prim as an instance proxy.

An instance proxy prim represents a descendant prim beneath an instance prim, even though no such prim actually exists in the scene. This schema is in service of HdInstanceProxyViewSceneIndex that provides a topological view of the scene as though instancing were not being used. This is useful for path expression-based collection membership evaluation, and for UI tools like the Hydra Scene Debugger.

Definition at line 55 of file instanceProxySchema.h.

Constructor & Destructor Documentation

HdInstanceProxySchema()

HdInstanceProxySchema ( HdContainerDataSourceHandle container )

inline

Definition at line 61 of file instanceProxySchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdPathDataSourceHandle & prototypePath )

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

static

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

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

GetPrototypePath()

HD_API HdPathDataSourceHandle GetPrototypePath

(

)

const

The path to the propagated prototype prim that this instance proxy prim represents.

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/instanceProxySchema.h