HdLegacyTaskSchema Class Reference

#include <legacyTaskSchema.h>

Inheritance diagram for HdLegacyTaskSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdLegacyTaskFactoryDataSourceHandle	GetFactory () const
HD_API HdSampledDataSourceHandle	GetParameters () const
HD_API HdRprimCollectionDataSourceHandle	GetCollection () const
HD_API HdTokenVectorDataSourceHandle	GetRenderTags () 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 &	GetFactoryLocator ()
	Prim-level relative data source locator to locate factory. More...
static HD_API const HdDataSourceLocator &	GetParametersLocator ()
	Prim-level relative data source locator to locate parameters. More...
static HD_API const HdDataSourceLocator &	GetCollectionLocator ()
	Prim-level relative data source locator to locate collection. More...
static HD_API const HdDataSourceLocator &	GetRenderTagsLocator ()
	Prim-level relative data source locator to locate renderTags. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdLegacyTaskFactoryDataSourceHandle &factory, const HdSampledDataSourceHandle &parameters, const HdRprimCollectionDataSourceHandle &collection, const HdTokenVectorDataSourceHandle &renderTags)

Schema retrieval
	HdLegacyTaskSchema (HdContainerDataSourceHandle container)
static HD_API HdLegacyTaskSchema	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 66 of file legacyTaskSchema.h.

Constructor & Destructor Documentation

HdLegacyTaskSchema::HdLegacyTaskSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "task" from the parent container and constructs a HdLegacyTaskSchema 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 72 of file legacyTaskSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdLegacyTaskSchema::BuildRetained ( const HdLegacyTaskFactoryDataSourceHandle &  factory, const HdSampledDataSourceHandle &  parameters, const HdRprimCollectionDataSourceHandle &  collection, const HdTokenVectorDataSourceHandle &  renderTags  )

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.

HD_API HdRprimCollectionDataSourceHandle HdLegacyTaskSchema::GetCollection

(

)

const

Parameters for task. Type depends on task type. E.g. HdxRenderTaskParams if the factory produces HdxRenderTask instances.

static HD_API const HdDataSourceLocator& HdLegacyTaskSchema::GetCollectionLocator ( )

static

Prim-level relative data source locator to locate collection.

static HD_API const HdDataSourceLocator& HdLegacyTaskSchema::GetDefaultLocator ( )

static

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

HD_API HdLegacyTaskFactoryDataSourceHandle HdLegacyTaskSchema::GetFactory

(

)

const

Parameters for task. Type depends on task type. E.g. HdxRenderTaskParams if the factory produces HdxRenderTask instances.

static HD_API const HdDataSourceLocator& HdLegacyTaskSchema::GetFactoryLocator ( )

static

Prim-level relative data source locator to locate factory.

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

static

Retrieves a container data source with the schema's default name token "task" from the parent container and constructs a HdLegacyTaskSchema 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 HdSampledDataSourceHandle HdLegacyTaskSchema::GetParameters

(

)

const

Parameters for task. Type depends on task type. E.g. HdxRenderTaskParams if the factory produces HdxRenderTask instances.

static HD_API const HdDataSourceLocator& HdLegacyTaskSchema::GetParametersLocator ( )

static

Prim-level relative data source locator to locate parameters.

HD_API HdTokenVectorDataSourceHandle HdLegacyTaskSchema::GetRenderTags

(

)

const

Parameters for task. Type depends on task type. E.g. HdxRenderTaskParams if the factory produces HdxRenderTask instances.

static HD_API const HdDataSourceLocator& HdLegacyTaskSchema::GetRenderTagsLocator ( )

static

Prim-level relative data source locator to locate renderTags.

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