MFnToggleManip Class Reference
[OpenMayaUI - API module for user interface, FunctionSet classes]

#include <MFnToggleManip.h>

Inheritance diagram for MFnToggleManip:

[legend]

Collaboration diagram for MFnToggleManip:

[legend]

List of all members.

---

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.

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)
MObject	create (const MString &manipName, const MString &toggleName, MStatus *ReturnStatus=NULL)
MStatus	connectToTogglePlug (MPlug &togglePlug)
MPoint	startPoint (MStatus *ReturnStatus=NULL) const
MVector	direction (MStatus *ReturnStatus=NULL) const
double	length (MStatus *ReturnStatus=NULL) const
bool	toggle (MStatus *ReturnStatus=NULL) const
unsigned int	startPointIndex (MStatus *ReturnStatus=NULL) const
unsigned int	directionIndex (MStatus *ReturnStatus=NULL) const
unsigned int	lengthIndex (MStatus *ReturnStatus=NULL) const
unsigned int	toggleIndex (MStatus *ReturnStatus=NULL) const
MStatus	setStartPoint (MPoint &startPoint)
MStatus	setDirection (MVector &direction)
MStatus	setLength (double length)
MStatus	setToggle (bool toggle)
	MFnToggleManip (const MObject &object, MStatus *ret=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnToggleManip::~MFnToggleManip

(

)

[virtual]

Destructor.

Class destructor.

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

• 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

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

• 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

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

• 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

---

Member Function Documentation

MFn::Type MFnToggleManip::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kToggleManip

Reimplemented from MFnManip3D.

const char * MFnToggleManip::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnToggleManip"

Reimplemented from MFnManip3D.

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

ReturnStatus

return status

Returns:

Newly created ToggleManip

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MObject MFnToggleManip::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]	toggleName	the name that appears in the feedback line
[out]	ReturnStatus	return status

Returns:

Newly created ToggleManip

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

Reimplemented from MFnDependencyNode.

MStatus MFnToggleManip::connectToTogglePlug

(

MPlug &

togglePlug

)

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

Parameters:

[in]

togglePlug

the toggle plug

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MPoint MFnToggleManip::startPoint

(

MStatus *

ReturnStatus = NULL

)

const

Returns the start point.

Parameters:

[out]

ReturnStatus

return status

Returns:

The start point

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MVector MFnToggleManip::direction

(

MStatus *

ReturnStatus = NULL

)

const

Returns the direction.

Parameters:

[out]

ReturnStatus

return status

Returns:

The direction

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

double MFnToggleManip::length

(

MStatus *

ReturnStatus = NULL

)

const

Returns the length.

Parameters:

[out]

ReturnStatus

return status

Returns:

Length

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MFnToggleManip::toggle

(

MStatus *

ReturnStatus = NULL

)

const

Returns the toggle.

Parameters:

[out]

ReturnStatus

return status

Returns:

Toggle

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnToggleManip::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]

ReturnStatus

return status

Returns:

Start point index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnToggleManip::directionIndex

(

MStatus *

ReturnStatus = NULL

)

const

Returns the index of the direction. The data type corresponding to this index is MFnNumericData::k3Double.

Parameters:

[out]

ReturnStatus

return status

Returns:

Direction index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnToggleManip::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]

ReturnStatus

return status

Returns:

Length index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnToggleManip::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]

ReturnStatus

return status

Returns:

Toggle index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnToggleManip::setStartPoint

(

MPoint &

startPoint

)

Sets the start point of the ToggleManip.

Parameters:

[in]

startPoint

the start point of the ToggleManip

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnToggleManip::setDirection

(

MVector &

direction

)

Sets the direction of the ToggleManip.

Parameters:

[in]

direction

the direction of the ToggleManip

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnToggleManip::setLength

(

double

length

)

Sets the length of the ToggleManip.

Parameters:

[in]

length

the length of the ToggleManip

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnToggleManip::setToggle

(

bool

toggle

)

Sets the toggle of the ToggleManip.

Parameters:

[in]

toggle

the toggle of the ToggleManip

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed