- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Examples

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions

# MFnDiscManip Class Reference
OpenMayaUI - API module for user interface | FunctionSet classes

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

Search for all occurrences

## Detailed Description

DiscManip function set.

The DiscManip allows the user to rotate a disc in order to specify a rotation about an axis. This manipulator generates a single floating point value corresponding to the rotation.

Examples:

  swissArmyManip.cpp.

`#include <MFnDiscManip.h>`

Inheritance diagram for MFnDiscManip:
[legend]

List of all members.

## Public Member Functions
virtual MFn::Type | type () const
| Function set type.
virtual | ~MFnDiscManip ()
| Destructor.
| MFnDiscManip ()
| Default constructor.
| MFnDiscManip (MObject &object, MStatus *ReturnStatus=NULL)
| Constructor.
| MFnDiscManip (const MDagPath &object, MStatus *ret=NULL)
| Constructor.
MObject | create (MStatus *ReturnStatus=NULL)
| Creates a new DiscManip.
MObject | create (const MString &manipName, const MString &angleName, MStatus *ReturnStatus=NULL)
| Creates a new DiscManip.
MStatus | connectToAnglePlug (MPlug &anglePlug)
| Connect to the angle plug.
MStatus | setCenterPoint (const MPoint &centerPoint)
| Sets the center point of the DiscManip.
MStatus | setNormal (const MVector &normal)
| Sets the normal of the DiscManip.
MStatus | setRadius (double radius)
| Sets the radius of the DiscManip.
MStatus | setAngle (MAngle angle)
| Sets the angle of the DiscManip.
unsigned int | centerIndex (MStatus *ReturnStatus=NULL) const
| Returns the index of the center of the DiscManip.
unsigned int | axisIndex (MStatus *ReturnStatus=NULL) const
| Returns the index of the axis of the DiscManip.
unsigned int | angleIndex (MStatus *ReturnStatus=NULL) const
| Returns the index of the angle.
| MFnDiscManip (const MObject &object, MStatus *ret=NULL)
| Constructor.
## Protected Member Functions
virtual const char * | className () const
| Class name.

## Constructor & Destructor Documentation

~MFnDiscManip | ( |  | ) | `[virtual]`

Destructor.

Class destructor.

MFnDiscManip | ( | 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

MFnDiscManip | ( | 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

MFnDiscManip | ( | 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 type | ( |  | ) | const`[virtual]`

Search for all occurrences

Function set type.

Return the class type : MFn::kDiscManip.

Reimplemented from MFnManip3D.

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

Search for all occurrences

Class name.

Return the class name : "MFnDiscManip".

Reimplemented from MFnManip3D.

MObject create | ( | MStatus * | ReturnStatus = `NULL` | ) |

Search for all occurrences

Creates a new DiscManip.

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

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

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

Parameters:

  [out] | ReturnStatus | return status

Returns:
  Newly created DiscManip

Status Codes:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MObject create | ( | const MString & | manipName,
|  | const MString & | angleName,
|  | MStatus * | ReturnStatus = `NULL`
| ) |  |

Search for all occurrences

Creates a new DiscManip.

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

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

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

Parameters:

  [in] | manipName | Name of the manip for UI purposes.
  [in] | angleName | Label for the angle value which appears in the feedback line.
  [out] | ReturnStatus | Status code.

Returns:
  Newly created DiscManip.

Status Codes:
  - MS::kSuccess Operation successful.
  - MS::kFailure Operation failed.

Reimplemented from MFnDependencyNode.

MStatus connectToAnglePlug | ( | MPlug & | anglePlug | ) |

Search for all occurrences

Connect to the angle plug.

The data type corresponding to the anglePlug is a double. (Note that MFnUnitAttribute::kAngle is used to specify an angle attribute.)

Parameters:

  [in] | anglePlug | the angle plug

Returns:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MStatus setCenterPoint | ( | const MPoint & | centerPoint | ) |

Search for all occurrences

Sets the center point of the DiscManip.

Parameters:

  [in] | centerPoint | the center point of the DiscManip

Returns:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MStatus setNormal | ( | const MVector & | normal | ) |

Search for all occurrences

Sets the normal of the DiscManip.

Parameters:

  [in] | normal | the normal of the DiscManip

Returns:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MStatus setRadius | ( | double | radius | ) |

Search for all occurrences

Sets the radius of the DiscManip.

Parameters:

  [in] | radius | the radius of the DiscManip

Returns:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MStatus setAngle | ( | MAngle | angle | ) |

Search for all occurrences

Sets the angle of the DiscManip.

Parameters:

  [in] | angle | the angle of the DiscManip

Returns:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

unsigned int centerIndex | ( | MStatus * | ReturnStatus = `NULL` | ) | const

Search for all occurrences

Returns the index of the center of the DiscManip.

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

Parameters:

  [out] | ReturnStatus | return status

Returns:
  Center index

Status Codes:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

unsigned int axisIndex | ( | MStatus * | ReturnStatus = `NULL` | ) | const

Search for all occurrences

Returns the index of the axis of the DiscManip.

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

Parameters:

  [out] | ReturnStatus | return status

Returns:
  Axis index

Status Codes:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

unsigned int angleIndex | ( | MStatus * | ReturnStatus = `NULL` | ) | const

Search for all occurrences

Returns the index of the angle.

The data type corresponding to this index is a double.

Parameters:

  [out] | ReturnStatus | return status

Returns:
  Angle index

Status Codes:
  - MS::kSuccess operation successful
  - MS::kFailure operation failed

MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip
MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip