This class maintains a set of prim paths to transform prims, and a cache of their matrix and visibility states. It also maintains a set of indices that describe the dirty states of those attributes that have been dirtied. If the number of transforms has changed, initTransforms should be called to initialise the internal memory storage. setDrivenPrimPaths should be called to specify the prim paths. Whenever you need to specify a change to the matrix or visibility values, call either dirtyVisibility or dirtyMatrix, and specify the index of the prim to modify. Within the compute method of the node, constructDrivenPrimsArray should be called to construct the array of prims to update, which can then be passed to the update method to set the dirty values on the prim attributes. More...

#include <DrivenTransforms.h>

Public Member Functions
	DrivenTransforms ()
	ctor

size_t	transformCount () const
	returns the number of transforms

AL_USDMAYA_PUBLIC void	resizeDrivenTransforms (const size_t primPathCount)
	resizes the driven transform internals to hold the specified number of prims More...

void	setDrivenPrimPaths (const SdfPathVector &primPaths)
	set the driven prim paths on the host driven transforms More...

AL_USDMAYA_PUBLIC bool	update (UsdStageRefPtr stage, const MTime &currentTime)
	update the driven transforms More...

void	dirtyVisibility (const int32_t primIndex, bool newValue)
	dirties the visibility for the specified prim index More...

void	dirtyMatrix (const int32_t primIndex, const MMatrix &newValue)
	dirties the matrix for the specified prim index More...

const SdfPathVector &	drivenPrimPaths () const
	returns the paths of the driven transforms More...

const std::vector< int32_t > &	dirtyMatrices () const
	returns the matrices that have been dirtied More...

const std::vector< int32_t > &	dirtyVisibilities () const
	returns the visibilities that have been dirtied More...

const std::vector< MMatrix > &	drivenMatrices () const
	returns the visibilities that have been dirtied More...

const std::vector< bool > &	drivenVisibilities () const
	returns the visibilities that have been dirtied More...

Detailed Description

This class maintains a set of prim paths to transform prims, and a cache of their matrix and visibility states. It also maintains a set of indices that describe the dirty states of those attributes that have been dirtied. If the number of transforms has changed, initTransforms should be called to initialise the internal memory storage. setDrivenPrimPaths should be called to specify the prim paths. Whenever you need to specify a change to the matrix or visibility values, call either dirtyVisibility or dirtyMatrix, and specify the index of the prim to modify. Within the compute method of the node, constructDrivenPrimsArray should be called to construct the array of prims to update, which can then be passed to the update method to set the dirty values on the prim attributes.

Member Function Documentation

const std::vector<int32_t>& AL::usdmaya::nodes::proxy::DrivenTransforms::dirtyMatrices ( ) const

inline

returns the matrices that have been dirtied

Returns: returns the indices of the prims that have dirtied matrix params

void AL::usdmaya::nodes::proxy::DrivenTransforms::dirtyMatrix	(	const int32_t	primIndex,
		const MMatrix &	newValue
	)

inline

dirties the matrix for the specified prim index

Parameters

primIndex	the index of the prim
newValue	the new matrix value

const std::vector<int32_t>& AL::usdmaya::nodes::proxy::DrivenTransforms::dirtyVisibilities ( ) const

inline

returns the visibilities that have been dirtied

Returns: returns the indices of the prims that have dirtied visibility params

void AL::usdmaya::nodes::proxy::DrivenTransforms::dirtyVisibility	(	const int32_t	primIndex,
		bool	newValue
	)

inline

dirties the visibility for the specified prim index

Parameters

primIndex	the index of the prim
newValue	the new visibility value

const std::vector<MMatrix>& AL::usdmaya::nodes::proxy::DrivenTransforms::drivenMatrices ( ) const

inline

returns the visibilities that have been dirtied

Returns: returns the current matrix values of the driven transforms

const SdfPathVector& AL::usdmaya::nodes::proxy::DrivenTransforms::drivenPrimPaths ( ) const

inline

returns the paths of the driven transforms

Returns: the driven transforms

const std::vector<bool>& AL::usdmaya::nodes::proxy::DrivenTransforms::drivenVisibilities ( ) const

inline

returns the visibilities that have been dirtied

Returns: returns the current visibility statuses of the driven transforms

AL_USDMAYA_PUBLIC void AL::usdmaya::nodes::proxy::DrivenTransforms::resizeDrivenTransforms ( const size_t primPathCount )

resizes the driven transform internals to hold the specified number of prims

Parameters

primPathCount the number of transforms to be driven

void AL::usdmaya::nodes::proxy::DrivenTransforms::setDrivenPrimPaths ( const SdfPathVector & primPaths )

inline

set the driven prim paths on the host driven transforms

Parameters

primPaths the prim paths to set on the proxy

AL_USDMAYA_PUBLIC bool AL::usdmaya::nodes::proxy::DrivenTransforms::update	(	UsdStageRefPtr	stage,
		const MTime &	currentTime
	)

update the driven transforms

Parameters

stage	the stage to extract the prims from
currentTime	the current time

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

src/lib/AL_USDMaya/AL/usdmaya/nodes/proxy/DrivenTransforms.h

Public Member Functions

Detailed Description

Member Function Documentation