OpenMaya.MAngle Class Reference

Class Description

Manipulate angular data.

Constructors

Signature Parameters Description
MAngle()  

Default constructor. Returns a new MAngle with a value of 0.0 radians.

MAngle(src) src - MAngle

Copy constructor. Returns a new MAngle having the same value and unit as src.

MAngle(value, unit) value - Float
unit - Angular unit type constant

Returns a new MAngle having the specified value and unit.

 


+ Inheritance diagram for OpenMaya.MAngle:

Public Member Functions

__init__ ()
 
__repr__ ()
 
__str__ ()
 
asAngMinutes ()
 
asAngSeconds ()
 
asDegrees ()
 
asRadians ()
 
asUnits ()
 

Static Public Member Functions

internalToUI ()
 
internalUnit ()
 
setUIUnit ()
 
uiToInternal ()
 
uiUnit ()
 

Static Public Attributes

Angular Unit Types
int kAngMinutes = 3
 
int kAngSeconds = 4
 
int kDegrees = 2
 
int kInvalid = 0
 
int kLast = 5
 
int kRadians = 1
 

Properties

 unit
 
 value
 

Constructor & Destructor Documentation

OpenMaya.MAngle.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MAngle.__repr__ ( )
x.__repr__() <==> repr(x)
OpenMaya.MAngle.__str__ ( )
x.__str__() <==> str(x)
OpenMaya.MAngle.asAngMinutes ( )
Returns the angular value, converted to minutes of arc.
Signature: asAngMinutes()
Parameters:  
Returns: Float
Description: Returns the angular value converted to minutes of arc.
OpenMaya.MAngle.asAngSeconds ( )
Returns the angular value, converted to seconds of arc.
Signature: asAngSeconds()
Parameters:  
Returns: Float
Description: Returns the angular value converted to seconds of arc.
OpenMaya.MAngle.asDegrees ( )
Returns the angular value, converted to degrees.
Signature: asDegrees()
Parameters:  
Returns: Float
Description: Returns the angular value converted to degrees.
OpenMaya.MAngle.asRadians ( )
Returns the angular value, converted to radians.
Signature: asRadians()
Parameters:  
Returns: Float
Description: Returns the angular value converted to radians.
OpenMaya.MAngle.asUnits ( )
Returns the angular value, converted to the specified units.
Signature: asUnits(unit)
Parameters: unit - Angular unit type constant
Returns: Float
Description: Returns the angular value converted to the specified unit.
OpenMaya.MAngle.internalToUI ( )
static
Converts a value from Maya's internal units to the units used in the UI.
Name: internalToUI(internalValue)
Parameters: internalValue - Float
Returns: Float
Description: Interprets internalValue as an angular value in Maya's internal units and returns it converted to UI units.
OpenMaya.MAngle.internalUnit ( )
static
Returns the angular unit used internally by Maya.
Name: internalUnit()
Parameters:  
Returns: Angular unit type constant
Description: Returns the unit type used by Maya to store angular values internally (e.g. in plugs and binary files).
OpenMaya.MAngle.setUIUnit ( )
static
Sets the angular unit used in Maya's UI.
Name: setUIUnit(newUnit)
Parameters: newUnit - Angular unit type constant
Returns: None.
Description: Sets the units used by Maya's UI when entering and displaying angular values.
OpenMaya.MAngle.uiToInternal ( )
static
Converts a value from the units used in the UI to Maya's internal units.
Name: uiToInternal(uiValue)
Parameters: uiValue - Float
Returns: Float
Description: Interprets uiValue as an angular value in Maya's UI units and returns it converted to UI units.
OpenMaya.MAngle.uiUnit ( )
static
Returns the units used to display angles in Maya's UI.
Name: uiUnit()
Parameters:  
Returns: Angular unit type constant
Description: Returns the units currently used by Maya's UI when entering and displaying angular values.

Member Data Documentation

OpenMaya.MAngle.kAngMinutes = 3
static
Name: kAngMinutes
Type: Int
Description: Minutes of arc.
OpenMaya.MAngle.kAngSeconds = 4
static
Name: kAngSeconds
Type: Int
Description: Seconds of arc.
OpenMaya.MAngle.kDegrees = 2
static
Name: kDegrees
Type: Int
Description: Degrees.
OpenMaya.MAngle.kInvalid = 0
static
Name: kInvalid
Type: Int
Description:  
OpenMaya.MAngle.kLast = 5
static
Name: kLast
Type: Int
Description: Marker for end of angular type constants.
OpenMaya.MAngle.kRadians = 1
static
Name: kRadians
Type: Int
Description: Radians.

Property Documentation

OpenMaya.MAngle.unit
static
 Angular units used by the angle.
Name: unit
Type: Angular unit type constant
Access: RW
Description: Angulat units in which value is interpreted.
OpenMaya.MAngle.value
static
 Value of the angle.
Name: value
Type: Float
Access: RW
Description: Raw value of angle.