|
HDK
|
#include <purposeSchema.h>
Inheritance diagram for HdPurposeSchema:Classes | |
| class | Builder |
Public Member Functions | |
| HD_API TfToken | ResolvePurposeValue () |
Member accessor | |
| HD_API HdTokenDataSourceHandle | GetPurpose () const |
| HD_API HdBoolDataSourceHandle | GetInheritable () const |
| HD_API HdTokenDataSourceHandle | GetFallback () 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 () |
Schema construction | |
| static HD_API HdContainerDataSourceHandle | BuildRetained (const HdTokenDataSourceHandle &purpose, const HdBoolDataSourceHandle &inheritable, const HdTokenDataSourceHandle &fallback) |
Schema retrieval | |
| HdPurposeSchema (HdContainerDataSourceHandle container) | |
| static HD_API HdPurposeSchema | 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 |
Definition at line 48 of file purposeSchema.h.
|
inline |
Retrieves a container data source with the schema's default name token "purpose" from the parent container and constructs a HdPurposeSchema 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 54 of file purposeSchema.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.
| HD_API HdTokenDataSourceHandle HdPurposeSchema::GetFallback | ( | ) | const |
The "purpose" concept in Hydra is modelled after the UsdGeomImageable concept, which allows prim types to define a purpose fallback value to be used when no purpose value is found on a prim or its ancestors. The Hydra schema transports this fallback, if present, to apply it during flattening.
|
static |
Retrieves a container data source with the schema's default name token "purpose" from the parent container and constructs a HdPurposeSchema 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 HdBoolDataSourceHandle HdPurposeSchema::GetInheritable | ( | ) | const |
The "inheritable" flag indicates if this purpose schema should be inherited by the HdFlattenedPurposeDataSourceProvider.
| HD_API HdTokenDataSourceHandle HdPurposeSchema::GetPurpose | ( | ) | const |
The "inheritable" flag indicates if this purpose schema should be inherited by the HdFlattenedPurposeDataSourceProvider.
Returns a token where the container representing this schema is found in a container by default.
Resolve purpose to a TfToken value. This applies the fallback value as needed, and ultimately uses "geometry" if no other value is provided.
1.8.6 
