HdarSystemSchema Class Reference

The HdarSystemSchema specifies a container that will hold "system" data that is relevant to asset resolution. More...

Inheritance diagram for HdarSystemSchema:

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
	HdarSystemSchema (HdContainerDataSourceHandle container)
HDAR_API HdResolverContextDataSourceHandle	GetResolverContext ()
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
	Returns true if this schema is applied on top of a non-null container. More...

Static Public Member Functions
static HDAR_API HdContainerDataSourceHandle	BuildRetained (const HdResolverContextDataSourceHandle &resolverContext)
	Builds a container data source which includes the provided child data sources. More...
static HD_API HdContainerDataSourceHandle	GetFromPath (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath)
	Evaluates the asset resolution "system" data source for fromPath. More...
static HDAR_API HdarSystemSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "assetResolution" from the parent container and constructs a HdarSystemSchema instance. More...
static HDAR_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default. More...

Additional Inherited Members
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name)
	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. More...
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The HdarSystemSchema specifies a container that will hold "system" data that is relevant to asset resolution.

Definition at line 54 of file systemSchema.h.

Member Function Documentation

BuildRetained()

static HDAR_API HdContainerDataSourceHandle BuildRetained ( const HdResolverContextDataSourceHandle &  resolverContext )

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.

GetDefaultLocator()

static HDAR_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 HDAR_API HdarSystemSchema GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

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

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

GetFromPath()

static HD_API HdContainerDataSourceHandle GetFromPath ( HdSceneIndexBaseRefPtr const &  inputScene, SdfPath const &  fromPath, SdfPath *  foundAtPath  )

static

Evaluates the asset resolution "system" data source for fromPath.

If found, the return value will be non-null and foundAtPath will contain the path at which the non-null result was found. Otherwise, this returns null.

This operation will be linear in the length of fromPath.

---

The documentation for this class was generated from the following file:

• pxr/imaging/hdar/systemSchema.h