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

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

List of all members.


Detailed Description

function set for nId object data

Class for transferring N id data between connections


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnNIdData ()
  Destructor.
  MFnNIdData ()
  Default constructor.
  MFnNIdData (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
MObject  create () const
MStatus  getObjectPtr (MnObject *&ptr) const
  MFnNIdData (const MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

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

MFnNIdData::MFnNIdData ( 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 MFnNIdData::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kNIdData

Reimplemented from MFnData.

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

Class name.

Return the class name : "MFnNIdData"

Reimplemented from MFnData.

MObject MFnNIdData::create (  )  const

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

Returns:
The newly object.

MStatus MFnNIdData::getObjectPtr ( MnObject *&  ptr  )  const

Get the nObject pointer

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

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