MFnManip3D Class Reference
[OpenMayaUI - API module for user interfaceFunctionSet classes]

#include <MFnManip3D.h>

Inheritance diagram for MFnManip3D:

Inheritance graph
[legend]
Collaboration diagram for MFnManip3D:

Collaboration graph
[legend]

List of all members.


Detailed Description

3D manipulator function set

MFnManip3D allows the creation and manipulation of 3D manipulators. MFnManip3D is the base class from which MFnFreePointTriadManip, MFnDirectionManip, MFnDistanceManip, MFnPointOnCurveManip, MFnPointOnSurfaceManip, MFnDiscManip, MFnCircleSweepManip, MFnToggleManip, MFnStateManip, and MFnCurveSegmentManip are derived.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnManip3D ()
 Destructor.
 MFnManip3D ()
 Default constructor.
 MFnManip3D (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnManip3D (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
bool isVisible (MStatus *ReturnStatus) const
MStatus setVisible (bool isVisible)
float manipScale (MStatus *ReturnStatus) const
MStatus setManipScale (float size)
bool isOptimizePlaybackOn (MStatus *ReturnStatus) const
MStatus setOptimizePlayback (bool optimizePlayback)
MEulerRotation rotateXYZValue (const unsigned int valIndex, MStatus *ReturnStatus=NULL)
 MFnManip3D (const MObject &object, MStatus *ret=NULL)
 Constructor.

Static Public Member Functions

static float globalSize ()
static void setGlobalSize (float size)
static float handleSize ()
static void setHandleSize (float size)
static float lineSize ()
static void setLineSize (float size)
static MStatus deleteManipulator (MObject &manip)

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

MFnManip3D::~MFnManip3D (  )  [virtual]

Destructor.

Class destructor.

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

MFnManip3D::MFnManip3D ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in] object The const MDagPath to attach the function set to
[out] ReturnStatus The return status
Status Codes:

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

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

bool MFnManip3D::isVisible ( MStatus ReturnStatus  )  const

Returns whether or not the manipulator is visible.

Parameters:
[out] ReturnStatus return status
Returns:
  • true the manipulator is visible
  • false the manipulator is not visible
Status Codes:

MStatus MFnManip3D::setVisible ( bool  isVisible  ) 

Sets whether or not the manipulator is visible.

Parameters:
[out] isVisible whether or not the manipulator is visible
Returns:

float MFnManip3D::manipScale ( MStatus ReturnStatus  )  const

Returns the manipulator scale.

Parameters:
[out] ReturnStatus return status
Returns:
The manipulator scale
Status Codes:

MStatus MFnManip3D::setManipScale ( float  size  ) 

Sets the manipulator scale.

Parameters:
[in] size the manipulator scale
Returns:

bool MFnManip3D::isOptimizePlaybackOn ( MStatus ReturnStatus  )  const

Returns whether or not optimize playback is on

Parameters:
[out] ReturnStatus return status
Returns:
  • true optimize playback is on
  • false optimize playback is off
Status Codes:

MStatus MFnManip3D::setOptimizePlayback ( bool  optimizePlayback  ) 

Sets whether or not to optimize the playback

Parameters:
[in] optimizePlayback whether or not to optimize the playback
Returns:

float MFnManip3D::globalSize (  )  [static]

Returns the global manipulator size.

Returns:
The global manipulator size

void MFnManip3D::setGlobalSize ( float  size  )  [static]

Sets the global manipulator size.

Parameters:
[in] size the global manipulator size

float MFnManip3D::handleSize (  )  [static]

Returns the manipulator handle size.

Returns:
The manipulator handle size

void MFnManip3D::setHandleSize ( float  size  )  [static]

Sets the manipulator handle size.

Parameters:
[in] size the manipulator handle size

float MFnManip3D::lineSize (  )  [static]

Returns the manipulator line size.

Returns:
The manipulator line size

void MFnManip3D::setLineSize ( float  size  )  [static]

Sets the manipulator line size.

Parameters:
[in] size the manipulator line size

MStatus MFnManip3D::deleteManipulator ( MObject manip  )  [static]

Delete a manipulator. This method should be used to delete manipulators that have been created using base manipulator create() methods.

Parameters:
[in] manip the manipulator to be deleted
Returns:

MEulerRotation MFnManip3D::rotateXYZValue ( const unsigned int  valIndex,
MStatus ReturnStatus = NULL 
)

Gets the rotation for the active manipulator.

Parameters:
[in] valIndex rotation index of the manipulator
Returns:
Rotate value of the active manip
Status Codes:


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