AL_USDMaya  0.16.6
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
AL::maya::DgNodeHelper Struct Reference

Utility class that provides support for setting/getting attributes. More...

#include <DgNodeHelper.h>

Inheritance diagram for AL::maya::DgNodeHelper:
AL::usdmaya::fileio::translators::DgNodeTranslator AL::usdmaya::fileio::translators::DagNodeTranslator AL::usdmaya::fileio::translators::CameraTranslator AL::usdmaya::fileio::translators::MeshTranslator AL::usdmaya::fileio::translators::NurbsCurveTranslator AL::usdmaya::fileio::translators::TransformTranslator

Public Member Functions

 DgNodeHelper ()
 ctor
 
virtual ~DgNodeHelper ()
 dtor
 

Static Public Member Functions

Methods to get array data from array attributes
static MStatus getBoolArray (const MObject &node, const MObject &attr, std::vector< bool > &values)
 retrieve an array of boolean values from an attribute in Maya More...
 
static MStatus getBoolArray (MObject node, MObject attr, bool *values, const size_t count)
 retrieve an array of boolean values from an attribute in Maya More...
 
static MStatus getInt8Array (const MObject &node, const MObject &attr, std::vector< int8_t > &values)
 retrieve an array of 8 bit char values from an attribute in Maya More...
 
static MStatus getInt8Array (MObject node, MObject attr, int8_t *values, size_t count)
 retrieve an array of 8 bit integer values from an attribute in Maya More...
 
static MStatus getInt16Array (const MObject &node, const MObject &attr, std::vector< int16_t > &values)
 retrieve an array of 16bit integer values from an attribute in Maya More...
 
static MStatus getInt16Array (MObject node, MObject attr, int16_t *values, size_t count)
 retrieve an array of 16 bit integer values from an attribute in Maya More...
 
static MStatus getInt32Array (const MObject &node, const MObject &attr, std::vector< int32_t > &values)
 retrieve an array of 32bit integer values from an attribute in Maya More...
 
static MStatus getInt32Array (MObject node, MObject attr, int32_t *values, size_t count)
 retrieve an array of 32 bit integer values from an attribute in Maya More...
 
static MStatus getInt64Array (const MObject &node, const MObject &attr, std::vector< int64_t > &values)
 retrieve an array of 64bit integer values from an attribute in Maya More...
 
static MStatus getInt64Array (MObject node, MObject attr, int64_t *values, size_t count)
 retrieve an array of 64 bit integer values from an attribute in Maya More...
 
static MStatus getHalfArray (const MObject &node, const MObject &attr, std::vector< half > &values)
 retrieve an array of float values from an attribute in Maya (converted to halfs) More...
 
static MStatus getHalfArray (MObject node, MObject attr, half *values, size_t count)
 retrieve an array of half values from an attribute in Maya More...
 
static MStatus getFloatArray (const MObject &node, const MObject &attr, std::vector< float > &values)
 retrieve an array of float values from an attribute in Maya More...
 
static MStatus getFloatArray (MObject node, MObject attr, float *values, size_t count)
 retrieve an array of float values from an attribute in Maya More...
 
static MStatus getDoubleArray (const MObject &node, const MObject &attr, std::vector< double > &values)
 retrieve an array of double values from an attribute in Maya More...
 
static MStatus getDoubleArray (MObject node, MObject attr, double *values, size_t count)
 retrieve an array of double values from an attribute in Maya More...
 
