Public Member Functions | Static Public Member Functions | Protected Member Functions

MFnManip3D Class Reference

This reference page is linked to from the following overview topics: Base Manipulators, Communication Between Manipulators and Nodes.


Search for all occurrences

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.

#include <MFnManip3D.h>

Inheritance diagram for MFnManip3D:
Inheritance graph
[legend]

List of all members.

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
 Returns whether or not the manipulator is visible.
MStatus setVisible (bool isVisible)
 Sets whether or not the manipulator is visible.
float manipScale (MStatus *ReturnStatus) const
 Returns the manipulator scale.
MStatus setManipScale (float size)
 Sets the manipulator scale.
bool isOptimizePlaybackOn (MStatus *ReturnStatus) const
 Returns whether or not optimize playback is on.
MStatus setOptimizePlayback (bool optimizePlayback)
 Sets whether or not to optimize the playback.
MEulerRotation rotateXYZValue (const unsigned int valIndex, MStatus *ReturnStatus=NULL)
 Gets the rotation for the active manipulator.
 MFnManip3D (const MObject &object, MStatus *ret=NULL)
 Constructor.

Static Public Member Functions

static float globalSize ()
 Returns the global manipulator size.
static void setGlobalSize (float size)
 Sets the global manipulator size.
static float handleSize ()
 Returns the manipulator handle size.
static void setHandleSize (float size)
 Sets the manipulator handle size.
static float lineSize ()
 Returns the manipulator line size.
static void setLineSize (float size)
 Sets the manipulator line size.
static MStatus deleteManipulator (MObject &manip)
 Delete a manipulator.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnManip3D ( ) [virtual]

Destructor.

Class destructor.

MFnManip3D ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnManip3D ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnManip3D ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]
const char * className ( ) const [protected, virtual]
bool isVisible ( MStatus ReturnStatus) const

Returns whether or not the manipulator is visible.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the manipulator is visible
  • false the manipulator is not visible
Status Codes:
MStatus setVisible ( bool  isVisible)

Sets whether or not the manipulator is visible.

Parameters:
[out]isVisiblewhether or not the manipulator is visible
Returns:
float manipScale ( MStatus ReturnStatus) const

Returns the manipulator scale.

Parameters:
[out]ReturnStatusreturn status
Returns:
The manipulator scale
Status Codes:
MStatus setManipScale ( float  size)

Sets the manipulator scale.

Parameters:
[in]sizethe manipulator scale
Returns:
bool isOptimizePlaybackOn ( MStatus ReturnStatus) const

Returns whether or not optimize playback is on.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true optimize playback is on
  • false optimize playback is off
Status Codes:
MStatus setOptimizePlayback ( bool  optimizePlayback)

Sets whether or not to optimize the playback.

Parameters:
[in]optimizePlaybackwhether or not to optimize the playback
Returns:
float globalSize ( ) [static]

Returns the global manipulator size.

Returns:
The global manipulator size
void setGlobalSize ( float  size) [static]

Sets the global manipulator size.

Parameters:
[in]sizethe global manipulator size
float handleSize ( ) [static]

Returns the manipulator handle size.

Returns:
The manipulator handle size
void setHandleSize ( float  size) [static]

Sets the manipulator handle size.

Parameters:
[in]sizethe manipulator handle size
float lineSize ( ) [static]

Returns the manipulator line size.

Returns:
The manipulator line size
void setLineSize ( float  size) [static]

Sets the manipulator line size.

Parameters:
[in]sizethe manipulator line size
MStatus 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]manipthe manipulator to be deleted
Returns:
MEulerRotation rotateXYZValue ( const unsigned int  valIndex,
MStatus ReturnStatus = NULL 
)

Gets the rotation for the active manipulator.

Parameters:
[in]valIndexrotation index of the manipulator
[out]ReturnStatusreturn status
Returns:
Rotate value of the active manip
Status Codes:

MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D
MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D MFnManip3D