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

#include <xformable.h>

Public Member Functions
USDGEOM_API	XformQuery (const UsdGeomXformable &xformable)
	Constructs an XformQuery object for the given xformable prim.

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
	Returns whether the xformable resets its parent's transformation.

USDGEOM_API bool	TransformMightBeTimeVarying () const
	Returns whether the xform value might change over time.

USDGEOM_API bool	TransformMightHaveEffect () const
	Returns true if the xform ops might have an effect.

USDGEOM_API bool	HasNonEmptyXformOpOrder () const
	Returns whether xformOpOrder is non-empty.

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.

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.

USDGEOM_API bool	IsAttributeIncludedInLocalTransform (const TfToken &attrName) const
	Returns whether the given attribute affects the local transformation computed for this query.

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 368 of file xformable.h.

Constructor & Destructor Documentation

◆ XformQuery() [1/2]

XformQuery ( )

inline

Definition at line 370 of file xformable.h.

◆ XformQuery() [2/2]

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

◆ GetLocalTransformation()

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.

◆ GetResetXformStack()

bool GetResetXformStack ( ) const

inline

Returns whether the xformable resets its parent's transformation.

Definition at line 387 of file xformable.h.

◆ GetTimeSamples()

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

◆ GetTimeSamplesInInterval()

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

◆ HasNonEmptyXformOpOrder()

USDGEOM_API bool HasNonEmptyXformOpOrder ( ) const

Returns whether xformOpOrder is non-empty.

◆ IsAttributeIncludedInLocalTransform()

USDGEOM_API bool IsAttributeIncludedInLocalTransform ( const TfToken & attrName ) const

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

◆ TransformMightBeTimeVarying()

USDGEOM_API bool TransformMightBeTimeVarying ( ) const

Returns whether the xform value might change over time.

◆ TransformMightHaveEffect()

USDGEOM_API bool TransformMightHaveEffect ( ) const

Returns true if the xform ops might have an effect.

If the xform op list is empty, or holds an operation followed by its inverse, such as [ "xformOp:translate:pivot", "!invert!:xformOp:translate:pivot"] then this returns false; otherwise it returns true. Note that this only recognizes certain forms; it does not analyze the matrix representation. It should be considered an advisory optimization.

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

pxr/usd/usdGeom/xformable.h

Public Member Functions