function set for nCloth object data More...

#include <MFnNObjectData.h>

Inheritance diagram for MFnNObjectData:

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

virtual	~MFnNObjectData ()
	Destructor.

	MFnNObjectData ()
	Default constructor.

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

MObject	create () const
	Creates an underlying Maya N data object and return it as an MObject. More...

MStatus	getObjectPtr (MnCloth *&ptr) const
	NO SCRIPT SUPPORT. More...

MStatus	getObjectPtr (MnRigid *&ptr) const
	NO SCRIPT SUPPORT. More...

MStatus	getObjectPtr (MnParticle *&ptr) const
	NO SCRIPT SUPPORT. More...

MnCloth *	getClothObjectPtr (MStatus *status=NULL) const
	Get the nObject pointer for an nCloth. More...

MnRigid *	getRigidObjectPtr (MStatus *status=NULL) const
	Get the nObject pointer for an nRigid. More...

MnParticle *	getParticleObjectPtr (MStatus *status=NULL) const
	Get the nObject pointer for an nParticle. More...

MStatus	setObjectPtr (MnCloth *ptr)
	Set the nCloth pointer. More...

MStatus	setObjectPtr (MnRigid *ptr)
	Set the nRigid pointer. More...

MStatus	setObjectPtr (MnParticle *ptr)
	Set the nParticle pointer. More...

MStatus	getCollide (bool &) const
	Get wether the nObject is allowed to participate in collisions. More...

MStatus	getCached (bool &cached) const
	NO SCRIPT SUPPORT. More...

bool	isCached (MStatus *status=NULL) const
	Get whether the nObject is cached. More...

MStatus	setCached (bool cached)
	Set wether the nObject is cached. More...

	MFnNObjectData (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...

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

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

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

static const char *	typeString (MFn::Type)
	Returns the type string for a given type. More...

static bool	isValid (MFn::Type)
	Returns true if type is in the range of valid types. 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...

Detailed Description

function set for nCloth object data

Class for transferring N object data between connections

Examples:: testNobjectNode/testNobjectNode.cpp, testNpassiveNode/testNpassiveNode.cpp, testNsolverNode/testNsolverNode.cpp, and testNucleusNode/testNucleusNode.cpp.

Constructor & Destructor Documentation

MFnNObjectData	(	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

MFnNObjectData	(	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::kNObjectData.

Returns: the class type.

Reimplemented from MFnData.

const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnNObjectData".

Returns: Name of this class.

MObject create ( ) const

Creates an underlying Maya N data object and return it as an MObject.

Returns: The newly object.

Examples:: testNobjectNode/testNobjectNode.cpp, and testNpassiveNode/testNpassiveNode.cpp.

MStatus getObjectPtr ( MnCloth *& ptr ) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nCloth.

Parameters

[in] ptr Storage to return the pointer to the N cloth.

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus getObjectPtr ( MnRigid *& ptr ) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nRigid.

Parameters

[in] ptr Storage to return the pointer to the N rigid

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus getObjectPtr ( MnParticle *& ptr ) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nParticle.

Parameters

[in] ptr Storage to return the pointer to the N particle.

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MnCloth * getClothObjectPtr ( MStatus * status = NULL ) const

Get the nObject pointer for an nCloth.

Parameters

[out] status Status Code

Returns: the pointer to the N cloth

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MnRigid * getRigidObjectPtr ( MStatus * status = NULL ) const

Get the nObject pointer for an nRigid.

Parameters

[out] status Status Code

Returns: the pointer to the N rigid

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MnParticle * getParticleObjectPtr ( MStatus * status = NULL ) const

Get the nObject pointer for an nParticle.

Parameters

[out] status Status Code

Returns: the pointer to the N particle

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus setObjectPtr ( MnCloth * ptr )

Set the nCloth pointer.

Parameters

[in] ptr pointer to the N cloth

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

Examples:: testNobjectNode/testNobjectNode.cpp, and testNpassiveNode/testNpassiveNode.cpp.

MStatus setObjectPtr ( MnRigid * ptr )

Set the nRigid pointer.

Parameters

[in] ptr pointer to the nRigid

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus setObjectPtr ( MnParticle * ptr )

Set the nParticle pointer.

Parameters

[in] ptr pointer to the nParticle

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus getCollide ( bool & collide ) const

Get wether the nObject is allowed to participate in collisions.

Parameters

[out] collide the collision state

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus getCached ( bool & cached ) const

NO SCRIPT SUPPORT.

Get whether the nObject is cached.

Parameters

[out] cached the cache state

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

bool isCached ( MStatus * status = NULL ) const

Get whether the nObject is cached.

Parameters

[out] status Status Code

Returns: the cache state

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

MStatus setCached ( bool cached )

Set wether the nObject is cached.

Parameters

[in] cached the cache state

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure this function set does not have a valid object

Examples:: testNobjectNode/testNobjectNode.cpp, and testNpassiveNode/testNpassiveNode.cpp.

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

MFnNObjectData.h
MFnNObjectData.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation