Vector3

java.lang.Object
- com.aspose.threed.Vector3

All Implemented Interfaces:

Struct<Vector3>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Vector3>
```
public final class Vector3
extends java.lang.Object
implements java.lang.Comparable<Vector3>, Struct<Vector3>, java.io.Serializable
```
A vector with three components.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

double x
The x component.

double y
The y component.

double z
The z component.

Fields
Modifier and Type	Field and Description
`double`	`x` The x component.
`double`	`y` The y component.
`double`	`z` The z component.

Constructor Summary

Constructors
Constructor and Description
`Vector3()`
`Vector3(double v)` Initializes a new instance of the `Vector3` struct.
`Vector3(double x, double y, double z)` Initializes a new instance of the `Vector3` struct.
`Vector3(FVector3 vec)` Initializes a new instance of the `Vector3` struct.
`Vector3(Vector4 vec4)` Initializes a new instance of the `Vector3` struct.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Vector3`	`add(Vector3 lhs, Vector3 rhs)` Operator overloading for +
`double`	`angleBetween(Vector3 dir)` Calculate the inner angle between two direction Two direction can be non-normalized vectors
`double`	`angleBetween(Vector3 dir, Vector3 up)` Calculate the inner angle between two direction Two direction can be non-normalized vectors
`Vector3`	`clone()` Clone current instance
`int`	`compareTo(Vector3 other)` Compare current vector to another instance.
`void`	`copyFrom(Vector3 src)` Copy internal state from argument t
`Vector3`	`cos()` Calculates cosine on each component
`static FVector3`	`create(Vector3 v)` Explicit conversion operator to cast Vector3 to FVector3
`Vector3`	`cross(Vector3 rhs)` Cross product of two vectors
`static Vector3`	`div(Vector3 lhs, double rhs)` Operator overloading for /
`static Vector3`	`div(Vector3 lhs, Vector3 rhs)` Operator overloading for /
`double`	`dot(Vector3 rhs)` Gets the dot product of two vectors
`boolean`	`equals(java.lang.Object obj)` Check if two vector3 equals
`double`	`get(int idx)` Gets vector's component by index.
`double`	`getLength()` Gets the length of this vector.
`double`	`getLength2()` Gets the square of the length.
`static Vector3`	`getOne()` Gets unit vector (1, 1, 1)
`static Vector3`	`getUnitX()` Gets unit vector (1, 0, 0)
`static Vector3`	`getUnitY()` Gets unit vector (0, 1, 0)
`static Vector3`	`getUnitZ()` Gets unit vector (0, 0, 1)
`static Vector3`	`getZero()` Gets unit vector (0, 0, 0)
`int`	`hashCode()` Gets the hash code of Vector3
`static Vector3`	`mul(double lhs, Vector3 rhs)` Operator overloading for *
`static Vector3`	`mul(Vector3 lhs, double rhs)` Operator overloading for *
`static Vector3`	`mul(Vector3 lhs, Vector3 rhs)` Operator overloading for *
`static Vector3`	`negative(Vector3 v)` Operator overloading for -
`Vector3`	`normalize()` Normalizes this instance.
`static boolean`	`op_eq(Vector3 lhs, Vector3 rhs)` Equal operator for Vector3
`static boolean`	`op_ne(Vector3 lhs, Vector3 rhs)` Not-equal operator for Vector3
`void`	`set(double newX, double newY, double newZ)` Sets the x/y/z component in one call.
`void`	`set(int idx, double value)` Sets vector's component by index.
`Vector3`	`sin()` Calculates sine on each component
`static Vector3`	`sub(Vector3 lhs, Vector3 rhs)` Operator overloading for - (minus)
`java.lang.String`	`toString()` Returns a `String` that represents the current `Vector3`.

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

Methods inherited from interface com.aspose.threed.Struct
byVal

- Field Detail
  - x
```
public double x
```
    The x component.
  - y
```
public double y
```
    The y component.
  - z
```
public double z
```
    The z component.
- Constructor Detail
  - Vector3
```
public Vector3(double x,
               double y,
               double z)
```
    Initializes a new instance of the Vector3 struct.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
    
    z - The z coordinate.
  - Vector3
```
public Vector3(FVector3 vec)
```
    Initializes a new instance of the Vector3 struct.
    
    Parameters:
    
    vec - The x coordinate.
  - Vector3
```
public Vector3(double v)
```
    Initializes a new instance of the Vector3 struct.
    
    Parameters:
    
    v - V.
  - Vector3
```
public Vector3(Vector4 vec4)
```
    Initializes a new instance of the Vector3 struct.
    
    Parameters:
    
    vec4 - Vec4.
  - Vector3
```
public Vector3()
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Check if two vector3 equals
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - The object to check equality.
    
    Returns:
    
    True if all components are identically equal.
  - create
```
public static FVector3 create(Vector3 v)
```
    Explicit conversion operator to cast Vector3 to FVector3
  - dot
```
public double dot(Vector3 rhs)
```
    Gets the dot product of two vectors
    
    Parameters:
    
    rhs - Right hand side value.
    
    Returns:
    
    The dot product of the two vectors.
  - normalize
```
public Vector3 normalize()
```
    Normalizes this instance.
    
    Returns:
    
    Normalized vector.
  - getLength2
```
public double getLength2()
```
    Gets the square of the length.
    
    Returns:
    
    the square of the length.
  - getLength
```
public double getLength()
```
    Gets the length of this vector.
    
    Returns:
    
    the length of this vector.
  - sin
```
public Vector3 sin()
```
    Calculates sine on each component
    
    Returns:
    
    Calculated Vector3.
  - cos
