UsdVolFieldAsset#

Fully qualified name: usdrt::UsdVolFieldAsset

class UsdVolFieldAsset : public usdrt::UsdVolFieldBase #

Base class for field primitives defined by an external file. For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdVolTokens. So to set an attribute to the value “rightHanded”, use UsdVolTokens->rightHanded as the value.

Subclassed by usdrt::UsdVolField3DAsset, usdrt::UsdVolOpenVDBAsset

Public Functions

inline explicit UsdVolFieldAsset(const UsdPrim &prim = UsdPrim())#: Construct a UsdVolFieldAsset on UsdPrim prim. Equivalent to UsdVolFieldAsset::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdVolFieldAsset(const UsdSchemaBase &schemaObj)#: Construct a UsdVolFieldAsset on the prim held by schemaObj . Should be preferred over UsdVolFieldAsset(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdVolFieldAsset()#: Destructor.

inline UsdAttribute GetFilePathAttr() const#

An asset path attribute that points to a file on disk. For each supported file format, a separate FieldAsset subclass is required.

This attribute’s value can be animated over time, as most volume asset formats represent just a single timeSample of a volume. However, it does not, at this time, support any pattern substitutions like “$F”.


Declaration	`asset filePath`
C++ Type	SdfAssetPath
Usd Type	SdfValueTypeNames->Asset

inline UsdAttribute CreateFilePathAttr() const#: See GetFilePathAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFieldNameAttr() const#

Name of an individual field within the file specified by the filePath attribute.


Declaration	`token fieldName`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

inline UsdAttribute CreateFieldNameAttr() const#: See GetFieldNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFieldIndexAttr() const#

A file can contain multiple fields with the same name. This optional attribute is an index used to disambiguate between these multiple fields with the same name.


Declaration	`int fieldIndex`
C++ Type	int
Usd Type	SdfValueTypeNames->Int

inline UsdAttribute CreateFieldIndexAttr() const#: See GetFieldIndexAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFieldDataTypeAttr() const#

Token which is used to indicate the data type of an individual field. Authors use this to tell consumers more about the field without opening the file on disk. The list of allowed tokens is specified with the specific asset type. A missing value is considered an error.


Declaration	`token fieldDataType`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

inline UsdAttribute CreateFieldDataTypeAttr() const#: See GetFieldDataTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetVectorDataRoleHintAttr() const#

Optional token which is used to indicate the role of a vector valued field. This can drive the data type in which fields are made available in a renderer or whether the vector values are to be transformed.


Declaration	`token vectorDataRoleHint = "None"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	None, Point, Normal, Vector, Color

inline UsdAttribute CreateVectorDataRoleHintAttr() const#: See GetVectorDataRoleHintAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetXformOpOrderAttr() const#

Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage’s prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims.

You should rarely, if ever, need to manipulate this attribute directly. It is managed by the AddXformOp(), SetResetXformStack(), and SetXformOpOrder(), and consulted by GetOrderedXformOps() and GetLocalTransformation().


Declaration	`uniform token[] xformOpOrder`
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray
Variability	SdfVariabilityUniform

inline UsdAttribute CreateXformOpOrderAttr() const#: See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetVisibilityAttr() const#

Visibility is meant to be the simplest form of “pruning” visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.


Declaration	`token visibility = "inherited"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	inherited, invisible

inline UsdAttribute CreateVisibilityAttr() const#: See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPurposeAttr() const#

Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.

See UsdGeom_ImageablePurpose for more detail about how purpose is computed and used.


Declaration	`uniform token purpose = "default"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	default, render, proxy, guide

inline UsdAttribute CreatePurposeAttr() const#: See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdRelationship GetProxyPrimRel() const#

The proxyPrim relationship allows us to link a prim whose purpose is “render” to its (single target) purpose=”proxy” prim. This is entirely optional, but can be useful in several scenarios:

In a pipeline that does pruning (for complexity management) by deactivating prims composed from asset references, when we deactivate a purpose=”render” prim, we will be able to discover and additionally deactivate its associated purpose=”proxy” prim, so that preview renders reflect the pruning accurately.

DCC importers may be able to make more aggressive optimizations for interactive processing and display if they can discover the proxy for a given render prim.

With a little more work, a Hydra-based application will be able to map a picked proxy prim back to its render geometry for selection.

Note

It is only valid to author the proxyPrim relationship on prims whose purpose is “render”.

inline UsdRelationship CreateProxyPrimRel() const#: See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create.

UsdPrim GetPrim() const#: Return this schema object’s held prim.

SdfPath GetPath() const#: Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const#

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.