Swept Geometry function set for dependency node data.
MFnDynSweptGeometryData provides access to the MDynSweptLine and MDynSweptTriangle data for use in a user defined dependency graph node. The data is provided as an output from the geoConnector node and is primarily used to determine positional information over time.
If a user written dependency node accepts MFnDynSweptGeometryData, then this class is used to extract data that comes from the geoConnector node. The MDataHandle::type method will return kDynSweptGeometry when data of this type is present. To access it, the MDataHandle::data() method is used to get an MObject for the data and this should then be used to initialize an instance of MFnDynSweptGeometryData.
Important note: Users can create the data for connections but cannot produce the contents of the data as this is reserved for the Maya Dynamics internals.
#include <MFnDynSweptGeometryData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. | |
virtual | ~MFnDynSweptGeometryData () |
Destructor. | |
MFnDynSweptGeometryData () | |
Default constructor. | |
MFnDynSweptGeometryData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
int | lineCount (MStatus *ReturnStatus=NULL) const |
Return the number of line segments contained in the data. | |
int | triangleCount (MStatus *ReturnStatus=NULL) const |
Return the number of triangles contained in the data. | |
MDynSweptLine | sweptLine (int index, MStatus *ReturnStatus=NULL) const |
Return data for a swept line. | |
MDynSweptTriangle | sweptTriangle (int index, MStatus *ReturnStatus=NULL) const |
Return data for a swept triangle. | |
MObject | create (MStatus *ReturnStatus=NULL) |
This method create a new swept geometry data object for use with the dependency graph. | |
MFnDynSweptGeometryData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
Protected Member Functions | |
virtual const char * | className () const |
Class name. |
MFnDynSweptGeometryData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
MFnDynSweptGeometryData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
MFn::Type type | ( | ) | const [virtual] |
const char * className | ( | ) | const [protected, virtual] |
int lineCount | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of line segments contained in the data.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
int triangleCount | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of triangles contained in the data.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
MDynSweptLine sweptLine | ( | int | index, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Return data for a swept line.
[in] | index | Index of the swept line to return data for. Must be in the range 0 to (lineCount() - 1). |
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
MDynSweptTriangle sweptTriangle | ( | int | index, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Return data for a swept triangle.
[in] | index | Index of the swept triangle to return data for. Must be in the range 0 to (triangleCount() - 1). |
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
This method create a new swept geometry data object for use with the dependency graph.
[out] | ReturnStatus | return status |