程序包 ohos.agp.render.render3d.math

类 Quaternion

java.lang.Object

ohos.agp.render.render3d.math.Quaternion

public class Quaternion
extends Object

Represents the quaternion in mathematics.

从以下版本开始:

3

字段概要

字段

限定符和类型	字段	说明
static Quaternion	IDENTITY	Indicates a quaternion whose components are all 1.
static Quaternion	ZERO	Indicates a quaternion whose components are all 0.

构造器概要

构造器

构造器	说明
Quaternion(float[] data, int offset)	Creates a quaternion from a one-dimensional float array.
Quaternion(float quatX, float quatY, float quatZ, float quatW)	Creates a quaternion.

方法概要

限定符和类型	方法	说明
static Quaternion	add(Quaternion lhs, float rhs)	Adds a float value to each component of a quaternion.
static Quaternion	add(Quaternion lhs, Quaternion rhs)	Adds two quaternions.
static Quaternion	angleAxis(float angleRadians, Vector3 axis)	Creates a quaternion by specifying the rotation angle and axis.
static Quaternion	conjugate(float quatX, float quatY, float quatZ, float quatW)	Conjugates a quaternion based on its components.
static float	dot(Quaternion lhs, Quaternion rhs)	Calculates the dot product of two quaternions.
boolean	equals(Object other)	Indicates whether some other object is "equal to" this one.
Quaternion	getConjugate()	Obtains a conjugated quaternion.
float	getLength()	Obtains the length of a quaternion.
float	getLengthSquared()	Obtains the squared length of a quaternion.
Quaternion	getNormalized()	Obtains a normalized quaternion.
float	getW()	Obtains component W of a quaternion.
float	getX()	Obtains component X of a quaternion.
float	getY()	Obtains component Y of a quaternion.
float	getZ()	Obtains component Z of a quaternion.
int	hashCode()	Returns a hash code value for the object.
static float	length(float quatX, float quatY, float quatZ, float quatW)	Calculates the length of a quaternion based on its components.
static float	lengthSquared(float quatX, float quatY, float quatZ, float quatW)	Calculates the squared length of a quaternion based on its components.
static Quaternion	multiply(Quaternion lhs, float rhs)	Multiplies each component of a quaternion by a float value.
static Quaternion	multiply(Quaternion lhs, Quaternion rhs)	Multiplies two quaternions.
static Quaternion	normalize(float quatX, float quatY, float quatZ, float quatW)	Normalizes a quaternion based on its components.
Vector3	rotatePoint(Vector3 vector)	Rotates a given vector to obtain a new vector.
static Quaternion	slerp(Quaternion lhs, Quaternion rhs, float value)	Performs spherical linear interpolation between two quaternions.
static Quaternion	subtract(Quaternion lhs, float rhs)	Subtracts a float value from each component of a quaternion.
static Quaternion	subtract(Quaternion lhs, Quaternion rhs)	Subtracts each component of a quaternion from that of another quaternion.
String	toString()	Returns a string representation of the object.

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

IDENTITY

public static final Quaternion IDENTITY

Indicates a quaternion whose components are all 1.

ZERO

public static final Quaternion ZERO

Indicates a quaternion whose components are all 0.

构造器详细资料

Quaternion

public Quaternion(float[] data,
                  int offset)

Creates a quaternion from a one-dimensional float array.

参数:

data - Indicates the float array.

offset - Indicates the array offset, from which data copying starts.

Quaternion

public Quaternion(float quatX,
                  float quatY,
                  float quatZ,
                  float quatW)

Creates a quaternion.

参数:

quatX - Indicates component X.

quatY - Indicates component Y.

quatZ - Indicates component Z.

quatW - Indicates component W.

方法详细资料

add

public static Quaternion add(Quaternion lhs,
                             Quaternion rhs)

Adds two quaternions.

This method adds each component of a quaternion to that of another quaternion.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

add

public static Quaternion add(Quaternion lhs,
                             float rhs)

Adds a float value to each component of a quaternion.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

subtract

public static Quaternion subtract(Quaternion lhs,
                                  Quaternion rhs)

Subtracts each component of a quaternion from that of another quaternion.

参数:

lhs - Indicates the left-hand-side quaternion.

rhs - Indicates the right-hand-side quaternion.

返回:

Returns the calculation result.

subtract

public static Quaternion subtract(Quaternion lhs,
                                  float rhs)

Subtracts a float value from each component of a quaternion.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

multiply

public static Quaternion multiply(Quaternion lhs,
                                  Quaternion rhs)

