Public Member Functions | Protected Member Functions

MFnToggleManip 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

ToggleManip function set.

The ToggleManip allows the user to switch between two modes or some on/off state. It is drawn as a circle with or without a dot. When the mode is on, the dot is drawn in the circle; when the mode is off, the circle is drawn without the dot. This manipulator generates a boolean value corresponding to whether or not the mode is on or off.

Examples:

swissArmyManip.cpp.

#include <MFnToggleManip.h>

Inheritance diagram for MFnToggleManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnToggleManip ()
 Destructor.
 MFnToggleManip ()
 Default constructor.
 MFnToggleManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnToggleManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new ToggleManip.
MObject create (const MString &manipName, const MString &toggleName, MStatus *ReturnStatus=NULL)
 Creates a new ToggleManip.
MStatus connectToTogglePlug (MPlug &togglePlug)
 Connect to the toggle plug.
MPoint startPoint (MStatus *ReturnStatus=NULL) const
 Returns the start point.
MVector direction (MStatus *ReturnStatus=NULL) const
 Returns the direction.
double length (MStatus *ReturnStatus=NULL) const
 Returns the length.
bool toggle (MStatus *ReturnStatus=NULL) const
 Returns the toggle.
unsigned int startPointIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the start point of the ToggleManip.
unsigned int directionIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the direction.
unsigned int lengthIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the length of the ToggleManip.
unsigned int toggleIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the toggle of the ToggleManip.
MStatus setStartPoint (MPoint &startPoint)
 Sets the start point of the ToggleManip.
MStatus setDirection (MVector &direction)
 Sets the direction of the ToggleManip.
MStatus setLength (double length)
 Sets the length of the ToggleManip.
MStatus setToggle (bool toggle)
 Sets the toggle of the ToggleManip.
 MFnToggleManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnToggleManip ( ) [virtual]

Destructor.

Class destructor.

MFnToggleManip ( 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:
MFnToggleManip ( 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:
MFnToggleManip ( 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]

Function set type.

Return the class type : MFn::kToggleManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnToggleManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new ToggleManip.

This function set's object is set to be the new manipulator.

This method should only be used to create a non-composite ToggleManip.

The name that appears in the feedback line is "toggle"

Parameters:
[out]ReturnStatusreturn status
Returns:
Newly created ToggleManip
Status Codes:
MObject create ( const MString manipName,
const MString toggleName,
MStatus ReturnStatus = NULL 
)

Creates a new ToggleManip.

This function set's object is set to be the new manipulator.

This method should only be used to create a non-composite ToggleManip.

The name that appears in the feedback line is specified by the toggleName argument.

Parameters:
[in]manipNameName of the manip for UI purposes.
[in]toggleNameLabel for the toggle value which appears in the feedback line.
[out]ReturnStatusStatus code.
Returns:
Newly created ToggleManip.
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus connectToTogglePlug ( MPlug togglePlug)

Connect to the toggle plug.

The data type corresponding to the togglePlug is a boolean value.

Parameters:
[in]togglePlugthe toggle plug
Returns:
MPoint startPoint ( MStatus ReturnStatus = NULL) const

Returns the start point.

Parameters:
[out]ReturnStatusreturn status
Returns:
The start point
Status Codes:
MVector direction ( MStatus ReturnStatus = NULL) const

Returns the direction.

Parameters:
[out]ReturnStatusreturn status
Returns:
The direction
Status Codes:
double length ( MStatus ReturnStatus = NULL) const

Returns the length.

Parameters:
[out]ReturnStatusreturn status
Returns:
Length
Status Codes:
bool toggle ( MStatus ReturnStatus = NULL) const

Returns the toggle.

Parameters:
[out]ReturnStatusreturn status
Returns:
Toggle
Status Codes:
unsigned int startPointIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the start point of the ToggleManip.

The data type corresponding to this index is MFnNumericData::k3Double.

Parameters:
[out]ReturnStatusreturn status
Returns:
Start point index
Status Codes:
unsigned int directionIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the direction.

The data type corresponding to this index is MFnNumericData::k3Double.

Parameters:
[out]ReturnStatusreturn status
Returns:
Direction index
Status Codes:
unsigned int lengthIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the length of the ToggleManip.

The data type corresponding to this index is a double.

Parameters:
[out]ReturnStatusreturn status
Returns:
Length index
Status Codes:
unsigned int toggleIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the toggle of the ToggleManip.

The data type corresponding to this index is a boolean.

Parameters:
[out]ReturnStatusreturn status
Returns:
Toggle index
Status Codes:
MStatus setStartPoint ( MPoint startPoint)

Sets the start point of the ToggleManip.

Parameters:
[in]startPointthe start point of the ToggleManip
Returns:
MStatus setDirection ( MVector direction)

Sets the direction of the ToggleManip.

Parameters:
[in]directionthe direction of the ToggleManip
Returns:
MStatus setLength ( double  length)

Sets the length of the ToggleManip.

Parameters:
[in]lengththe length of the ToggleManip
Returns:
MStatus setToggle ( bool  toggle)

Sets the toggle of the ToggleManip.

Parameters:
[in]togglethe toggle of the ToggleManip
Returns:

MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip
MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip MFnToggleManip