All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdGeomXformable::XformQuery Class Reference

Helper class that caches the ordered vector of UsGeomXformOps that contribute to the local transformation of an xformable prim. More...

Public Member Functions

USDGEOM_API XformQuery (const UsdGeomXformable &xformable)
 Constructs an XformQuery object for the given xformable prim. More...
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, const UsdTimeCode time) const
 Utilizes the internally cached UsdAttributeQuery's to efficiently compute the transform value at the given time. More...
 
bool GetResetXformStack () const
 Returns whether the xformable resets its parent's transformation. More...
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 Returns whether the xform value might change over time. More...
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 Sets the vector of times at which xformOp samples have been authored in the cached set of xform ops. More...
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 Sets the vector of times in the interval at which xformOp samples have been authored in the cached set of xform ops. More...
 
USDGEOM_API bool IsAttributeIncludedInLocalTransform (const TfToken &attrName) const
 Returns whether the given attribute affects the local transformation computed for this query. More...
 

Detailed Description

Helper class that caches the ordered vector of UsGeomXformOps that contribute to the local transformation of an xformable prim.

Internally, the class initializes UsdAttributeQuery objects for the xformOp attributes in order to facilitate efficient querying of their values.

Note
This object does not listen to change notification. If a consumer is holding onto a UsdGeomXformable::XformQuery object, it is their responsibility to dispose of it, in response to a resync change to the associated xformOp attributes. The class provides the convenience method IncludesXformOpAttr for this purpose.

Definition at line 377 of file xformable.h.

Constructor & Destructor Documentation

USDGEOM_API XformQuery ( const UsdGeomXformable xformable)

Constructs an XformQuery object for the given xformable prim.

Caches the ordered xformOps and initializes an UsdAttributeQuery internally for all the associated attributes.

Member Function Documentation

USDGEOM_API bool GetLocalTransformation ( GfMatrix4d transform,
const UsdTimeCode  time 
) const

Utilizes the internally cached UsdAttributeQuery's to efficiently compute the transform value at the given time.

bool GetResetXformStack ( ) const
inline

Returns whether the xformable resets its parent's transformation.

Definition at line 396 of file xformable.h.

USDGEOM_API bool GetTimeSamples ( std::vector< double > *  times) const

Sets the vector of times at which xformOp samples have been authored in the cached set of xform ops.

See Also
UsdXformable::GetTimeSamples
USDGEOM_API bool GetTimeSamplesInInterval ( const GfInterval interval,
std::vector< double > *  times 
) const

Sets the vector of times in the interval at which xformOp samples have been authored in the cached set of xform ops.

See Also
UsdXformable::GetTimeSamples
USDGEOM_API bool IsAttributeIncludedInLocalTransform ( const TfToken attrName) const

Returns whether the given attribute affects the local transformation computed for this query.

USDGEOM_API bool TransformMightBeTimeVarying ( ) const

Returns whether the xform value might change over time.


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