Multiplies two quaternions.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

multiply

public static Quaternion multiply(Quaternion lhs,
                                  float rhs)

Multiplies each component of a quaternion by a float value.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

dot

public static float dot(Quaternion lhs,
                        Quaternion rhs)

Calculates the dot product of two quaternions.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

返回:

Returns the calculation result.

angleAxis

public static Quaternion angleAxis(float angleRadians,
                                   Vector3 axis)

Creates a quaternion by specifying the rotation angle and axis.

参数:

angleRadians - Indicates the angle to rotate the quaternion.

axis - Indicates the axis based on which to rotate the quaternion.

返回:

Returns the obtained quaternion.

length

public static float length(float quatX,
                           float quatY,
                           float quatZ,
                           float quatW)

Calculates the length of a quaternion based on its components.

参数:

quatX - Indicates component X.

quatY - Indicates component Y.

quatZ - Indicates component Z.

quatW - Indicates component W.

返回:

Returns the length of the quaternion.

lengthSquared

public static float lengthSquared(float quatX,
                                  float quatY,
                                  float quatZ,
                                  float quatW)

Calculates the squared length of a quaternion based on its components. This calculation is faster than calculating the length of a quaternion because it does not require a square root.

参数:

quatX - Indicates component X.

quatY - Indicates component Y.

quatZ - Indicates component Z.

quatW - Indicates component W.

返回:

Returns the squared length of the quaternion.

normalize

public static Quaternion normalize(float quatX,
                                   float quatY,
                                   float quatZ,
                                   float quatW)

Normalizes a quaternion based on its components.

参数:

quatX - Indicates component X.

quatY - Indicates component Y.

quatZ - Indicates component Z.

quatW - Indicates component W.

返回:

Returns the normalized quaternion if the length of the quaternion is a finite number;returns IDENTITY otherwise.

conjugate

public static Quaternion conjugate(float quatX,
                                   float quatY,
                                   float quatZ,
                                   float quatW)

Conjugates a quaternion based on its components.

参数:

quatX - Indicates component X.

quatY - Indicates component Y.

quatZ - Indicates component Z.

quatW - Indicates component W.

返回:

Returns the conjugated quaternion.

slerp

public static Quaternion slerp(Quaternion lhs,
                               Quaternion rhs,
                               float value)

Performs spherical linear interpolation between two quaternions.

参数:

lhs - Indicates the left-hand-side operand.

rhs - Indicates the right-hand-side operand.

value - Indicates the interpolation proportion, which ranges from 0.0 to 1.0.

返回:

Returns the result of spherical linear interpolation.

getX

public float getX()

Obtains component X of a quaternion.

返回:

Returns component X of the quaternion.

getY

public float getY()

Obtains component Y of a quaternion.

返回:

Returns component Y of the quaternion.

getZ

public float getZ()

Obtains component Z of a quaternion.

返回:

Returns component Z of the quaternion.

getW

public float getW()

Obtains component W of a quaternion.

返回:

Returns component W of the quaternion.

getLength

public float getLength()

Obtains the length of a quaternion.

For details about how to calculate the length of a quaternion, see length(float, float, float, float).

返回:

Returns the length of the quaternion.

getLengthSquared

public float getLengthSquared()

Obtains the squared length of a quaternion.

For details about how to calculate the squared length of a quaternion, see lengthSquared(float, float, float, float).

返回:

Returns the squared length of the quaternion.

getNormalized

public Quaternion getNormalized()

Obtains a normalized quaternion.

For details about how to normalize a quaternion, see normalize(float, float, float, float).

返回:

Returns the normalized quaternion.

getConjugate

public Quaternion getConjugate()

Obtains a conjugated quaternion.

For details about how to conjugate a quaternion, see conjugate(float, float, float, float).

返回:

Returns the conjugated quaternion.

rotatePoint

public Vector3 rotatePoint(Vector3 vector)

Rotates a given vector to obtain a new vector.

参数:

vector - Indicates the given vector.

返回:

Returns the obtained vector.

equals

public boolean equals(Object other)

从类复制的说明: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

覆盖:

equals 在类中 Object

参数:

other - the reference object with which to compare.

返回:

true if this object is the same as the obj argument; false otherwise.

另请参阅:

Object.hashCode(), HashMap

hashCode

public int hashCode()

从类复制的说明: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

覆盖:

hashCode 在类中 Object

返回:

a hash code value for this object.

另请参阅:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

从类复制的说明: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

覆盖:

toString 在类中 Object

返回:

a string representation of the object.