HdarSystemSchema Class Reference

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

#include <systemSchema.h>

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
Member accessor
HDAR_API HdResolverContextDataSourceHandle	GetResolverContext () 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.
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
static HDAR_API HdContainerDataSourceHandle	GetFromPath (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath)
	Evaluates the asset resolution "system" data source for fromPath.
Schema location
static HDAR_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
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.
Schema construction
static HDAR_API HdContainerDataSourceHandle	BuildRetained (const HdResolverContextDataSourceHandle &resolverContext)

Schema retrieval
	HdarSystemSchema (HdContainerDataSourceHandle container)
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.

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

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

Definition at line 52 of file systemSchema.h.

Constructor & Destructor Documentation

HdarSystemSchema()

HdarSystemSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 58 of file systemSchema.h.

Member Function Documentation

BuildRetained()

static HDAR_API HdContainerDataSourceHandle BuildRetained ( const HdResolverContextDataSourceHandle &  resolverContext )

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 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 HDAR_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.

GetSchemaToken()

static HDAR_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/hdar/systemSchema.h