static MStatus getVec2Array (MObject node, MObject attr, half *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2D half float array More...
 
static MStatus getVec2Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2D float array More...
 
static MStatus getVec2Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2D double array More...
 
static MStatus getVec2Array (MObject node, MObject attr, int32_t *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2D integer array More...
 
static MStatus getVec3Array (MObject node, MObject attr, half *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3D half float array More...
 
static MStatus getVec3Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3D float array More...
 
static MStatus getVec3Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3D double array More...
 
static MStatus getVec3Array (MObject node, MObject attr, int32_t *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3D integer array More...
 
static MStatus getVec4Array (MObject node, MObject attr, half *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D half float array More...
 
static MStatus getVec4Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D float array More...
 
static MStatus getVec4Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D double array More...
 
static MStatus getVec4Array (MObject node, MObject attr, int32_t *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D integer array More...
 
static MStatus getQuatArray (MObject node, MObject attr, half *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D half float array More...
 
static MStatus getQuatArray (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D float array More...
 
static MStatus getQuatArray (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4D double array More...
 
static MStatus getMatrix2x2Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2x2 floating point matrix array More...
 
static MStatus getMatrix2x2Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 2x2 double matrix array More...
 
static MStatus getMatrix3x3Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3x3 floating point matrix array More...
 
static MStatus getMatrix3x3Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 3x3 double matrix array More...
 
static MStatus getMatrix4x4Array (MObject node, MObject attr, float *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4x4 floating point matrix array More...
 
static MStatus getMatrix4x4Array (MObject node, MObject attr, double *values, size_t count)
 given MObjects for an attribute on a node, extract the data as a 4x4 double matrix array More...
 
static MStatus getTimeArray (MObject node, MObject attr, float *values, size_t count, MTime::Unit unit)
 given MObjects for an attribute on a node, extract the data as an array of time values scale to the specified unit. More...
 
static MStatus getAngleArray (MObject node, MObject attr, float *values, size_t count, MAngle::Unit unit)
 given MObjects for an attribute on a node, extract the data as an array of angle values scale to the specified unit. More...
 
static MStatus getDistanceArray (MObject node, MObject attr, float *values, size_t count, MDistance::Unit unit)
 given MObjects for an attribute on a node, extract the data as an array of distance values scale to the specified unit. More...
 
static MStatus getStringArray (MObject node, MObject attr, std::string *values, size_t count)
 given MObjects for an attribute on a node, extract the data as an array of string values More...
 
Methods to get single values from non array attributes
static MStatus getHalf (MObject node, MObject attr, half &value)
 extracts a single half float value from the specified node/attribute More...
 
static MStatus getFloat (MObject node, MObject attr, float &value)
 extracts a single float value from the specified node/attribute More...
 
static MStatus getDouble (MObject node, MObject attr, double &value)
 extracts a single double value from the specified node/attribute More...
 
static MStatus getTime (MObject node, MObject attr, MTime &value)
 extracts a single time value from the specified node/attribute More...
 
static MStatus getDistance (MObject node, MObject attr, MDistance &value)
 extracts a single distance value from the specified node/attribute More...
 
static MStatus getAngle (MObject node, MObject attr, MAngle &value)
 extracts a single angle value from the specified node/attribute More...
 
static MStatus getBool (MObject node, MObject attr, bool &value)
 extracts a single boolean value from the specified node/attribute More...
 
static MStatus getInt8 (MObject node, MObject attr, int8_t &value)
 extracts a single 8bit integer value from the specified node/attribute More...
 
static MStatus getInt16 (MObject node, MObject attr, int16_t &value)
 extracts a single 16 bit integer value from the specified node/attribute More...
 
static MStatus getInt32 (MObject node, MObject attr, int32_t &value)
 extracts a single 32bit integer value from the specified node/attribute More...
 
static MStatus getInt64 (MObject node, MObject attr, int64_t &value)
 extracts a single 64bit integer value from the specified node/attribute More...
 
static MStatus getMatrix2x2 (MObject node, MObject attr, float *values)
 extracts a 2x2 matrix value from the specified node/attribute (as a float) More...
 
static MStatus getMatrix3x3 (MObject node, MObject attr, float *values)
 extracts a 3x3 matrix value from the specified node/attribute (as a float) More...
 
static MStatus getMatrix4x4 (MObject node, MObject attr, float *values)
 extracts a 4x4 matrix value from the specified node/attribute (as a float) More...
 
static MStatus getMatrix4x4 (MObject node, MObject attr, MFloatMatrix &values)
 extracts a 4x4 matrix value from the specified node/attribute (as a float) More...
 
static MStatus getMatrix2x2 (MObject node, MObject attr, double *values)
 extracts a 2x2 matrix value from the specified node/attribute (as a double) More...
 
static MStatus getMatrix3x3 (MObject node, MObject attr, double *values)
 extracts a 3x3 matrix value from the specified node/attribute (as a double) More...
 
static MStatus getMatrix4x4 (MObject node, MObject attr, double *values)
 extracts a 4x4 matrix value from the specified node/attribute (as a double) More...
 
static MStatus getMatrix4x4 (MObject node, MObject attr, MMatrix &values)
 extracts a 4x4 matrix value from the specified node/attribute (as a double) More...
 
static MStatus getString (MObject node, MObject attr, std::string &str)
 extracts a string value from the specified node/attribute More...
 
static MStatus getVec2 (MObject node, MObject attr, int32_t *xy)
 extracts a 2D vector value from the specified node/attribute More...
 
static MStatus getVec2 (MObject node, MObject attr, float *xy)
 extracts a 2D vector value from the specified node/attribute More...
 
static MStatus getVec2 (MObject node, MObject attr, double *xy)
 extracts a 2D vector value from the specified node/attribute More...
 
static MStatus getVec2 (MObject node, MObject attr, half *xy)
 extracts a 2D vector value from the specified node/attribute More...
 
static MStatus getVec3 (MObject node, MObject attr, int32_t *xyz)
 extracts a 3D vector value from the specified node/attribute More...
 
static MStatus getVec3 (MObject node, MObject attr, float *xyz)
 extracts a 3D vector value from the specified node/attribute More...
 
static MStatus getVec3 (MObject node, MObject attr, double *xyz)
 extracts a 3D vector value from the specified node/attribute More...
 
static MStatus getVec3 (MObject node, MObject attr, half *xyz)
 extracts a 3D vector value from the specified node/attribute More...
 
static MStatus getVec4 (MObject node, MObject attr, int32_t *xyzw)
 extracts a 4D vector value from the specified node/attribute More...
 
static MStatus getVec4 (MObject node, MObject attr, float *xyzw)
 extracts a 4D vector value from the specified node/attribute More...
 
static MStatus getVec4 (MObject node, MObject attr, double *xyzw)
 extracts a 4D vector value from the specified node/attribute More...
 
static MStatus getVec4 (MObject node, MObject attr, half *xyzw)
 extracts a 4D vector value from the specified node/attribute More...
 
static MStatus getQuat (MObject node, MObject attr, float *xyzw)
 extracts a 4D quat value from the specified node/attribute More...
 
static MStatus getQuat (MObject node, MObject attr, double *xyzw)
 extracts a 4D quat value from the specified node/attribute More...
 
static MStatus getQuat (MObject node, MObject attr, half *xyzw)
 extracts a 4D quat value from the specified node/attribute More...
 
Methods to set array attributes with array data
static MStatus setBoolArray (const MObject &node, const MObject &attr, const std::vector< bool > &values)
 sets all values on a boolean array attribute on the specified node More...
 
static MStatus setBoolArray (MObject node, MObject attr, const bool *const values, size_t count)
 sets all values on a boolean array attribute on the specified node More...
 
static MStatus setInt8Array (const MObject &node, const MObject &attr, const std::vector< int8_t > &values)
 sets all values on a 8bit integer array attribute on the specified node More...
 
static MStatus setInt8Array (MObject node, MObject attr, const int8_t *values, size_t count)
 sets all values on a 8bit integer array attribute on the specified node More...
 
static MStatus setInt16Array (const MObject &node, const MObject &attr, const std::vector< int16_t > &values)
 sets all values on a 16bit integer array attribute on the specified node More...
 
static MStatus setInt16Array (MObject node, MObject attr, const int16_t *values, size_t count)
 sets all values on a 16bit integer array attribute on the specified node More...
 
static MStatus setInt32Array (const MObject &node, const MObject &attr, const std::vector< int32_t > &values)
 sets all values on a 32bit integer array attribute on the specified node More...
 
static MStatus setInt32Array (MObject node, MObject attr, const int32_t *values, size_t count)
 sets all values on a 32bit integer array attribute on the specified node More...
 
static MStatus setInt64Array (const MObject &node, const MObject &attr, const std::vector< int64_t > &values)
 sets all values on a 64bit integer array attribute on the specified node More...
 
static MStatus setInt64Array (MObject node, MObject attr, const int64_t *values, size_t count)
 sets all values on a 64bit integer array attribute on the specified node More...
 
static MStatus setHalfArray (const MObject &node, const MObject &attr, const std::vector< half > &values)
 sets all values on a float array attribute on the specified node (but convert from half float data) More...
 
static MStatus setHalfArray (MObject node, MObject attr, const half *values, size_t count)
 sets all values on a float array attribute on the specified node (but convert from half float data) More...
 
static MStatus setFloatArray (const MObject &node, const MObject &attr, const std::vector< float > &values)
 sets all values on a float array attribute on the specified node More...
 
static MStatus setFloatArray (MObject node, MObject attr, const float *values, size_t count)
 sets all values on a float array attribute on the specified node More...
 
static MStatus setDoubleArray (const MObject &node, const MObject &attr, const std::vector< double > &values)
 sets all values on a double array attribute on the specified node More...
 
static MStatus setDoubleArray (MObject node, MObject attr, const double *values, size_t count)
 sets all values on a double array attribute on the specified node More...
 
static MStatus setVec2Array (MObject node, MObject attr, const half *values, size_t count)
 
static MStatus setVec2Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setVec2Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setVec2Array (MObject node, MObject attr, const int32_t *values, size_t count)
 
static MStatus setVec3Array (MObject node, MObject attr, const half *values, size_t count)
 
static MStatus setVec3Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setVec3Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setVec3Array (MObject node, MObject attr, const int32_t *values, size_t count)
 
static MStatus setVec4Array (MObject node, MObject attr, const half *values, size_t count)
 
static MStatus setVec4Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setVec4Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setVec4Array (MObject node, MObject attr, const int32_t *values, size_t count)
 
static MStatus setQuatArray (MObject node, MObject attr, const half *values, size_t count)
 
static MStatus setQuatArray (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setQuatArray (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setMatrix2x2Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setMatrix2x2Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setMatrix3x3Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setMatrix3x3Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setMatrix4x4Array (MObject node, MObject attr, const float *values, size_t count)
 
static MStatus setMatrix4x4Array (MObject node, MObject attr, const double *values, size_t count)
 
static MStatus setStringArray (MObject node, MObject attr, const std::string *values, size_t count)
 
static MStatus setTimeArray (MObject node, MObject attr, const float *values, size_t count, MTime::Unit unit)
 
static MStatus setAngleArray (MObject node, MObject attr, const float *values, size_t count, MAngle::Unit unit)
 
static MStatus setDistanceArray (MObject node, MObject attr, const float *values, size_t count, MDistance::Unit unit)
 
Methods to set single values on non-array attributes
static MStatus setHalf (MObject node, MObject attr, const half value)
 sets a half float value on the specified node/attribute More...
 
static MStatus setFloat (MObject node, MObject attr, float value)
 sets a float value on the specified node/attribute More...
 
static MStatus setDouble (MObject node, MObject attr, double value)
 sets a double value on the specified node/attribute More...
 
static MStatus setTime (MObject node, MObject attr, MTime value)
 sets a time value on the specified node/attribute More...
 
static MStatus setDistance (MObject node, MObject attr, MDistance value)
 sets a distance value on the specified node/attribute More...
 
static MStatus setAngle (MObject node, MObject attr, MAngle value)
 sets an angle value on the specified node/attribute More...
 
static MStatus setBool (MObject node, MObject attr, bool value)
 sets a boolean value on the specified node/attribute More...
 
static MStatus setInt8 (MObject node, MObject attr, int8_t value)
 sets a 8bit integer value on the specified node/attribute More...
 
static MStatus setInt16 (MObject node, MObject attr, int16_t value)
 sets a 16bit integer value on the specified node/attribute More...
 
static MStatus setInt32 (MObject node, MObject attr, int32_t value)
 sets a 32bit integer value on the specified node/attribute More...
 
static MStatus setInt64 (MObject node, MObject attr, int64_t value)
 sets a 64bit integer value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, float x, float y, float z)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, double x, double y, double z)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, MAngle x, MAngle y, MAngle z)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setMatrix2x2 (MObject node, MObject attr, const float *values)
 sets a 2x2 matrix value on the specified node/attribute More...
 
static MStatus setMatrix3x3 (MObject node, MObject attr, const float *values)
 sets a 3x3 matrix value on the specified node/attribute More...
 
static MStatus setMatrix4x4 (MObject node, MObject attr, const float *values)
 sets a 4x4 matrix value on the specified node/attribute More...
 
static MStatus setMatrix4x4 (MObject node, MObject attr, const MFloatMatrix &value)
 sets a 4x4 matrix value on the specified node/attribute More...
 
static MStatus setMatrix2x2 (MObject node, MObject attr, const double *values)
 sets a 2x2 matrix value on the specified node/attribute More...
 
static MStatus setMatrix3x3 (MObject node, MObject attr, const double *values)
 sets a 3x3 matrix value on the specified node/attribute More...
 
static MStatus setMatrix4x4 (MObject node, MObject attr, const double *values)
 sets a 4x4 matrix value on the specified node/attribute More...
 
static MStatus setMatrix4x4 (MObject node, MObject attr, const MMatrix &value)
 sets a 4x4 matrix value on the specified node/attribute More...
 
static MStatus setString (MObject node, MObject attr, const char *str)
 sets a string value on the specified node/attribute More...
 
static MStatus setString (MObject node, MObject attr, const std::string &str)
 sets a string value on the specified node/attribute More...
 
static MStatus setVec2 (MObject node, MObject attr, const int32_t *xy)
 sets a 2D vector value on the specified node/attribute More...
 
static MStatus setVec2 (MObject node, MObject attr, const float *xy)
 sets a 2D vector value on the specified node/attribute More...
 
static MStatus setVec2 (MObject node, MObject attr, const double *xy)
 sets a 2D vector value on the specified node/attribute More...
 
static MStatus setVec2 (MObject node, MObject attr, const half *xy)
 sets a 2D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, const int32_t *xyz)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, const float *xyz)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, const double *xyz)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec3 (MObject node, MObject attr, const half *xyz)
 sets a 3D vector value on the specified node/attribute More...
 
static MStatus setVec4 (MObject node, MObject attr, const int32_t *xyzw)
 sets a 4D vector value on the specified node/attribute More...
 
static MStatus setVec4 (MObject node, MObject attr, const float *xyzw)
 sets a 4D vector value on the specified node/attribute More...
 
static MStatus setVec4 (MObject node, MObject attr, const double *xyzw)
 sets a 4D vector value on the specified node/attribute More...
 
static MStatus setVec4 (MObject node, MObject attr, const half *xyzw)
 sets a 4D vector value on the specified node/attribute More...
 
static MStatus setQuat (MObject node, MObject attr, const float *xyzw)
 sets a 4D quat value on the specified node/attribute More...
 
static MStatus setQuat (MObject node, MObject attr, const double *xyzw)
 sets a 4D quat value on the specified node/attribute More...
 
static MStatus setQuat (MObject node, MObject attr, const half *xyzw)
 sets a 4D quat value on the specified node/attribute More...
 
Utilities
static MStatus addStringValue (MObject node, const char *attrName, const char *stringValue)
 adds a new strings attribute of the specified name to the specified node, and sets its value. This is primarily used as a utility to tag various maya nodes with some USD specific information, e.g. the by adding a prim path, asset info, etc. More...
 

Detailed Description

Utility class that provides support for setting/getting attributes.

Member Function Documentation

static MStatus AL::maya::DgNodeHelper::addStringValue ( MObject  node,
const char *  attrName,
const char *  stringValue 
)
static

adds a new strings attribute of the specified name to the specified node, and sets its value. This is primarily used as a utility to tag various maya nodes with some USD specific information, e.g. the by adding a prim path, asset info, etc.

Parameters
nodethe node to add the attribute to
attrNamethe name of the attribute to add
stringValuethe value for the new atribue
Returns
MS::kSuccess if ok.
static MStatus AL::maya::DgNodeHelper::getAngle ( MObject  node,
MObject  attr,
MAngle &  value 
)
static

extracts a single angle value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getAngleArray ( MObject  node,
MObject  attr,
float *  values,
size_t  count,
MAngle::Unit  unit 
)
static

given MObjects for an attribute on a node, extract the data as an array of angle values scale to the specified unit.

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of values to extract
unitthe angle unit you want the data in
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getBool ( MObject  node,
MObject  attr,
bool &  value 
)
static

extracts a single boolean value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getBoolArray ( const MObject &  node,
const MObject &  attr,
std::vector< bool > &  values 
)
static

retrieve an array of boolean values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getBoolArray ( MObject  node,
MObject  attr,
bool *  values,
const size_t  count 
)
static

retrieve an array of boolean values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getDistance ( MObject  node,
MObject  attr,
MDistance &  value 
)
static

extracts a single distance value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getDistanceArray ( MObject  node,
MObject  attr,
float *  values,
size_t  count,
MDistance::Unit  unit 
)
static

given MObjects for an attribute on a node, extract the data as an array of distance values scale to the specified unit.

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of values to extract
unitthe distance unit you want the data in
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getDouble ( MObject  node,
MObject  attr,
double &  value 
)
static

extracts a single double value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getDoubleArray ( const MObject &  node,
const MObject &  attr,
std::vector< double > &  values 
)
inlinestatic

retrieve an array of double values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getDoubleArray ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

retrieve an array of double values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getFloat ( MObject  node,
MObject  attr,
float &  value 
)
static

extracts a single float value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getFloatArray ( const MObject &  node,
const MObject &  attr,
std::vector< float > &  values 
)
inlinestatic

retrieve an array of float values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getFloatArray ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

retrieve an array of float values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getHalf ( MObject  node,
MObject  attr,
half &  value 
)
inlinestatic

extracts a single half float value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getHalfArray ( const MObject &  node,
const MObject &  attr,
std::vector< half > &  values 
)
inlinestatic

retrieve an array of float values from an attribute in Maya (converted to halfs)

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getHalfArray ( MObject  node,
MObject  attr,
half *  values,
size_t  count 
)
static

retrieve an array of half values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt16 ( MObject  node,
MObject  attr,
int16_t &  value 
)
static

extracts a single 16 bit integer value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getInt16Array ( const MObject &  node,
const MObject &  attr,
std::vector< int16_t > &  values 
)
inlinestatic

retrieve an array of 16bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt16Array ( MObject  node,
MObject  attr,
int16_t *  values,
size_t  count 
)
static

retrieve an array of 16 bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt32 ( MObject  node,
MObject  attr,
int32_t &  value 
)
static

extracts a single 32bit integer value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getInt32Array ( const MObject &  node,
const MObject &  attr,
std::vector< int32_t > &  values 
)
inlinestatic

retrieve an array of 32bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt32Array ( MObject  node,
MObject  attr,
int32_t *  values,
size_t  count 
)
static

retrieve an array of 32 bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt64 ( MObject  node,
MObject  attr,
int64_t &  value 
)
static

extracts a single 64bit integer value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getInt64Array ( const MObject &  node,
const MObject &  attr,
std::vector< int64_t > &  values 
)
inlinestatic

retrieve an array of 64bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt64Array ( MObject  node,
MObject  attr,
int64_t *  values,
size_t  count 
)
static

retrieve an array of 64 bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt8 ( MObject  node,
MObject  attr,
int8_t &  value 
)
static

extracts a single 8bit integer value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::getInt8Array ( const MObject &  node,
const MObject &  attr,
std::vector< int8_t > &  values 
)
inlinestatic

retrieve an array of 8 bit char values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesthe returned array of values
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getInt8Array ( MObject  node,
MObject  attr,
int8_t *  values,
size_t  count 
)
static

retrieve an array of 8 bit integer values from an attribute in Maya

Parameters
nodethe maya node on which the attribute you are interested in exists
attrthe handle to the array attribute. This will either be an MObject for a custom maya attribute, a handle queried via the MNodeClass interface, or a dynamically added attribute
valuesa pointer to a pre-allocated buffer to fill with the attribute values
countthe number of elements in the buffer.
Returns
MS::kSuccess if ok
static MStatus AL::maya::DgNodeHelper::getMatrix2x2 ( MObject  node,
MObject  attr,
float *  values 
)
static

extracts a 2x2 matrix value from the specified node/attribute (as a float)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of floats
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix2x2 ( MObject  node,
MObject  attr,
double *  values 
)
static

extracts a 2x2 matrix value from the specified node/attribute (as a double)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of doubles
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix2x2Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2x2 floating point matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getMatrix2x2Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2x2 double matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getMatrix3x3 ( MObject  node,
MObject  attr,
float *  values 
)
static

extracts a 3x3 matrix value from the specified node/attribute (as a float)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of floats
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix3x3 ( MObject  node,
MObject  attr,
double *  values 
)
static

extracts a 3x3 matrix value from the specified node/attribute (as a double)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of doubles
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix3x3Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3x3 floating point matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 9x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getMatrix3x3Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3x3 double matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 9x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getMatrix4x4 ( MObject  node,
MObject  attr,
float *  values 
)
static

extracts a 4x4 matrix value from the specified node/attribute (as a float)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of floats
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix4x4 ( MObject  node,
MObject  attr,
MFloatMatrix &  values 
)
static

extracts a 4x4 matrix value from the specified node/attribute (as a float)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix4x4 ( MObject  node,
MObject  attr,
double *  values 
)
static

extracts a 4x4 matrix value from the specified node/attribute (as a double)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value as an array of doubles
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix4x4 ( MObject  node,
MObject  attr,
MMatrix &  values 
)
static

extracts a 4x4 matrix value from the specified node/attribute (as a double)

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe returned matrix value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getMatrix4x4Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4x4 floating point matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 16x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getMatrix4x4Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4x4 double matrix array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 16x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getQuat ( MObject  node,
MObject  attr,
float *  xyzw 
)
static

extracts a 4D quat value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getQuat ( MObject  node,
MObject  attr,
double *  xyzw 
)
static

extracts a 4D quat value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getQuat ( MObject  node,
MObject  attr,
half *  xyzw 
)
static

extracts a 4D quat value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getQuatArray ( MObject  node,
MObject  attr,
half *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D half float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getQuatArray ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getQuatArray ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D double array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getString ( MObject  node,
MObject  attr,
std::string &  str 
)
static

extracts a string value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
strthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getStringArray ( MObject  node,
MObject  attr,
std::string *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as an array of string values

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of values to extract
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getTime ( MObject  node,
MObject  attr,
MTime &  value 
)
static

extracts a single time value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getTimeArray ( MObject  node,
MObject  attr,
float *  values,
size_t  count,
MTime::Unit  unit 
)
static

given MObjects for an attribute on a node, extract the data as an array of time values scale to the specified unit.

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of values to extract
unitthe time unit you want the data in
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec2 ( MObject  node,
MObject  attr,
int32_t *  xy 
)
static

extracts a 2D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec2 ( MObject  node,
MObject  attr,
float *  xy 
)
static

extracts a 2D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec2 ( MObject  node,
MObject  attr,
double *  xy 
)
static

extracts a 2D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec2 ( MObject  node,
MObject  attr,
half *  xy 
)
static

extracts a 2D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec2Array ( MObject  node,
MObject  attr,
half *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2D half float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 2x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec2Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2D float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 2x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec2Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2D double array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 2x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec2Array ( MObject  node,
MObject  attr,
int32_t *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 2D integer array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 2x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec3 ( MObject  node,
MObject  attr,
int32_t *  xyz 
)
static

extracts a 3D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec3 ( MObject  node,
MObject  attr,
float *  xyz 
)
static

extracts a 3D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec3 ( MObject  node,
MObject  attr,
double *  xyz 
)
static

extracts a 3D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec3 ( MObject  node,
MObject  attr,
half *  xyz 
)
static

extracts a 3D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec3Array ( MObject  node,
MObject  attr,
half *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3D half float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 3x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec3Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3D float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 3x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec3Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3D double array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 3x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec3Array ( MObject  node,
MObject  attr,
int32_t *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 3D integer array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 3x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec4 ( MObject  node,
MObject  attr,
int32_t *  xyzw 
)
static

extracts a 4D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec4 ( MObject  node,
MObject  attr,
float *  xyzw 
)
static

extracts a 4D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec4 ( MObject  node,
MObject  attr,
double *  xyzw 
)
static

extracts a 4D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec4 ( MObject  node,
MObject  attr,
half *  xyzw 
)
static

extracts a 4D vector value from the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe returned value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::getVec4Array ( MObject  node,
MObject  attr,
half *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D half float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec4Array ( MObject  node,
MObject  attr,
float *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D float array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec4Array ( MObject  node,
MObject  attr,
double *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D double array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::getVec4Array ( MObject  node,
MObject  attr,
int32_t *  values,
size_t  count 
)
static

given MObjects for an attribute on a node, extract the data as a 4D integer array

Parameters
nodea handle to the node to get the attribute from
attra handle to the attribute that contains the array data you wish to extract
valuesthe pre-allocated buffer into which you wish to get the data
countthe number of matrices to extract (values should be 4x this size)
Returns
MS::kSuccess if everything is OK
static MStatus AL::maya::DgNodeHelper::setAngle ( MObject  node,
MObject  attr,
MAngle  value 
)
static

sets an angle value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setBool ( MObject  node,
MObject  attr,
bool  value 
)
static

sets a boolean value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setBoolArray ( const MObject &  node,
const MObject &  attr,
const std::vector< bool > &  values 
)
static

sets all values on a boolean array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setBoolArray ( MObject  node,
MObject  attr,
const bool *const  values,
size_t  count 
)
static

sets all values on a boolean array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setDistance ( MObject  node,
MObject  attr,
MDistance  value 
)
static

sets a distance value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setDouble ( MObject  node,
MObject  attr,
double  value 
)
static

sets a double value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setDoubleArray ( const MObject &  node,
const MObject &  attr,
const std::vector< double > &  values 
)
inlinestatic

sets all values on a double array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setDoubleArray ( MObject  node,
MObject  attr,
const double *  values,
size_t  count 
)
static

sets all values on a double array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setFloat ( MObject  node,
MObject  attr,
float  value 
)
static

sets a float value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setFloatArray ( const MObject &  node,
const MObject &  attr,
const std::vector< float > &  values 
)
inlinestatic

sets all values on a float array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setFloatArray ( MObject  node,
MObject  attr,
const float *  values,
size_t  count 
)
static

sets all values on a float array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setHalf ( MObject  node,
MObject  attr,
const half  value 
)
inlinestatic

sets a half float value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setHalfArray ( const MObject &  node,
const MObject &  attr,
const std::vector< half > &  values 
)
inlinestatic

sets all values on a float array attribute on the specified node (but convert from half float data)

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setHalfArray ( MObject  node,
MObject  attr,
const half *  values,
size_t  count 
)
static

sets all values on a float array attribute on the specified node (but convert from half float data)

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt16 ( MObject  node,
MObject  attr,
int16_t  value 
)
static

sets a 16bit integer value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setInt16Array ( const MObject &  node,
const MObject &  attr,
const std::vector< int16_t > &  values 
)
inlinestatic

sets all values on a 16bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt16Array ( MObject  node,
MObject  attr,
const int16_t *  values,
size_t  count 
)
static

sets all values on a 16bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt32 ( MObject  node,
MObject  attr,
int32_t  value 
)
static

sets a 32bit integer value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setInt32Array ( const MObject &  node,
const MObject &  attr,
const std::vector< int32_t > &  values 
)
inlinestatic

sets all values on a 32bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt32Array ( MObject  node,
MObject  attr,
const int32_t *  values,
size_t  count 
)
static

sets all values on a 32bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt64 ( MObject  node,
MObject  attr,
int64_t  value 
)
static

sets a 64bit integer value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setInt64Array ( const MObject &  node,
const MObject &  attr,
const std::vector< int64_t > &  values 
)
inlinestatic

sets all values on a 64bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt64Array ( MObject  node,
MObject  attr,
const int64_t *  values,
size_t  count 
)
static

sets all values on a 64bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt8 ( MObject  node,
MObject  attr,
int8_t  value 
)
static

sets a 8bit integer value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
MStatus AL::maya::DgNodeHelper::setInt8Array ( const MObject &  node,
const MObject &  attr,
const std::vector< int8_t > &  values 
)
inlinestatic

sets all values on a 8bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setInt8Array ( MObject  node,
MObject  attr,
const int8_t *  values,
size_t  count 
)
static

sets all values on a 8bit integer array attribute on the specified node

Parameters
nodethe node on which the attribute exists
attrthe handle to the array attribute
valuesthe array values to set on the attribute
countthe number of elements in the values array
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix2x2 ( MObject  node,
MObject  attr,
const float *  values 
)
static

sets a 2x2 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 4 floats)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix2x2 ( MObject  node,
MObject  attr,
const double *  values 
)
static

sets a 2x2 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 4 doubles)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix3x3 ( MObject  node,
MObject  attr,
const float *  values 
)
static

sets a 3x3 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 9 floats)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix3x3 ( MObject  node,
MObject  attr,
const double *  values 
)
static

sets a 3x3 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 9 doubles)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix4x4 ( MObject  node,
MObject  attr,
const float *  values 
)
static

sets a 4x4 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 16 floats)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix4x4 ( MObject  node,
MObject  attr,
const MFloatMatrix &  value 
)
static

sets a 4x4 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix4x4 ( MObject  node,
MObject  attr,
const double *  values 
)
static

sets a 4x4 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuesthe new value (as an array of 16 doubles)
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setMatrix4x4 ( MObject  node,
MObject  attr,
const MMatrix &  value 
)
static

sets a 4x4 matrix value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setQuat ( MObject  node,
MObject  attr,
const float *  xyzw 
)
static

sets a 4D quat value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setQuat ( MObject  node,
MObject  attr,
const double *  xyzw 
)
static

sets a 4D quat value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setQuat ( MObject  node,
MObject  attr,
const half *  xyzw 
)
static

sets a 4D quat value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setString ( MObject  node,
MObject  attr,
const char *  str 
)
static

sets a string value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
strthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setString ( MObject  node,
MObject  attr,
const std::string &  str 
)
static

sets a string value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
strthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setTime ( MObject  node,
MObject  attr,
MTime  value 
)
static

sets a time value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
valuethe new value for the attribute
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec2 ( MObject  node,
MObject  attr,
const int32_t *  xy 
)
static

sets a 2D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec2 ( MObject  node,
MObject  attr,
const float *  xy 
)
static

sets a 2D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec2 ( MObject  node,
MObject  attr,
const double *  xy 
)
static

sets a 2D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec2 ( MObject  node,
MObject  attr,
const half *  xy 
)
static

sets a 2D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xythe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
float  x,
float  y,
float  z 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xthe new x value
ythe new y value
zthe new z value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
double  x,
double  y,
double  z 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xthe new x value
ythe new y value
zthe new z value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
MAngle  x,
MAngle  y,
MAngle  z 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xthe new x value
ythe new y value
zthe new z value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
const int32_t *  xyz 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
const float *  xyz 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
const double *  xyz 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec3 ( MObject  node,
MObject  attr,
const half *  xyz 
)
static

sets a 3D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec4 ( MObject  node,
MObject  attr,
const int32_t *  xyzw 
)
static

sets a 4D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec4 ( MObject  node,
MObject  attr,
const float *  xyzw 
)
static

sets a 4D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec4 ( MObject  node,
MObject  attr,
const double *  xyzw 
)
static

sets a 4D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok
static MStatus AL::maya::DgNodeHelper::setVec4 ( MObject  node,
MObject  attr,
const half *  xyzw 
)
static

sets a 4D vector value on the specified node/attribute

Parameters
nodethe node on which the attribute exists
attrthe handle to the attribute
xyzwthe new value
Returns
MS::kSuccess if all ok

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