Home       Trees       Index       Help   

Blender

Module Mathutils :: Class Quaternion
[frames | no frames]

Class Quaternion

The Quaternion object

This object gives access to Quaternions in Blender.

Attention: Quaternion data can be wrapped or non-wrapped. When a object is wrapped it means that the object will give you direct access to the data inside of blender. Modification of this object will directly change the data inside of blender. To copy a wrapped object you need to use the object's constructor. If you copy and object by assignment you will not get a second copy but a second reference to the same data. Only certain functions will return wrapped data. This will be indicated in the method description. Example: 

   wrappedObject = Object.getAttribute() #this is wrapped data
   print wrappedObject.wrapped #prints 'True'
   copyOfObject = Object(wrappedObject) #creates a copy of the object
   secondPointer = wrappedObject #creates a second pointer to the same data
   print wrappedObject.attribute #prints '5'
   secondPointer.attribute = 10
   print wrappedObject.attribute #prints '10'
   print copyOfObject.attribute #prints '5'

Notes:

Method Summary
New quaternion object. __init__(list, angle)
Create a new quaternion object from initialized values.
  conjugate()
Set the quaternion to its conjugate.
  identity()
Set the quaternion to the identity quaternion.
  inverse()
Set the quaternion to its inverse
  negate()
Set the quaternion to its negative.
  normalize()
Normalize the quaternion.
Euler object toEuler()
Return Euler representation of the quaternion.
Matrix object toMatrix()
Return a matrix representation of the quaternion.

Instance Variable Summary
  angle: A scalar representing the amount of rotation in degrees.
  axis: Vector representing the axis of rotation.
  magnitude: The magnitude of the quaternion.
  w: The w value.
  wrapped: Wether or not this object wraps data directly
  x: The x value.
  y: The y value.
  z: The z value.

Method Details

__init__(list, angle=None)
(Constructor)

Create a new quaternion object from initialized values.

Example: 
 quat = Quaternion(1,2,3,4)
 quat = Quaternion(axis, angle)
quat = Quaternion() quat = Quaternion(180, list)
Parameters:
list - A 3d or 4d list to initialize quaternion. 4d if intializing [w,x,y,z], 3d if used as an axis of rotation.
           (type=PyList of int/float)
angle - An arbitrary rotation amount around 'list'. List is used as an axis of rotation in this case.
           (type=float (optional))
Returns:
It depends wheter a parameter was passed:
  • (list/angle): Quaternion object initialized with the given values;
  • (): An identity 4 dimensional quaternion.

           (type=New quaternion object.)

conjugate()

Set the quaternion to its conjugate.
Returns:
a copy of itself

identity()

Set the quaternion to the identity quaternion.
Returns:
a copy of itself

inverse()

Set the quaternion to its inverse
Returns:
a copy of itself

negate()

Set the quaternion to its negative.
Returns:
a copy of itself

normalize()

Normalize the quaternion.
Returns:
a copy of itself

toEuler()

Return Euler representation of the quaternion.
Returns:
Euler representation of the quaternion.
           (type=Euler object)

toMatrix()

Return a matrix representation of the quaternion.
Returns:
A rotation matrix representation of the quaternion.
           (type=Matrix object)

Instance Variable Details

angle

A scalar representing the amount of rotation in degrees.

axis

Vector representing the axis of rotation.

magnitude

The magnitude of the quaternion.

w

The w value.

wrapped

Wether or not this object wraps data directly

x

The x value.

y

The y value.

z

The z value.

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Thu Dec 22 22:38:14 2005 http://epydoc.sf.net