HDK
|
#include <systemSchema.h>
Classes | |
class | Builder |
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 | |
Static Public Member Functions | |
static HDAR_API HdContainerDataSourceHandle | BuildRetained (const HdResolverContextDataSourceHandle &resolverContext) |
static HD_API HdContainerDataSourceHandle | GetFromPath (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath) |
static HDAR_API HdarSystemSchema | GetFromParent (const HdContainerDataSourceHandle &fromParentContainer) |
static HDAR_API const TfToken & | GetSchemaToken () |
static HDAR_API const HdDataSourceLocator & | GetDefaultLocator () |
Additional Inherited Members | |
Protected Member Functions inherited from HdSchema | |
template<typename T > | |
T::Handle | _GetTypedDataSource (TfToken name) |
Protected Attributes inherited from HdSchema | |
HdContainerDataSourceHandle | _container |
The HdarSystemSchema specifies a container that will hold "system" data that is relevant to asset resolution.
Definition at line 57 of file systemSchema.h.
|
inline |
Definition at line 60 of file systemSchema.h.
|
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 |
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
|
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.
|
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
.
HDAR_API HdResolverContextDataSourceHandle HdarSystemSchema::GetResolverContext | ( | ) |
Returns a token where the container representing this schema is found in a container by default.