Transform2D (BlackBerry JDE 6.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.math
Class Transform2D

java.lang.Object
  net.rim.device.api.math.Transform2D

All Implemented Interfaces:: Animatable

public class Transform2D
extends Object
implements Animatable
extends Object
implements Animatable

Defines a 2-dimensional transformation.

Note: When using the scale, shear, rotate, and translate methods, only the transform's corresponding scale, shear, rotation, or translation component is updated (it is not as if the scale, shear, rotate, or translate is applied to the transform's matrix).

For example, if the user calls t.rotate(angle), this updates t's internal rotation component by rotating it counter-clockwise by angle radians. The following code demonstrates this more clearly:

   // Create a non-identity transform and get a copy of its matrix.
   Transform2D t1 = new Transform2D(new Vector2f(1.2f, 1.7f), new Vector2f(), 0.0f, new Vector2f(10.0f, -2.0f));
   Matrix3f t2 = new Matrix3f(t1.getMatrix());

   // Rotate the transform's rotation component by 35 degrees (counter-clockwise) and get the new matrix.
   t1.rotate((float)Math.toRadians(35.0f));
   Matrix3f t1Matrix = t1.getMatrix();
   
   // Multiply t1's original matrix by a matrix representing the same rotation as above.
   Matrix3f rotate = new Matrix3f();
   Matrix3f.createRotation((float)Math.toRadians(35.0f), rotate);
   t2.multiply(rotate);
   
   // At this point, t1Matrix is not equal to t2!
   if (t1Matrix.equals(t2))
       throw new RuntimeException();

Note: To construct a Transform2D from a transformation matrix stored as a Matrix3f, first decompose the Matrix3f into its separate translation, scale, shear, and rotation components using Matrix3f.decompose(Vector2f, Vector2f, Matrix3f, Vector2f) and then pass those arguments to the appropriate constructor or set methods of Transform2D.

See Also:: Matrix3f.decompose(Vector2f, Vector2f, Matrix3f, Vector2f)
Since:: BlackBerry API 6.0.0

Field Summary
`static int`	`ANIMATION_PROPERTY_ROTATE` Used to animate the rotation component.
`static int`	`ANIMATION_PROPERTY_SCALE` Used to animate the scale component.
`static int`	`ANIMATION_PROPERTY_SHEAR` Used to animate the shear component.
`static int`	`ANIMATION_PROPERTY_TRANSFORM` Used to animate the all components.
`static int`	`ANIMATION_PROPERTY_TRANSLATE` Used to animate the translation component.
`static int`	`ANIMATION_PROPERTY_TRANSLATE_ROTATE` Used to animate the translation-rotation component.

Constructor Summary
`Transform2D()` Constructs the identity transform.
`Transform2D(Transform2D transform)` Constructs a new transform from the given transform.
`Transform2D(Vector2f scale, Vector2f shear, float rotation, Vector2f translation)` Constructs a new transform from the specified values.

