#include <MAngle.h>
Manipulate Angular Data.
Methods for setting and retreiving angular data in various unit systems
The MAngle class provides a fundamental type for the Maya API to hold and manipulate angular data. All API methods that require or return angular information do so through variables of this type.
Public Types | |
enum | Unit { kInvalid, kRadians, kDegrees, kAngMinutes, kAngSeconds, kLast } |
Available Unit Systems. More... | |
Public Member Functions | |
MAngle () | |
Default constructor. More... | |
MAngle (const MAngle &src) | |
Copy constructor. More... | |
MAngle (double value, Unit u=kRadians) | |
Class constructor. More... | |
~MAngle () | |
Class destructor. | |
MAngle & | operator= (const MAngle &other) |
Assignment operator. More... | |
Unit | unit () const |
Current unit. More... | |
double | value () const |
Current value. More... | |
MStatus | setUnit (Unit newUnit) |
Set current unit. More... | |
MStatus | setValue (double newValue) |
Set current value. More... | |
double | as (Unit otherUnit, MStatus *ReturnStatus=NULL) const |
Unit conversion. More... | |
double | asUnits (Unit otherUnit, MStatus *ReturnStatus=NULL) const |
Unit conversion. More... | |
double | asRadians () const |
Convert to radians. More... | |
double | asDegrees () const |
Convert to degrees. More... | |
double | asAngMinutes () const |
Convert to minutes of arc. More... | |
double | asAngSeconds () const |
Convert to seconds of arc. More... | |
Static Public Member Functions | |
static Unit | uiUnit () |
Working unit. More... | |
static MStatus | setUIUnit (Unit newUnit) |
Set working unit. More... | |
static Unit | internalUnit () |
Internal unit. More... | |
static double | internalToUI (double internalValue) |
Unit conversion. More... | |
static double | uiToInternal (double uiValue) |
Unit conversion. More... | |
static const char * | className () |
Returns the name of this class. More... | |
static MStatus | setInternalUnit (Unit internalUnit) |
This method is obsolete. More... | |
enum Unit |
OPENMAYA_MAJOR_NAMESPACE_OPEN MAngle | ( | ) |
Default constructor.
Initialize the MAngle instance to 0 in the current internal units.
MAngle | ( | double | value, |
MAngle::Unit | unitSystem = kRadians |
||
) |
Class constructor.
Initialize the MAngle instance to the given value in the given unit system.
[in] | value | The initial value of the instance |
[in] | unitSystem | The unit system for the initial value |
MAngle::Unit unit | ( | ) | const |
Current unit.
Return the units currently in effect for this instance.
double value | ( | ) | const |
Current value.
Return the value of the current instance in the currently set units.
MStatus setUnit | ( | MAngle::Unit | newUnit | ) |
Set current unit.
Set the unit used by this instance. This will not affect the current value of the MAngle.
[in] | newUnit | An element of the MAngle::Unit enum |
MStatus setValue | ( | double | newValue | ) |
Set current value.
Set the value of this instance.
[in] | newValue | The new value in the units currently in effect |
double as | ( | MAngle::Unit | otherUnit, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Unit conversion.
Return the current value of this instance in the provided units.
[in] | otherUnit | An element of the MAngle::Unit enum specifying the desired units |
[out] | ReturnStatus | Return status |
double asUnits | ( | MAngle::Unit | otherUnit, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Unit conversion.
Return the current value of this instance in the provided units.
[in] | otherUnit | An element of the MAngle::Unit enum specifying the desired units |
[out] | ReturnStatus | Return status |
double asRadians | ( | ) | const |
Convert to radians.
Return the current value of this instance in radians.
double asDegrees | ( | ) | const |
Convert to degrees.
Return the current value of this instance in degrees.
double asAngMinutes | ( | ) | const |
Convert to minutes of arc.
Return the current value of this instance in minutes of arc.
double asAngSeconds | ( | ) | const |
Convert to seconds of arc.
Return the current value of this instance in seconds of arc.
|
static |
Working unit.
Returns the Working Units (or UI units) chosen in the settings of the prefs window.
|
static |
Set working unit.
Set the unit system to be used by the user in the UI. This will not change the return value of the MAngle::value() method of this instance of MAngle.
[in] | newUnit | and element of the MAngle::Unit enum. |
|
static |
Internal unit.
Returns the internal unit system used by Maya. This is the unit system Maya stores angles in.
|
static |
Unit conversion.
Converts a value from Maya's internal units to the current units used in the UI.
[in] | internalValue | a value in internal units |
|
static |
Unit conversion.
Converts a value from the units Maya is currently uses in the UI to the Maya internal unit system.
[in] | uiValue | a value in UI units |
|
static |
Returns the name of this class.
|
static |
This method is obsolete.
Sets the internal unit system which Maya uses to store angles.
[in] | internalUnit | the internal unit for angles |