|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.math.Vector2f
public class Vector2f
Defines a 2-element floating point vector.
Field Summary | ||
---|---|---|
static int |
ANIMATION_PROPERTY_X
Used to animate the x component. |
|
static int |
ANIMATION_PROPERTY_XY
Used to animate the x and y components. |
|
static int |
ANIMATION_PROPERTY_Y
Used to animate the y component. |
|
static Vector2f |
ONE
The 2-element vector of 1s. |
|
static Vector2f |
UNIT_X
The 2-element unit vector along the x axis. |
|
static Vector2f |
ZERO
The 2-element zero vector. |
|
float |
x
The x coordinate. |
|
float |
y
The y coordinate. |
Constructor Summary | ||
---|---|---|
Vector2f()
Constructs a new vector initialized to all zeros. |
||
Vector2f(float x,
float y)
Constructs a new vector initialized to the specified values. |
||
Vector2f(float[] array,
int offset)
Constructs a new vector from the values in the specified array. |
||
Vector2f(Vector2f v)
Constructs a new vector that is a copy of the specified vector. |
||
Vector2f(Vector2f p1,
Vector2f p2)
Constructs a vector that describes the direction between the specified points. |
Method Summary | ||
---|---|---|
void |
add(Vector2f v)
Adds the elements of the specified vector to this one. |
|
static void |
add(Vector2f v1,
Vector2f v2,
Vector2f dst)
Adds the specified vectors and stores the result in dst . |
|
static float |
angle(Vector2f v1,
Vector2f v2)
Returns the angle (in radians) between the specified vectors. |
|
void |
clamp(Vector2f min,
Vector2f max)
Clamps this vector within the specified range. |
|
static void |
clamp(Vector2f v,
Vector2f min,
Vector2f max,
Vector2f dst)
Clamps the specified vector within the specified range and returns it in dst . |
|
float |
distance(Vector2f v)
Returns the distance between this vector and v . |
|
float |
distanceSquared(Vector2f v)
Returns the squared distance between this vector and v . |
|
float |
dot(Vector2f v)
Returns the dot product of this vector and the specified vector. |
|
static float |
dot(Vector2f v1,
Vector2f v2)
Returns the dot product between the specified vectors. |
|
boolean |
equals(Object obj)
Determines if the specified object is of type Vector2f and all of its elements are equal to the elements of this Vector2f. |
|
boolean |
equals(Vector2f vector)
Returns true if all elements of the specified Vector2f are equal to the elements of this Vector2f. |
|
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. |
|
int |
hashCode()
Returns a hash code based on the elements of this vector. |
|
float |
length()
Computes the length of this vector. |
|
float |
lengthSquared()
Returns the squared length of this vector. |
|
void |
negate()
Negates this vector. |
|
void |
normalize()
Normalizes this vector. |
|
void |
normalize(Vector2f dst)
Normalizes this vector and stores the result in dst . |
|
void |
scale(float scalar)
Scales all elements of this vector by the specified value. |
|
void |
set(float x,
float y)
Sets the elements of this vector to the specified values. |
|
void |
set(float[] array,
int offset)
Sets the elements of this vector from the values in the specified array. |
|
void |
set(Vector2f v)
Sets the elements of this vector to those in the specified vector. |
|
void |
set(Vector2f p1,
Vector2f p2)
Sets this vector to the directional vector between the specified points. |
|
void |
setAnimationValue(int property,
AnimationValue value)
Sets the value or values of the specified property. |
|
void |
subtract(Vector2f v)
Subtracts this vector and the specified vector as (this - v)
and stores the result in this . |
|
static void |
subtract(Vector2f v1,
Vector2f v2,
Vector2f dst)
Subtracts the specified vectors and stores the result in dst . |
|
String |
toString()
Returns a String representation of the elements of this vector. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public float x
public float y
public static final int ANIMATION_PROPERTY_X
public static final int ANIMATION_PROPERTY_Y
public static final int ANIMATION_PROPERTY_XY
public static final Vector2f ONE
public static final Vector2f UNIT_X
public static final Vector2f ZERO
Constructor Detail |
---|
public Vector2f()
public Vector2f(float x, float y)
x
- The x coordinate.y
- The y coordinate.public Vector2f(float[] array, int offset)
array
- An array containing the elements of the vector in the order x, y.offset
- The offset into the array of the x
element.
IllegalArgumentException
- If offset
is less than zero or
offset + 1
is greater than or equal to array.length
.
NullPointerException
- If array
is null
.public Vector2f(Vector2f p1, Vector2f p2)
The new vector describes the direction vector from p1
to p2
,
computed as p2 - p1
.
p1
- The first point.p2
- The second point.
NullPointerException
- If p1
or p2
is null
.public Vector2f(Vector2f v)
v
- The vector to copy.
NullPointerException
- If v
is null
.Method Detail |
---|
public static float angle(Vector2f v1, Vector2f v2)
v1
- The first vector.v2
- The second vector.
NullPointerException
- If v1
or v2
is null
.public final void add(Vector2f v)
v
- The vector to add.
NullPointerException
- If v
is null
.public static void add(Vector2f v1, Vector2f v2, Vector2f dst)
dst
.
v1
- The first vector.v2
- The second vector.dst
- A vector to store the result in.
NullPointerException
- If v1
, v2
, or dst
is null
.public final void clamp(Vector2f min, Vector2f max)
min
- The minimum value.max
- The maximum value.
IllegalArgumentException
- If min
is greater than max
.
NullPointerException
- If min
or max
is null
.public static void clamp(Vector2f v, Vector2f min, Vector2f max, Vector2f dst)
dst
.
v
- The vector to clamp.min
- The minimum value.max
- The maximum value.dst
- A vector to store the result in.
IllegalArgumentException
- If min
is greater than max
.
NullPointerException
- If min
, max
, or dst
is null
.public final float distance(Vector2f v)
v
.
v
- The other vector.
v
.
NullPointerException
- If v
is null
.distanceSquared
public final float distanceSquared(Vector2f v)
v
.
When it is not neccessary to get the exact distance between two vectors
(for example, when simply comparing the distance between different vectors),
it is advised to use this method instead of distance
.
v
- The other vector.
v
.
NullPointerException
- If v
is null
.distance
public final float dot(Vector2f v)
v
- The vector to compute the dot product with.
NullPointerException
- If v
is null
.public static float dot(Vector2f v1, Vector2f v2)
v1
- The first vector.v2
- The second vector.
NullPointerException
- If v1
or v2
is null
.public final float length()
lengthSquared
public final float lengthSquared()
When it is not neccessary to get the exact length of a vector (for example,
when simply comparing the lengths of different vectors), it is advised to
use this method instead of length
.
length
public final void negate()
public final void normalize()
This method normalizes this Vector2f so that it is of unit length (in other words, the length of the vector after calling this method will be 1.0f). If the vector already has unit length or if the length of the vector is zero, this method does nothing.
public final void normalize(Vector2f dst)
dst
.
If the vector already has unit length or if the length of the vector
is zero, this method simply copies the current vector into dst
.
dst
- the destination vector
NullPointerException
- If dst
is null
.public final void scale(float scalar)
scalar
- The scalar value.public final void set(float x, float y)
x
- The new x coordinate.y
- The new y coordinate.public final void set(float[] array, int offset)
array
- An array containing the elements of the vector in the order x, y.offset
- The offset into the array of the x
element.
NullPointerException
- If array
is null
.
ArrayIndexOutOfBoundsException
- If offset
is less than zero or
offset + 1
is greater than or equal to array.length
.public final void set(Vector2f v)
v
- The vector to copy.
NullPointerException
- If v
is null
.public final void set(Vector2f p1, Vector2f p2)
This result of this vector describes the direction from p1
to p2
,
computed as p2 - p1
.
p1
- The first point.p2
- The second point.
NullPointerException
- If p1
or p2
is null
.public final void subtract(Vector2f v)
(this - v)
and stores the result in this
.
v
- The vector to subtract.
NullPointerException
- If v
is null
.public static void subtract(Vector2f v1, Vector2f v2, Vector2f dst)
dst
.
The resulting vector is computed as (v1 - v2)
.
v1
- The first vector.v2
- The second vector.dst
- The destination vector.
NullPointerException
- If v1
, v2
, or dst
is null
.public void getAnimationValue(int property, AnimationValue value)
Animatable
Gets the value or values of the specified property.
Used by the Animation framework to get the values of the specified property on the Animatable
.
The implementer must set the value of the specified target property in the AnimationValue
parameter.
getAnimationValue
in interface Animatable
property
- The property to get the current value or values of.value
- An AnimationValue
used to store the returned property values.Animatable.getAnimationValue(int,AnimationValue)
public void setAnimationValue(int property, AnimationValue value)
Animatable
Sets the value or values of the specified property.
Used by the Animation framework to update the value or values of the specified target property on the Animatable
with the currently calculated animation value. The implementer must update the current value or values of the given target property
with the values in the AnimationValue
parameter.
setAnimationValue
in interface Animatable
property
- The property to set the current value or values of.value
- The AnimationValue
used to specify the value or values to set.Animatable.setAnimationValue(int,AnimationValue)
public int getAnimationPropertyComponentCount(int property)
Animatable
Gets the number of components of the specified property.
The implementer must define the component size of every animatable property defined for theAnimatable
.
getAnimationPropertyComponentCount
in interface Animatable
property
- The property to retrieve the component count for.
Animatable.getAnimationPropertyComponentCount(int)
public boolean equals(Object obj)
equals
in class Object
obj
- The object to compare.
true
if this vector is equal to obj
;
false
otherwise.
NullPointerException
- If obj
is null
.Boolean.hashCode()
,
Hashtable
public boolean equals(Vector2f vector)
vector
- The vector to compare.
true
if this vector is equal to vector
;
false
otherwise.
NullPointerException
- If vector
is null
.public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.