Method Summary
`boolean`	`equals(Object obj)` Determines if the specified object is of type Transform2D and all of its elements are equal to the elements of this transform.
`boolean`	`equals(Transform2D transform)` Returns true if all elements of the specified transform are equal to the elements of this transform.
`int`	`getAnimationPropertyComponentCount(int property)` Gets the number of components of the specified property.
`void`	`getAnimationValue(int property, AnimationValue value)` Gets the value or values of the specified property.
`Matrix3f`	`getMatrix()` Gets the matrix corresponding to this transform.
`void`	`getMatrix(Matrix3f matrix)` Gets the matrix corresponding to the transform in the specified matrix.
`float`	`getRotation()` Gets the orientation angle of this transform.
`void`	`getScale(Vector2f scale)` Gets the scale component of this transform in the specified vector.
`void`	`getShear(Vector2f shear)` Gets the shear component of this transform in the specified vector.
`void`	`getTranslation(Vector2f translation)` Gets the translation component of this transform in the specified vector.
`int`	`hashCode()` Returns a hash code based on the elements of this transform.
`void`	`rotate(float angle)` Rotates this transform by the given rotation defined as an angle about the origin.
`void`	`rotate(float angle, Transform2D dst)` Rotates this transform by the given rotation defined as an angle about the origin and stores the result in the given destination transform.
`void`	`scale(float scale)` Scales this transform's scale component by the given factor along all axes.
`void`	`scale(float sx, float sy)` Scales this transform's scale component by the given factors along each axis.
`void`	`scale(float sx, float sy, Transform2D dst)` Scales this transform's scale component by the given factors along each axis and stores the result in the given destination transform.
`void`	`scale(float scale, Transform2D dst)` Scales this transform's scale component by the given factor along all axes and stores the result in the given destination transform.
`void`	`scale(Vector2f scale)` Scales this transform's scale component by the given scale vector.
`void`	`scale(Vector2f scale, Transform2D dst)` Scales this transform's scale component by the given scale vector and stores the result in the given destination transform.
`void`	`scaleX(float sx)` Scales this transform's scale component by the given scale factor along the x axis.
`void`	`scaleX(float sx, Transform2D dst)` Scales this transform's scale component by the given scale factor along the x axis and stores the result in the given destination transform.
`void`	`scaleY(float sy)` Scales this transform's scale component by the given scale factor along the y axis.
`void`	`scaleY(float sy, Transform2D dst)` Scales this transform's scale component by the given scale factor along the y axis and stores the result in the given destination transform.
`void`	`set(Transform2D transform)` Sets this transform to the specified transform.
`void`	`set(Vector2f scale, Vector2f shear, float rotation, Vector2f translation)` Sets the transform to the specified values.
`void`	`setAnimationValue(int property, AnimationValue value)` Sets the value or values of the specified property.
`void`	`setRotation(float angle)` Sets the orientation angle of this transform to the specified values.
`void`	`setScale(float scale)` Sets the scale factor along all axes for this transform to the specified value.
`void`	`setScale(float sx, float sy)` Sets the scale component of this transform to the specified values.
`void`	`setScale(Vector2f scale)` Sets the scale component of this transform to the specified scale vector.
`void`	`setShear(float shear)` Sets the shear factor along all axes for this transform to the specified value.
`void`	`setShear(float shx, float shy)` Sets the shear component of this transform to the specified values.
`void`	`setShear(Vector2f shear)` Sets the shear component of this transform to the specified vector.
`void`	`setTranslation(float tx, float ty)` Sets the translation component for this transform to the specified values.
`void`	`setTranslation(Vector2f translation)` Sets the translation component for this transform to the specified translation vector.
`void`	`shear(float shear)` Shears this transform's shear component by the given shear factor along both axes.
`void`	`shear(float shx, float shy)` Shears this transform's shear component by the given factors along each axis.
`void`	`shear(float shx, float shy, Transform2D dst)` Shears this transform's shear component by the given factors along each axis and stores the result in the given destination transform.
`void`	`shear(float shear, Transform2D dst)` Shears this transform's shear component by the given shear factor along both axes and stores the result in the given destination transform.
`void`	`shear(Vector2f shear)` Shears this transform's shear component by the given shear vector.
`void`	`shear(Vector2f shear, Transform2D dst)` Shears this transform's shear component by the given shear vector and stores the result in the given destination transform.
`void`	`shearX(float shx)` Shears this transform's shear component by the given factor along the x-axis.
`void`	`shearX(float shx, Transform2D dst)` Shears this transform's shear component by the given factor along the x-axis and stores the result in the given destination transform.
`void`	`shearY(float shy)` Shears this transform's shear component by the given factor along the y-axis.
`void`	`shearY(float shy, Transform2D dst)` Shears this transform's shear component by the given factor along the y-axis and stores the result in the given destination transform.
`String`	`toString()` Returns a String representation of this transform.
`void`	`transformPoint(Vector2f point)` Transforms the specified point and stores the result in the original point.
`void`	`transformPoint(Vector2f point, Vector2f dst)` Transforms the specified point and stores the result in the specified destination point.
`void`	`transformVector(Vector2f vector)` Transforms the specified vector and stores the result in the original vector.
`void`	`transformVector(Vector2f vector, Vector2f dst)` Transforms the specified vector and stores the result in the specified destination vector.
`void`	`translate(float tx, float ty)` Translates this transform's translation component by the given values along each axis.
`void`	`translate(float tx, float ty, Transform2D dst)` Translates this transform's translation component by the given values along each axis and stores the result in the given destination transform.
`void`	`translate(Vector2f translation)` Translates this transform's translation component by the given translation vector.
`void`	`translate(Vector2f translation, Transform2D dst)` Translates this transform's translation component by the given translation vector and stores the result in the given destination transform.
`void`	`translateX(float tx)` Translates this transform's translation component by the given value along the x axis.
`void`	`translateX(float tx, Transform2D dst)` Translates this transform's translation component by the given value along the x axis and stores the result in the given destination transform.
`void`	`translateY(float ty)` Translates this transform's translation component by the given value along the y axis.
`void`	`translateY(float ty, Transform2D dst)` Translates this transform's translation component by the given value along the y axis and stores the result in the given destination transform.

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Field Detail