```
public Vector3 cos()
```
    Calculates cosine on each component
    
    Returns:
    
    Calculated Vector3.
  - cross
```
public Vector3 cross(Vector3 rhs)
```
    Cross product of two vectors
    
    Parameters:
    
    rhs - Right hand side value.
    
    Returns:
    
    Cross product of two Vector3s.
  - getZero
```
public static Vector3 getZero()
```
    Gets unit vector (0, 0, 0)
    
    Returns:
    
    unit vector (0, 0, 0)
  - getOne
```
public static Vector3 getOne()
```
    Gets unit vector (1, 1, 1)
    
    Returns:
    
    unit vector (1, 1, 1)
  - getUnitX
```
public static Vector3 getUnitX()
```
    Gets unit vector (1, 0, 0)
    
    Returns:
    
    unit vector (1, 0, 0)
  - getUnitY
```
public static Vector3 getUnitY()
```
    Gets unit vector (0, 1, 0)
    
    Returns:
    
    unit vector (0, 1, 0)
  - getUnitZ
```
public static Vector3 getUnitZ()
```
    Gets unit vector (0, 0, 1)
    
    Returns:
    
    unit vector (0, 0, 1)
  - negative
```
public static Vector3 negative(Vector3 v)
```
    Operator overloading for -
    
    Parameters:
    
    v - The origin vector
    
    Returns:
    
    Result vector
  - sub
```
public static Vector3 sub(Vector3 lhs,
                          Vector3 rhs)
```
    Operator overloading for - (minus)
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right vector
    
    Returns:
    
    Result vector
  - add
```
public static Vector3 add(Vector3 lhs,
                          Vector3 rhs)
```
    Operator overloading for +
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right vector
    
    Returns:
    
    Result vector
  - mul
```
public static Vector3 mul(Vector3 lhs,
                          Vector3 rhs)
```
    Operator overloading for *
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right vector
    
    Returns:
    
    Result vector
  - mul
```
public static Vector3 mul(double lhs,
                          Vector3 rhs)
```
    Operator overloading for *
    
    Parameters:
    
    lhs - The left scalar
    
    rhs - The right vector
    
    Returns:
    
    Result vector
  - mul
```
public static Vector3 mul(Vector3 lhs,
                          double rhs)
```
    Operator overloading for *
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right double value
    
    Returns:
    
    Result vector
  - div
```
public static Vector3 div(Vector3 lhs,
                          double rhs)
```
    Operator overloading for /
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right double value
    
    Returns:
    
    Result vector
  - div
```
public static Vector3 div(Vector3 lhs,
                          Vector3 rhs)
```
    Operator overloading for /
    
    Parameters:
    
    lhs - The left vector
    
    rhs - The right vector
    
    Returns:
    
    Result vector
  - op_eq
```
public static boolean op_eq(Vector3 lhs,
                            Vector3 rhs)
```
    Equal operator for Vector3
    
    Parameters:
    
    lhs - Left hand side value.
    
    rhs - Right hand side value.
    
    Returns:
    
    True if all components are identically equal.
  - op_ne
```
public static boolean op_ne(Vector3 lhs,
                            Vector3 rhs)
```
    Not-equal operator for Vector3
    
    Parameters:
    
    lhs - Left hand side value.
    
    rhs - Right hand side value.
    
    Returns:
    
    True if two vectors are not equal.
  - set
```
public void set(double newX,
                double newY,
                double newZ)
```
    Sets the x/y/z component in one call.
    
    Parameters:
    
    newX - The x component.
    
    newY - The y component.
    
    newZ - The z component.
  - toString
```
public java.lang.String toString()
```
    Returns a String that represents the current Vector3.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String that represents the current Vector3.
  - angleBetween
```
public double angleBetween(Vector3 dir,
                           Vector3 up)
```
    Calculate the inner angle between two direction Two direction can be non-normalized vectors
    
    Parameters:
    
    dir - The direction vector to compare with
    
    up - The up vector of the two direction's shared plane
    
    Returns:
    
    inner angle in radian
  - angleBetween
```
public double angleBetween(Vector3 dir)
```
    Calculate the inner angle between two direction Two direction can be non-normalized vectors
    
    Parameters:
    
    dir - The direction vector to compare with
    
    Returns:
    
    inner angle in radian
  - compareTo
```
public int compareTo(Vector3 other)
```
    Compare current vector to another instance.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Vector3>
  - get
```
public double get(int idx)
```
    Gets vector's component by index.
    
    Returns:
    
    vector's component by index.
  - set
```
public void set(int idx,
                double value)
```
    Sets vector's component by index.
    
    Parameters:
    
    value - New value
  - clone
```
public Vector3 clone()
```
    Description copied from interface: Struct
    
    Clone current instance
    
    Specified by:
    
    clone in interface Struct<Vector3>
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    cloned instance
  - copyFrom
```
public void copyFrom(Vector3 src)
```
    Description copied from interface: Struct
    
    Copy internal state from argument t
    
    Specified by:
    
    copyFrom in interface Struct<Vector3>
    
    Parameters:
    
    src - source instance to copy
  - hashCode
```
public int hashCode()
```
    Gets the hash code of Vector3
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash code of the Vector3

Class Vector3

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.aspose.threed.Struct

Field Detail

x

y

z

Constructor Detail

Vector3

Vector3

Vector3

Vector3

Vector3

Method Detail

equals

create

dot

normalize

getLength2

getLength

sin

cos

cross

getZero

getOne

getUnitX

getUnitY

getUnitZ

negative

sub

add

mul

mul

mul

div

div

op_eq

op_ne

set

toString

angleBetween

angleBetween

compareTo

get

set

clone

copyFrom

hashCode