#include <MFnDynSweptGeometryData.h>

Class Description

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.

Examples:: simpleFluidEmitter/simpleFluidEmitter.cpp, and sweptEmitter/sweptEmitter.cpp.

Inheritance diagram for MFnDynSweptGeometryData:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnDynSweptGeometryData ()
	Destructor.

	MFnDynSweptGeometryData ()
	Default constructor.

	MFnDynSweptGeometryData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

int	lineCount (MStatus *ReturnStatus=NULL) const
	Return the number of line segments contained in the data. More...

int	triangleCount (MStatus *ReturnStatus=NULL) const
	Return the number of triangles contained in the data. More...

MDynSweptLine	sweptLine (int index, MStatus *ReturnStatus=NULL) const
	Return data for a swept line. More...

MDynSweptTriangle	sweptTriangle (int index, MStatus *ReturnStatus=NULL) const
	Return data for a swept triangle. More...

MObject	create (MStatus *ReturnStatus=NULL)
	This method create a new swept geometry data object for use with the dependency graph. More...

	MFnDynSweptGeometryData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnData
virtual	~MFnData ()
	Destructor.

	MFnData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

	MFnData ()
	Default class constructor.

	MFnData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...

bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...

virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...

virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Protected Member Functions
virtual const char *	className () const
	Class name. More...

Additional Inherited Members
Public Types inherited from MFnData
enum	Type { kInvalid, kNumeric, kPlugin, kPluginGeometry, kString, kMatrix, kStringArray, kDoubleArray, kFloatArray, kIntArray, kPointArray, kVectorArray, kMatrixArray, kComponentList, kMesh, kLattice, kNurbsCurve, kNurbsSurface, kSphere, kDynArrayAttrs, kDynSweptGeometry, kSubdSurface, kNObject, kNId, kAny, kLast }
	Types of dependency graph data. More...

Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MFnDynSweptGeometryData	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kDynSweptGeometryData.

Reimplemented from MFnData.

const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnDynSweptGeometryData".

Reimplemented from MFnData.

int lineCount ( MStatus * ReturnStatus = NULL ) const

Return the number of line segments contained in the data.

Parameters

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

Returns: Number of line segments

int triangleCount ( MStatus * ReturnStatus = NULL ) const

Return the number of triangles contained in the data.

Parameters

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

Returns: Number of triangles

MDynSweptLine sweptLine	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

Return data for a swept line.

Parameters

[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.

Returns: A const reference to the MDynSweptLine

MDynSweptTriangle sweptTriangle	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

Return data for a swept triangle.

Parameters

[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.

Returns: A const reference to the MDynSweptTriangle

MObject create ( MStatus * ReturnStatus = NULL )

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

Parameters

[out] ReturnStatus return status

Returns: A handle to the new swept geometry data object

Status Codes:

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

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

MFnDynSweptGeometryData.h
MFnDynSweptGeometryData.cpp

MFnDynSweptGeometryData Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation