Class Vector3

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

A three-dimensional vector.

public class Vector3 : Disposable, IDisposable, ICloneable

Inheritance

object

Disposable

Vector3

Implements

System.IDisposable

System.ICloneable

Constructors

Vector3()

The constructor.

Declaration

public Vector3()

Vector3(float, float, float)

The default constructor initializes the vector to 0.

Declaration

public Vector3(float x, float y, float z)

Parameters

Type	Name	Description
float	x	The x (or width) component.
float	y	The y (or height) component.
float	z	The z (or depth) component.

Vector3(float[])

Conversion constructor from an array of three floats.

Declaration

public Vector3(float[] array)

Parameters

Type	Name	Description
float[]	array	An array of xyz.

Vector3(Vector2)

The constructor.

Declaration

public Vector3(Vector2 vec2)

Parameters

Type	Name	Description
Vector2	vec2	Vector2 to create this vector from.

Vector3(Vector4)

The constructor.

Declaration

public Vector3(Vector4 vec4)

Parameters

Type	Name	Description
Vector4	vec4	Vector4 to create this vector from.

Properties

B

The blue component.

Declaration

public float B { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

Depth

The depth component.

Declaration

[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Vector3(...) constructor")]
public float Depth { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

G

The green component.

Declaration

public float G { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

Height

The height component.

Declaration

public float Height { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

this[uint]

An array subscript operator overload.

Declaration

public float this[uint index] { get; }

Parameters

Type	Name	Description
uint	index	The subscript index.

Property Value

Type	Description
float	The float at the given index.

NegativeXAxis

The vector representing the negative x-axis.

Declaration

public static Vector3 NegativeXAxis { get; }

Property Value

Type	Description
Vector3

NegativeYAxis

Th vector representing the negative y-axis.

Declaration

public static Vector3 NegativeYAxis { get; }

Property Value

Type	Description
Vector3

NegativeZAxis

The vector representing the negative z-axis.

Declaration

public static Vector3 NegativeZAxis { get; }

Property Value

Type	Description
Vector3

One

(1.0f,1.0f,1.0f).

Declaration

public static Vector3 One { get; }

Property Value

Type	Description
Vector3

R

The red component.

Declaration

public float R { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

Width

The width component.

Declaration

[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Vector3(...) constructor")]
public float Width { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

X

The x component.

Declaration

public float X { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

XAxis

The vector representing the x-axis.

Declaration

public static Vector3 XAxis { get; }

Property Value

Type	Description
Vector3

Y

The y component.

Declaration

public float Y { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

YAxis

The vector representing the y-axis.

Declaration

public static Vector3 YAxis { get; }

Property Value

Type	Description
Vector3

Z

The z component.

Declaration

public float Z { get; set; }

Property Value

Type	Description
float

Remarks

The setter is deprecated in API8 and will be removed in API10. Please use new Vector3(...) constructor.

ZAxis

The vector representing the z-axis.

Declaration

public static Vector3 ZAxis { get; }

Property Value

Type	Description
Vector3

Zero

(0.0f, 0.0f, 0.0f).

Declaration

public static Vector3 Zero { get; }

Property Value

Type	Description
Vector3

Methods

Clamp(Vector3, Vector3)

Clamps the vector between minimum and maximum vectors.

Declaration

public void Clamp(Vector3 min, Vector3 max)

Parameters

Type	Name	Description
Vector3	min	The minimum vector.
Vector3	max	The maximum vector.

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(Object obj)

Parameters

Type	Name	Description
Tizen.System.Object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Gets the the hash code of this Vector3.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The Hash Code.

Overrides

object.GetHashCode()

GetVectorXY()

Returns the x and y components (or width and height, or r and g) as a Vector2.

Declaration

public Vector2 GetVectorXY()

Returns

Type	Description
Vector2	The partial vector contents as Vector2 (x,y).

GetVectorYZ()

Returns the y and z components (or height and depth, or g and b) as a Vector2.

Declaration

public Vector2 GetVectorYZ()

Returns

Type	Description
Vector2	The partial vector contents as Vector2 (y,z).

Length()

Returns the length of the vector.

Declaration

public float Length()

Returns

Type	Description
float	The length of the vector.

LengthSquared()

Returns the length of the vector squared.
This is more efficient than Length() for threshold testing as it avoids the use of a square root.

Declaration

public float LengthSquared()

Returns

Type	Description
float	The length of the vector squared.

Normalize()

Sets the vector to be unit length, whilst maintaining its direction.

Declaration

public void Normalize()

Operators

operator +(Vector3, Vector3)

The addition operator.

Declaration

public static Vector3 operator +(Vector3 arg1, Vector3 arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
Vector3	arg2	The second value.

Returns

Type	Description
Vector3	The vector containing the result of the addition.

operator /(Vector3, float)

The division operator.

Declaration

public static Vector3 operator /(Vector3 arg1, float arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
float	arg2	The float value to scale the vector by.

Returns

Type	Description
Vector3	The vector containing the result of the scaling.

operator /(Vector3, Vector3)

The division operator.

Declaration

public static Vector3 operator /(Vector3 arg1, Vector3 arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
Vector3	arg2	The second value.

Returns

Type	Description
Vector3	The vector containing the result of the division.

operator *(Vector3, float)

The multiplication operator.

Declaration

public static Vector3 operator *(Vector3 arg1, float arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
float	arg2	The float value to scale the vector.

Returns

Type	Description
Vector3	The vector containing the result of the scaling.

operator *(Vector3, Vector3)

The multiplication operator.

Declaration

public static Vector3 operator *(Vector3 arg1, Vector3 arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
Vector3	arg2	The second value.

Returns

Type	Description
Vector3	The vector containing the result of the multiplication.

operator -(Vector3, Vector3)

The subtraction operator.

Declaration

public static Vector3 operator -(Vector3 arg1, Vector3 arg2)

Parameters

Type	Name	Description
Vector3	arg1	The first value.
Vector3	arg2	The second value.

Returns

Type	Description
Vector3	The vector containing the result of the subtraction.

operator -(Vector3)

The unary negation operator.

Declaration

public static Vector3 operator -(Vector3 arg1)

Parameters

Type	Name	Description
Vector3	arg1	The target value.

Returns

Type	Description
Vector3	The vector containg the negation.

Implements

System.IDisposable

System.ICloneable