UsdVolFieldAsset Class Reference

#include <fieldAsset.h>

Inheritance diagram for UsdVolFieldAsset:

Public Member Functions
	UsdVolFieldAsset (const UsdPrim &prim=UsdPrim())
	UsdVolFieldAsset (const UsdSchemaBase &schemaObj)
virtual USDVOL_API	~UsdVolFieldAsset ()
	Destructor. More...
USDVOL_API UsdAttribute	GetFilePathAttr () const
USDVOL_API UsdAttribute	CreateFilePathAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Public Member Functions inherited from UsdVolFieldBase
	UsdVolFieldBase (const UsdPrim &prim=UsdPrim())
	UsdVolFieldBase (const UsdSchemaBase &schemaObj)
virtual USDVOL_API	~UsdVolFieldBase ()
	Destructor. More...
Public Member Functions inherited from UsdGeomBoundable
	UsdGeomBoundable (const UsdPrim &prim=UsdPrim())
	UsdGeomBoundable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomBoundable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetExtentAttr () const
USDGEOM_API UsdAttribute	CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Public Member Functions inherited from UsdGeomXformable
	UsdGeomXformable (const UsdPrim &prim=UsdPrim())
	UsdGeomXformable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomXformable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetXformOpOrderAttr () const
USDGEOM_API UsdAttribute	CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdGeomXformOp	AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API bool	SetResetXformStack (bool resetXform) const
USDGEOM_API bool	GetResetXformStack () const
USDGEOM_API bool	SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
USDGEOM_API std::vector < UsdGeomXformOp >	GetOrderedXformOps (bool *resetsXformStack) const
USDGEOM_API bool	ClearXformOpOrder () const
	Clears the local transform stack. More...
USDGEOM_API UsdGeomXformOp	MakeMatrixXform () const
USDGEOM_API bool	TransformMightBeTimeVarying () const
USDGEOM_API bool	TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
USDGEOM_API bool	GetTimeSamples (std::vector< double > *times) const
USDGEOM_API bool	GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
Public Member Functions inherited from UsdGeomImageable
	UsdGeomImageable (const UsdPrim &prim=UsdPrim())
	UsdGeomImageable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomImageable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetVisibilityAttr () const
USDGEOM_API UsdAttribute	CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetPurposeAttr () const
USDGEOM_API UsdAttribute	CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdRelationship	GetProxyPrimRel () const
USDGEOM_API UsdRelationship	CreateProxyPrimRel () const
USDGEOM_API void	MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API void	MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API TfToken	ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
USDGEOM_API TfToken	ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const
USDGEOM_API PurposeInfo	ComputePurposeInfo () const
USDGEOM_API PurposeInfo	ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
USDGEOM_API TfToken	ComputePurpose () const
USDGEOM_API UsdPrim	ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
USDGEOM_API bool	SetProxyPrim (const UsdPrim &proxy) const
USDGEOM_API bool	SetProxyPrim (const UsdSchemaBase &proxy) const
USDGEOM_API GfBBox3d	ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfMatrix4d	ComputeLocalToWorldTransform (UsdTimeCode const &time) const
USDGEOM_API GfMatrix4d	ComputeParentToWorldTransform (UsdTimeCode const &time) const
USDGEOM_API UsdGeomPrimvar	CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const
USDGEOM_API UsdGeomPrimvar	GetPrimvar (const TfToken &name) const
USDGEOM_API std::vector < UsdGeomPrimvar >	GetPrimvars () const
USDGEOM_API std::vector < UsdGeomPrimvar >	GetAuthoredPrimvars () const
USDGEOM_API bool	HasPrimvar (const TfToken &name) const
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdTyped ()
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaType	GetSchemaType () const
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDVOL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDVOL_API UsdVolFieldAsset	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdVolFieldBase
static USDVOL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDVOL_API UsdVolFieldBase	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 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 UsdSchemaType	schemaType = UsdSchemaType::AbstractTyped
Static Public Attributes inherited from UsdVolFieldBase
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractTyped
Static Public Attributes inherited from UsdGeomBoundable
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractTyped
Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractTyped
Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractTyped
Static Public Attributes inherited from UsdTyped
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType	schemaType = UsdSchemaType::AbstractBase

Protected Member Functions
USDVOL_API UsdSchemaType	_GetSchemaType () const override
Protected Member Functions inherited from UsdVolFieldBase
USDVOL_API UsdSchemaType	_GetSchemaType () const override
Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
Protected Member Functions inherited from UsdSchemaBase
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

Detailed Description

Base class for field primitives defined by an external file.

Definition at line 57 of file fieldAsset.h.

Constructor & Destructor Documentation

UsdVolFieldAsset::UsdVolFieldAsset ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file fieldAsset.h.

UsdVolFieldAsset::UsdVolFieldAsset ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a UsdVolFieldAsset on the prim held by schemaObj . Should be preferred over UsdVolFieldAsset(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file fieldAsset.h.

virtual USDVOL_API UsdVolFieldAsset::~UsdVolFieldAsset ( )

virtual

Destructor.

Member Function Documentation

USDVOL_API UsdSchemaType UsdVolFieldAsset::_GetSchemaType ( ) const

overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also

UsdSchemaType

Reimplemented from UsdGeomBoundable.

Reimplemented in UsdVolOpenVDBAsset.

USDVOL_API UsdAttribute UsdVolFieldAsset::CreateFilePathAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetFilePathAttr(), and also Usd_Create_Or_Get_Property 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.

static USDVOL_API UsdVolFieldAsset UsdVolFieldAsset::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a UsdVolFieldAsset 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:

UsdVolFieldAsset(stage->GetPrimAtPath(path));

USDVOL_API UsdAttribute UsdVolFieldAsset::GetFilePathAttr

(

)

const

An asset path attribute that points to a file on disk. For each supported file format, a separate FieldAsset subclass is required. Any further information required to extract the field from the file (such as a name or index to choose a single field from a file that can store multiple fields) will be defined on the FieldAsset subclass.

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

static USDVOL_API const TfTokenVector& UsdVolFieldAsset::GetSchemaAttributeNames ( bool  includeInherited = true )

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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 116 of file fieldAsset.h.

Member Data Documentation

const UsdSchemaType UsdVolFieldAsset::schemaType = UsdSchemaType::AbstractTyped

static

Compile time constant representing what kind of schema this class is.

See Also

UsdSchemaType

Definition at line 63 of file fieldAsset.h.

---

The documentation for this class was generated from the following file:

• pxr/usd/usdVol/fieldAsset.h