|
HDK
|
#include <volume.h>
Inheritance diagram for UsdVolVolume:Static Public Member Functions | |
| static USDVOL_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDVOL_API UsdVolVolume | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDVOL_API UsdVolVolume | Define (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdGeomGprim | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomGprim | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdGeomBoundable | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomBoundable | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent) |
| static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent) |
| Static Public Member Functions inherited from UsdGeomXformable | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomXformable | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API bool | GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times) |
| static USDGEOM_API bool | GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times) |
| static USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time) |
| static USDGEOM_API bool | IsTransformationAffectedByAttrNamed (const TfToken &attrName) |
| Static Public Member Functions inherited from UsdGeomImageable | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
| Static Public Member Functions inherited from UsdTyped | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
| Static Public Attributes inherited from UsdGeomGprim | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomBoundable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomXformable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomImageable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdTyped | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
| USDVOL_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdTyped | |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| const TfType & | _GetType () const |
| USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
| class | UsdSchemaRegistry |
Field Attachment and Inspection | |
| typedef std::map< TfToken, SdfPath > | FieldMap |
| USDVOL_API FieldMap | GetFieldPaths () const |
| USDVOL_API bool | HasFieldRelationship (const TfToken &name) const |
| USDVOL_API SdfPath | GetFieldPath (const TfToken &name) const |
| USDVOL_API bool | CreateFieldRelationship (const TfToken &name, const SdfPath &fieldPath) const |
| USDVOL_API bool | BlockFieldRelationship (const TfToken &name) const |
A renderable volume primitive. A volume is made up of any number of FieldBase primitives bound together in this volume. Each FieldBase primitive is specified as a relationship with a namespace prefix of "field".
The relationship name is used by the renderer to associate individual fields with the named input parameters on the volume shader. Using this indirect approach to connecting fields to shader parameters (rather than using the field prim's name) allows a single field to be reused for different shader inputs, or to be used as different shader parameters when rendering different Volumes. This means that the name of the field prim is not relevant to its contribution to the volume prims which refer to it. Nor does the field prim's location in the scene graph have any relevance, and Volumes may refer to fields anywhere in the scene graph. However, unless Field prims need to be shared by multiple Volumes, a Volume's Field prims should be located under the Volume in namespace, for enhanced organization.
| typedef std::map<TfToken, SdfPath> UsdVolVolume::FieldMap |
Return a map of field relationship names to the fields themselves, represented as prim paths. This map provides all the information that should be needed to tie fields to shader parameters and render this volume.
The field relationship names that server as the map keys will have the field namespace stripped from them.
Construct a UsdVolVolume on UsdPrim prim . Equivalent to UsdVolVolume::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
|
inlineexplicit |
Construct a UsdVolVolume on the prim held by schemaObj . Should be preferred over UsdVolVolume(schemaObj.GetPrim()), as it preserves SchemaBase state.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdGeomGprim.
| USDVOL_API bool UsdVolVolume::BlockFieldRelationship | ( | const TfToken & | name | ) | const |
Blocks an existing field relationship on this volume, ensuring it will not be enumerated by GetFieldPaths().
Returns true if the relationship existed, false if it did not. In other words the return value indicates whether the volume prim was changed.
The name lookup automatically applies the field relationship namespacing, if it isn't specified in the name token.
| USDVOL_API bool UsdVolVolume::CreateFieldRelationship | ( | const TfToken & | name, |
| const SdfPath & | fieldPath | ||
| ) | const |
Creates a relationship on this volume that targets the specified field. If an existing relationship exists with the same name, it is replaced (since only one target is allowed for each named relationship).
Returns true if the relationship was successfully created and set - it is legal to call this method for a field relationship that already "exists", i.e. already posesses scene description, as this is the only method we provide for setting a field relatioonship's value, to help enforce that field relationships can have only a single (or no) target.
| fieldPath | - can be a prim path, or the path of another relationship, to effect Relationship Forwarding |
The name lookup automatically applies the field relationship namespacing, if it isn't specified in the name token.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a UsdVolVolume holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
| USDVOL_API SdfPath UsdVolVolume::GetFieldPath | ( | const TfToken & | name | ) | const |
Checks if there is an existing field relationship with a given name, and if so, returns the path to the Field prim it targets, or else the empty path.
The name lookup automatically applies the field relationship namespacing, if it isn't specified in the name token.
| USDVOL_API FieldMap UsdVolVolume::GetFieldPaths | ( | ) | const |
Return a map of field relationship names to the fields themselves, represented as prim paths. This map provides all the information that should be needed to tie fields to shader parameters and render this volume.
The field relationship names that server as the map keys will have the field namespace stripped from them.
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.
| USDVOL_API bool UsdVolVolume::HasFieldRelationship | ( | const TfToken & | name | ) | const |
Checks if there is an existing field relationship with a given name. This query will return true even for a field relationship that has been blocked and therefore will not contribute to the map returned by GetFieldRelationships()
The name lookup automatically applies the field relationship namespacing, if it isn't specified in the name token.
|
friend |
|
static |
Compile time constant representing what kind of schema this class is.
1.8.6 
