HDK
|
#include <systemSchema.h>
Public Member Functions | |
HdSystemSchema (HdContainerDataSourceHandle container) | |
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 HdDataSourceBaseHandle | GetFromPath (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, TfToken const &key, SdfPath *foundAtPath) |
static HD_API HdContainerDataSourceHandle | Compose (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath) |
static HD_API HdContainerDataSourceHandle | ComposeAsPrimDataSource (HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath) |
static HD_API HdSystemSchema | GetFromParent (const HdContainerDataSourceHandle &fromParentContainer) |
static HD_API const TfToken & | GetSchemaToken () |
static HD_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 HdSystemSchema specifies a container that will hold "system" data. Each piece of system data is identified by a key within the container. A piece of system data is evaluated at a given location by walking up the namespace looking for a system container that contains the corresponding key.
Definition at line 59 of file systemSchema.h.
|
inline |
Definition at line 62 of file systemSchema.h.
|
static |
Composes the system container in at fromPath
by walking up the prim.dataSources in inputScene
and composing any system containers it encounters.
If no system containers were found, this returns null. Otherwise, this will return a container data source with the composed system data sources. If non-null, foundAtPath
will be the last prim at which system data was found.
|
static |
Similar to Compose
but this return value would be suitable for using with HdOverlayContainerDataSource for a prim's dataSource: ``` prim.dataSource = HdOverlayContainerDataSource::New( HdSystemSchema::ComposeAsPrimDataSource(...), prim.dataSource); ```
|
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 "system" from the parent container and constructs a HdSystemSchema 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 key
at fromPath
. If key
is 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
.
Returns a token where the container representing this schema is found in a container by default.