MFnNObjectData Class Reference
[OpenMayaFX - API module for effectsFunctionSet classes]

#include <MFnNObjectData.h>
Inheritance diagram for MFnNObjectData:
Inheritance graph
[legend]
Collaboration diagram for MFnNObjectData:
Collaboration graph
[legend]

List of all members.


Detailed Description

function set for nCloth object data

Class for transferring N object data between connections

Examples:

testNobjectNode.cpp, and testNucleusNode.cpp.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnNObjectData ()
  Destructor.
  MFnNObjectData ()
  Default constructor.
  MFnNObjectData (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
MObject  create () const
MStatus  getObjectPtr (MnCloth *&ptr) const
MStatus  getObjectPtr (MnRigid *&ptr) const
MStatus  getObjectPtr (MnParticle *&ptr) const
MStatus  setObjectPtr (MnCloth *ptr)
MStatus  setObjectPtr (MnRigid *ptr)
MStatus  setObjectPtr (MnParticle *ptr)
MStatus  getCollide (bool &) const
MStatus  getCached (bool &cached) const
MStatus  setCached (bool cached)
  MFnNObjectData (const MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

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

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

Member Function Documentation

MFn::Type MFnNObjectData::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kNObjectData

Reimplemented from MFnData.

const char * MFnNObjectData::className (  )  const [protected, virtual]

Class name.

Return the class name : "MFnNObjectData"

Reimplemented from MFnData.

MObject MFnNObjectData::create (  )  const

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

Returns:
The newly object.
Examples:

MStatus MFnNObjectData::getObjectPtr ( MnCloth *&  ptr  )  const

Get the nObject pointer for an nCloth

Parameters:
[in]  ptr  Storage to return the pointer to the N cloth.
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::getObjectPtr ( MnRigid *&  ptr  )  const

Get the nObject pointer for an nRigid

Parameters:
[in]  ptr  Storage to return the pointer to the N rigid
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::getObjectPtr ( MnParticle *&  ptr  )  const

Get the nObject pointer for an nParticle

Parameters:
[in]  ptr  Storage to return the pointer to the N cloth.
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::setObjectPtr ( MnCloth ptr  ) 

Set the nCloth pointer

Parameters:
[in]  ptr  pointer to the N cloth
Returns:
Status Code
Status Codes:
Examples:

MStatus MFnNObjectData::setObjectPtr ( MnRigid ptr  ) 

Set the nRigid pointer

Parameters:
[in]  ptr  pointer to the nRigid
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::setObjectPtr ( MnParticle ptr  ) 

Set the nParticle pointer

Parameters:
[in]  ptr  pointer to the nParticle
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::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:

MStatus MFnNObjectData::getCached ( bool &  cached  )  const

Get wether the nObject is cached.

Parameters:
[out]  cached  the cache state
Returns:
Status Code
Status Codes:

MStatus MFnNObjectData::setCached ( bool  cached  ) 

Set wether the nObject is cached.

Parameters:
[in]  cached  the cache state
Returns:
Status Code
Status Codes:
Examples:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6