class MFnNObjectData

Jump to documentation

: public MFnData (OpenMayaFX) (OpenMayaFX.py)

Inheritance:

MFnNObjectData < MFnData < MFnBase

public members:

MFnNObjectData ()
MFnNObjectData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnNObjectData ()
virtual MFn::Type type () const
MObject create () const
MStatus getObjectPtr ( MnCloth *& ptr ) const
MStatus setObjectPtr ( MnCloth * ptr )
MStatus getCollide ( bool & ) const
MStatus getCached ( bool & cached) const
MStatus setCached ( bool cached)
MFnNObjectData ( 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

Class for transferring N object data between connections
Description

This class is the function set for nCloth object data.

Functions

MFnNObjectData:: MFnNObjectData ()

Description

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

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

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

MFnNObjectData:: ~MFnNObjectData ()

Description

The class destructor.

MFn::Type MFnNObjectData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kNObjectData

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

Get the nObject pointer

Arguments

  • MnCloth *&

Return Value

  • Status Code

Status Codes

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

MStatus MFnNObjectData:: setObjectPtr ( MnCloth * ptr )
Description

Set the nCloth pointer

Arguments

  • MnCloth * pointer to the N cloth

Return Value

  • Status Code

Status Codes

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

MObject MFnNObjectData:: create () const
Description

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

Arguments

Return Value

  • MObject - the newly object

MStatus MFnNObjectData:: getCollide ( bool & collide) const
Description

Get wether the nObject is allowed to participate in collisions

Arguments

  • bool the collision state

Return Value

  • Status Code

Status Codes

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

MStatus MFnNObjectData:: getCached ( bool & cached) const
Description

Get wether the nObject is cached.

Arguments

  • bool the cache state

Return Value

  • Status Code

Status Codes

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

MStatus MFnNObjectData:: setCached ( bool cached)
Description

Set wether the nObject is cached.

Arguments

  • bool the cache state

Return Value

  • Status Code

Status Codes

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

This class has no child classes.


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