HdDisplayFilterSchema Class Reference

#include <displayFilterSchema.h>

Inheritance diagram for HdDisplayFilterSchema:

Classes
class	Builder

Public Member Functions
	HdDisplayFilterSchema (HdContainerDataSourceHandle container)
HD_API HdMaterialNodeSchema	GetResource ()
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer ()
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdContainerDataSourceHandle &resource)
static HD_API HdDisplayFilterSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetResourceLocator ()

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)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 52 of file displayFilterSchema.h.

Constructor & Destructor Documentation

HdDisplayFilterSchema::HdDisplayFilterSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 55 of file displayFilterSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdDisplayFilterSchema::BuildRetained ( const HdContainerDataSourceHandle &  resource )

static

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

static

Retrieves a container data source with the schema's default name token "displayFilter" from the parent container and constructs a HdDisplayFilterSchema 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 HdMaterialNodeSchema HdDisplayFilterSchema::GetResource

(

)

static HD_API const HdDataSourceLocator& HdDisplayFilterSchema::GetResourceLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the resource data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

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