class MFnDynSweptGeometryData

Jump to documentation

: public MFnData Swept Geometry function set for dependency node data (OpenMayaFX) (OpenMayaFX.py)

Inheritance:

MFnDynSweptGeometryData < MFnData < MFnBase

public members:

MFnDynSweptGeometryData ()
MFnDynSweptGeometryData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnDynSweptGeometryData ()
virtual MFn::Type type () const
int lineCount ( MStatus * ReturnStatus = NULL ) const
int triangleCount ( MStatus * ReturnStatus = NULL ) const
MDynSweptLine sweptLine ( int index, MStatus * ReturnStatus = NULL ) const
MDynSweptTriangle sweptTriangle ( int index, MStatus * ReturnStatus = NULL ) const
MObject create ( MStatus * ReturnStatus=NULL )
MFnDynSweptGeometryData ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnData:

public members:

enum Type
kInvalid
kNumeric
Numeric, use MFnNumericData extract the node data.
kPlugin
Plugin Blind Data, use MFnPluginData to extract the node data.
kPluginGeometry
Plugin Geometry, use MFnGeometryData to extract the node data.
kString
String, use MFnStringData to extract the node data.
kMatrix
Matrix, use MFnMatrixData to extract the node data.
kStringArray
String Array, use MFnStringArrayData to extract the node data.
kDoubleArray
Double Array, use MFnDoubleArrayData to extract the node data.
kIntArray
Int Array, use MFnIntArrayData to extract the node data.
kPointArray
Point Array, use MFnPointArrayData to extract the node data.
kVectorArray
Vector Array, use MFnVectorArrayData to extract the node data.
kComponentList
Component List, use MFnComponentListData to extract the node data.
kMesh
Mesh, use MFnMeshData to extract the node data.
kLattice
Lattice, use MFnLatticeData to extract the node data.
kNurbsCurve
Nurbs Curve, use MFnNurbsCurveData to extract the node data.
kNurbsSurface
Nurbs Surface, use MFnNurbsSurfaceData to extract the node data.
kSphere
Sphere, use MFnSphereData to extract the node data.
kDynArrayAttrs
ArrayAttrs, use MFnArrayAttrsData to extract the node data.
kDynSweptGeometry
SweptGeometry, use MFnDynSweptGeometryData to extract the node data.
kSubdSurface
Subdivision Surface, use MFnSubdData to extract the node data.
kNObject
nObject data, use MFnNObjectData to extract node data
kLast

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Access MDynSweptLine and MDynSweptTriangle dependency node data
Description

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.

Functions

MFnDynSweptGeometryData:: MFnDynSweptGeometryData ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnDynSweptGeometryData:: MFnDynSweptGeometryData ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnDynSweptGeometryData:: MFnDynSweptGeometryData ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnDynSweptGeometryData:: ~MFnDynSweptGeometryData ()

Description

The class destructor.

MFn::Type MFnDynSweptGeometryData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kDynSweptGeometryData

MObject MFnDynSweptGeometryData:: create ( MStatus * ReturnStatus )

Description

This method create a new swept geometry data object for use with the dependency graph.

Arguments

  • ReturnStatus return status

Return Value

  • a handle to the new swept geometry data object

Status Codes

  • MS::kSuccess operation successful
  • MS::kInsufficientMemory out of memory

int MFnDynSweptGeometryData:: lineCount ( MStatus * ReturnStatus ) const

Description

Return the number of line segments contained in the data.

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • number of line segments

int MFnDynSweptGeometryData:: triangleCount ( MStatus * ReturnStatus ) const

Description

Return the number of triangles contained in the data.

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • number of triangles

MDynSweptLine MFnDynSweptGeometryData:: sweptLine ( int index, MStatus * ReturnStatus ) const

Description

Return a constant reference to the swept line data.

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • a const reference to the MDynSweptLine

MDynSweptTriangle MFnDynSweptGeometryData:: sweptTriangle ( int index, MStatus * ReturnStatus ) const

Description

Return a constant reference to the swept triangle data.

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • a const reference to the MDynSweptTriangle

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright