Represents a 3D vector using three single-precision floating-point numbers. More...

Inheritance diagram for makVrl.Vector3f:

Collaboration diagram for makVrl.Vector3f:

Public Member Functions
	Vector3f (float value)
	Constructs a new instance. More...

	Vector3f (float x, float y, float z)
	Constructs a new Vector3. More...

	Vector3f (Vector2 v)
	Constructs a new Vector3 from the given Vector2. More...

	Vector3f (Vector3f v)
	Constructs a new Vector3 from the given Vector3. More...

	Vector3f (Vector4 v)
	Constructs a new Vector3 from the given Vector4. More...

void	Add (Vector3f right)
	Add the Vector passed as parameter to this instance. More...

void	Add (ref Vector3f right)
	Add the Vector passed as parameter to this instance. More...

void	Sub (Vector3f right)
	Subtract the Vector passed as parameter from this instance. More...

void	Sub (ref Vector3f right)
	Subtract the Vector passed as parameter from this instance. More...

void	Mult (float f)
	Multiply this instance by a scalar. More...

void	Div (float f)
	Divide this instance by a scalar. More...

Vector3f	Normalized ()
	Returns a copy of the Vector3 scaled to unit length. More...

void	Normalize ()
	Scales the Vector3 to unit length. More...

void	NormalizeFast ()
	Scales the Vector3 to approximately unit length. More...

void	Scale (float sx, float sy, float sz)
	Scales the current Vector3 by the given amounts. More...

void	Scale (Vector3f scale)
	Scales this instance by the given parameter. More...

void	Scale (ref Vector3f scale)
	Scales this instance by the given parameter. More...

override string	ToString ()
	Returns a System.String that represents the current Vector3. More...

override int	GetHashCode ()
	Returns the hashcode for this instance. More...

override bool	Equals (object obj)
	Indicates whether this instance and a specified object are equal. More...

bool	Equals (Vector3f other)
	Indicates whether the current vector is equal to another vector. More...

Static Public Member Functions
static Vector3f	Sub (Vector3f a, Vector3f b)
	Subtract one Vector from another More...

static void	Sub (ref Vector3f a, ref Vector3f b, out Vector3f result)
	Subtract one Vector from another More...

static Vector3f	Mult (Vector3f a, float f)
	Multiply a vector and a scalar More...

static void	Mult (ref Vector3f a, float f, out Vector3f result)
	Multiply a vector and a scalar More...

static Vector3f	Div (Vector3f a, float f)
	Divide a vector by a scalar More...

static void	Div (ref Vector3f a, float f, out Vector3f result)
	Divide a vector by a scalar More...

static Vector3f	Add (Vector3f a, Vector3f b)
	Adds two vectors. More...

static void	Add (ref Vector3f a, ref Vector3f b, out Vector3f result)
	Adds two vectors. More...

static Vector3f	Subtract (Vector3f a, Vector3f b)
	Subtract one Vector from another More...

static void	Subtract (ref Vector3f a, ref Vector3f b, out Vector3f result)
	Subtract one Vector from another More...

static Vector3f	Multiply (Vector3f vector, float scale)
	Multiplies a vector by a scalar. More...

static void	Multiply (ref Vector3f vector, float scale, out Vector3f result)
	Multiplies a vector by a scalar. More...

static Vector3f	Multiply (Vector3f vector, Vector3f scale)
	Multiplies a vector by the components a vector (scale). More...

static void	Multiply (ref Vector3f vector, ref Vector3f scale, out Vector3f result)
	Multiplies a vector by the components of a vector (scale). More...

static Vector3f	Divide (Vector3f vector, float scale)
	Divides a vector by a scalar. More...

static void	Divide (ref Vector3f vector, float scale, out Vector3f result)
	Divides a vector by a scalar. More...

static Vector3f	Divide (Vector3f vector, Vector3f scale)
	Divides a vector by the components of a vector (scale). More...

static void	Divide (ref Vector3f vector, ref Vector3f scale, out Vector3f result)
	Divide a vector by the components of a vector (scale). More...

static Vector3f	ComponentMin (Vector3f a, Vector3f b)
	Calculate the component-wise minimum of two vectors More...

static void	ComponentMin (ref Vector3f a, ref Vector3f b, out Vector3f result)
	Calculate the component-wise minimum of two vectors More...

static Vector3f	ComponentMax (Vector3f a, Vector3f b)
	Calculate the component-wise maximum of two vectors More...

static void	ComponentMax (ref Vector3f a, ref Vector3f b, out Vector3f result)
	Calculate the component-wise maximum of two vectors More...

static Vector3f	Min (Vector3f left, Vector3f right)
	Returns the Vector3 with the minimum magnitude More...

static Vector3f	Max (Vector3f left, Vector3f right)
	Returns the Vector3 with the minimum magnitude More...

static Vector3f	Clamp (Vector3f vec, Vector3f min, Vector3f max)
	Clamp a vector to the given minimum and maximum vectors More...

static void	Clamp (ref Vector3f vec, ref Vector3f min, ref Vector3f max, out Vector3f result)
	Clamp a vector to the given minimum and maximum vectors More...

static Vector3f	Normalize (Vector3f vec)
	Scale a vector to unit length More...

static void	Normalize (ref Vector3f vec, out Vector3f result)
	Scale a vector to unit length More...

static Vector3f	NormalizeFast (Vector3f vec)
	Scale a vector to approximately unit length More...

static void	NormalizeFast (ref Vector3f vec, out Vector3f result)
	Scale a vector to approximately unit length More...

static float	Dot (Vector3f left, Vector3f right)
	Calculate the dot (scalar) product of two vectors More...

static void	Dot (ref Vector3f left, ref Vector3f right, out float result)
	Calculate the dot (scalar) product of two vectors More...

static Vector3f	Cross (Vector3f left, Vector3f right)
	Caclulate the cross (vector) product of two vectors More...

static void	Cross (ref Vector3f left, ref Vector3f right, out Vector3f result)
	Caclulate the cross (vector) product of two vectors More...

static Vector3f	Lerp (Vector3f a, Vector3f b, float blend)
	Returns a new Vector that is the linear blend of the 2 given Vectors More...

static void	Lerp (ref Vector3f a, ref Vector3f b, float blend, out Vector3f result)
	Returns a new Vector that is the linear blend of the 2 given Vectors More...

static Vector3f	BaryCentric (Vector3f a, Vector3f b, Vector3f c, float u, float v)
	Interpolate 3 Vectors using Barycentric coordinates More...

static void	BaryCentric (ref Vector3f a, ref Vector3f b, ref Vector3f c, float u, float v, out Vector3f result)
	Interpolate 3 Vectors using Barycentric coordinates More...

static Vector3f	TransformVector (Vector3f vec, Matrix4 mat)
	Transform a direction vector by the given Matrix Assumes the matrix has a bottom row of (0,0,0,1), that is the translation part is ignored. More...

static void	TransformVector (ref Vector3f vec, ref Matrix4 mat, out Vector3f result)
	Transform a direction vector by the given Matrix Assumes the matrix has a bottom row of (0,0,0,1), that is the translation part is ignored. More...

static Vector3f	TransformNormal (Vector3f norm, Matrix4 mat)
	Transform a Normal by the given Matrix More...

static void	TransformNormal (ref Vector3f norm, ref Matrix4 mat, out Vector3f result)
	Transform a Normal by the given Matrix More...

static Vector3f	TransformNormalInverse (Vector3f norm, Matrix4 invMat)
	Transform a Normal by the (transpose of the) given Matrix More...

static void	TransformNormalInverse (ref Vector3f norm, ref Matrix4 invMat, out Vector3f result)
	Transform a Normal by the (transpose of the) given Matrix More...

static Vector3f	TransformPosition (Vector3f pos, Matrix4 mat)
	Transform a Position by the given Matrix More...

static void	TransformPosition (ref Vector3f pos, ref Matrix4 mat, out Vector3f result)
	Transform a Position by the given Matrix More...

static Vector3f	Transform (Vector3f vec, Matrix4 mat)
	Transform a Vector by the given Matrix More...

static void	Transform (ref Vector3f vec, ref Matrix4 mat, out Vector3f result)
	Transform a Vector by the given Matrix More...

static Vector3f	Transform (Vector3f vec, Quaternion quat)
	Transforms a vector by a quaternion rotation. More...

static void	Transform (ref Vector3f vec, ref Quaternion quat, out Vector3f result)
	Transforms a vector by a quaternion rotation. More...

static Vector3f	TransformPerspective (Vector3f vec, Matrix4 mat)
	Transform a Vector3 by the given Matrix, and project the resulting Vector4 back to a Vector3 More...

static void	TransformPerspective (ref Vector3f vec, ref Matrix4 mat, out Vector3f result)
	Transform a Vector3 by the given Matrix, and project the resulting Vector4 back to a Vector3 More...

static float	CalculateAngle (Vector3f first, Vector3f second)
	Calculates the angle (in radians) between two vectors. More...

static void	CalculateAngle (ref Vector3f first, ref Vector3f second, out float result)
	Calculates the angle (in radians) between two vectors. More...

static Vector3f	operator+ (Vector3f left, Vector3f right)
	Adds two instances. More...

static Vector3f	operator- (Vector3f left, Vector3f right)
	Subtracts two instances. More...

static Vector3f	operator- (Vector3f vec)
	Negates an instance. More...

static Vector3f	operator* (Vector3f vec, float scale)
	Multiplies an instance by a scalar. More...

static Vector3f	operator* (float scale, Vector3f vec)
	Multiplies an instance by a scalar. More...

static Vector3f	operator/ (Vector3f vec, float scale)
	Divides an instance by a scalar. More...

static bool	operator== (Vector3f left, Vector3f right)
	Compares two instances for equality. More...

static bool	operator!= (Vector3f left, Vector3f right)
	Compares two instances for inequality. More...

Public Attributes
float	X
	The X component of the Vector3. More...

float	Y
	The Y component of the Vector3. More...

float	Z
	The Z component of the Vector3. More...

Static Public Attributes
static readonly Vector3f	UnitX = new Vector3f(1, 0, 0)
	Defines a unit-length Vector3 that points towards the X-axis. More...

static readonly Vector3f	UnitY = new Vector3f(0, 1, 0)
	Defines a unit-length Vector3 that points towards the Y-axis. More...

static readonly Vector3f	UnitZ = new Vector3f(0, 0, 1)
	/// Defines a unit-length Vector3 that points towards the Z-axis. More...

static readonly Vector3f	Zero = new Vector3f(0, 0, 0)
	Defines a zero-length Vector3. More...

static readonly Vector3f	One = new Vector3f(1, 1, 1)
	Defines an instance with all components set to 1. More...

static readonly int	SizeInBytes = Marshal.SizeOf(new Vector3f())
	Defines the size of the Vector3 struct in bytes. More...

Properties
float	this[int index] `[get, set]`
	Gets or sets the value at the index of the Vector. More...

float	Length `[get]`
	Gets the length (magnitude) of the vector. More...

float	LengthFast `[get]`
	Gets an approximation of the vector length (magnitude). More...

float	LengthSquared `[get]`
	Gets the square of the vector length (magnitude). More...

Vector2	Xy `[get, set]`
	Gets or sets an makVrl.Vector2 with the X and Y components of this instance. More...

Vector2	Xz `[get, set]`
	Gets or sets an makVrl.Vector2 with the X and Z components of this instance. More...

Vector2	Yx `[get, set]`
	Gets or sets an makVrl.Vector2 with the Y and X components of this instance. More...

Vector2	Yz `[get, set]`
	Gets or sets an makVrl.Vector2 with the Y and Z components of this instance. More...

Vector2	Zx `[get, set]`
	Gets or sets an makVrl.Vector2 with the Z and X components of this instance. More...

Vector2	Zy `[get, set]`
	Gets or sets an makVrl.Vector2 with the Z and Y components of this instance. More...

Vector3f	Xzy `[get, set]`
	Gets or sets an makVrl.Vector3 with the X, Z, and Y components of this instance. More...

Vector3f	Yxz `[get, set]`
	Gets or sets an makVrl.Vector3 with the Y, X, and Z components of this instance. More...

Vector3f	Yzx `[get, set]`
	Gets or sets an makVrl.Vector3 with the Y, Z, and X components of this instance. More...

Vector3f	Zxy `[get, set]`
	Gets or sets an makVrl.Vector3 with the Z, X, and Y components of this instance. More...

Vector3f	Zyx `[get, set]`
	Gets or sets an makVrl.Vector3 with the Z, Y, and X components of this instance. More...

Static Private Attributes
static string	listSeparator = System.Globalization.CultureInfo.CurrentCulture.TextInfo.ListSeparator

Detailed Description

Represents a 3D vector using three single-precision floating-point numbers.

The Vector3 structure is suitable for inter operation with unmanaged code requiring three consecutive floats.

Constructor & Destructor Documentation

makVrl.Vector3f.Vector3f ( float value )

inline

Constructs a new instance.

Parameters

value The value that will initialize this instance.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

Referenced by makVrl.Vector3f.Add(), makVrl.Vector3f.Cross(), makVrl.Vector3f.Divide(), makVrl.Vector3f.Equals(), makVrl.Vector3f.Multiply(), makVrl.Vector3f.Subtract(), makVrl.Vector3f.TransformNormalInverse(), makVrl.Vector3f.TransformPosition(), and makVrl.Vector3f.TransformVector().

makVrl.Vector3f.Vector3f	(	float	x,
		float	y,
		float	z
	)

inline

Constructs a new Vector3.

Parameters

x	The x component of the Vector3.
y	The y component of the Vector3.
z	The z component of the Vector3.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

makVrl.Vector3f.Vector3f ( Vector2 v )

inline

Constructs a new Vector3 from the given Vector2.

Parameters

v	The Vector2 to copy components from.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

makVrl.Vector3f.Vector3f ( Vector3f v )

inline

Constructs a new Vector3 from the given Vector3.

Parameters

v	The Vector3 to copy components from.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

makVrl.Vector3f.Vector3f ( Vector4 v )

inline

Constructs a new Vector3 from the given Vector4.

Parameters

v	The Vector4 to copy components from.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

Member Function Documentation

void makVrl.Vector3f.Add ( Vector3f right )

inline

Add the Vector passed as parameter to this instance.

Parameters

right Right operand. This parameter is only read from.

Referenced by makVrl.Vector3f.Add(), and makVrl.Vector3f.BaryCentric().

void makVrl.Vector3f.Add ( ref Vector3f right )

inline

Add the Vector passed as parameter to this instance.

Parameters

right Right operand. This parameter is only read from.

static Vector3f makVrl.Vector3f.Add	(	Vector3f	a,
		Vector3f	b
	)

inlinestatic

Adds two vectors.

Parameters

a	Left operand.
b	Right operand.

Returns: Result of operation.

References makVrl.Vector3f.Add().

static void makVrl.Vector3f.Add	(	ref Vector3f	a,
		ref Vector3f	b,
		out Vector3f	result
	)

inlinestatic

Adds two vectors.

Parameters

a	Left operand.
b	Right operand.
result	Result of operation.

References makVrl.Vector3f.Vector3f().

static Vector3f makVrl.Vector3f.BaryCentric	(	Vector3f	a,
		Vector3f	b,
		Vector3f	c,
		float	u,
		float	v
	)

inlinestatic

Interpolate 3 Vectors using Barycentric coordinates

Parameters

a	First input Vector
b	Second input Vector
c	Third input Vector
u	First Barycentric Coordinate
v	Second Barycentric Coordinate

Returns: a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise

static void makVrl.Vector3f.BaryCentric	(	ref Vector3f	a,
		ref Vector3f	b,
		ref Vector3f	c,
		float	u,
		float	v,
		out Vector3f	result
	)

inlinestatic

Interpolate 3 Vectors using Barycentric coordinates

Parameters

a	First input Vector.
b	Second input Vector.
c	Third input Vector.
u	First Barycentric Coordinate.
v	Second Barycentric Coordinate.
result	Output Vector. a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise

References makVrl.Vector3f.Add(), makVrl.Vector3f.Multiply(), and makVrl.Vector3f.Subtract().

static float makVrl.Vector3f.CalculateAngle	(	Vector3f	first,
		Vector3f	second
	)

inlinestatic

Calculates the angle (in radians) between two vectors.

Parameters

first	The first vector.
second	The second vector.

Returns: Angle (in radians) between the vectors.

Note that the returned angle is never bigger than the constant Pi.

static void makVrl.Vector3f.CalculateAngle	(	ref Vector3f	first,
		ref Vector3f	second,
		out float	result
	)

inlinestatic

Calculates the angle (in radians) between two vectors.

Parameters

first	The first vector.
second	The second vector.
result	Angle (in radians) between the vectors.

Note that the returned angle is never bigger than the constant Pi.

static Vector3f makVrl.Vector3f.Clamp	(	Vector3f	vec,
		Vector3f	min,
		Vector3f	max
	)

inlinestatic

Clamp a vector to the given minimum and maximum vectors

Parameters

vec	Input vector
min	Minimum vector
max	Maximum vector

Returns: The clamped vector

static void makVrl.Vector3f.Clamp	(	ref Vector3f	vec,
		ref Vector3f	min,
		ref Vector3f	max,
		out Vector3f	result
	)

inlinestatic

Clamp a vector to the given minimum and maximum vectors

Parameters

vec	Input vector
min	Minimum vector
max	Maximum vector
result	The clamped vector

static Vector3f makVrl.Vector3f.ComponentMax	(	Vector3f	a,
		Vector3f	b
	)

inlinestatic

Calculate the component-wise maximum of two vectors

Parameters

a	First operand
b	Second operand

Returns: The component-wise maximum

static void makVrl.Vector3f.ComponentMax	(	ref Vector3f	a,
		ref Vector3f	b,
		out Vector3f	result
	)

inlinestatic

Calculate the component-wise maximum of two vectors

Parameters

a	First operand
b	Second operand
result	The component-wise maximum

static Vector3f makVrl.Vector3f.ComponentMin	(	Vector3f	a,
		Vector3f	b
	)

inlinestatic

Calculate the component-wise minimum of two vectors

Parameters

a	First operand
b	Second operand

Returns: The component-wise minimum

static void makVrl.Vector3f.ComponentMin	(	ref Vector3f	a,
		ref Vector3f	b,
		out Vector3f	result
	)

inlinestatic

Calculate the component-wise minimum of two vectors

Parameters

a	First operand
b	Second operand
result	The component-wise minimum

static Vector3f makVrl.Vector3f.Cross	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Caclulate the cross (vector) product of two vectors

Parameters

left	First operand
right	Second operand

Returns: The cross product of the two inputs

Referenced by makVrl.Quaternion.Mult(), and makVrl.Quaternion.Multiply().

static void makVrl.Vector3f.Cross	(	ref Vector3f	left,
		ref Vector3f	right,
		out Vector3f	result
	)

inlinestatic

Caclulate the cross (vector) product of two vectors

Parameters

left	First operand
right	Second operand

Returns: The cross product of the two inputs

Parameters

result The cross product of the two inputs

References makVrl.Vector3f.Vector3f().

void makVrl.Vector3f.Div ( float f )

inline

Divide this instance by a scalar.

Parameters

f	Scalar operand.

static Vector3f makVrl.Vector3f.Div	(	Vector3f	a,
		float	f
	)

inlinestatic

Divide a vector by a scalar

Parameters

a	Vector operand
f	Scalar operand

Returns: Result of the division

static void makVrl.Vector3f.Div	(	ref Vector3f	a,
		float	f,
		out Vector3f	result
	)

inlinestatic

Divide a vector by a scalar

Parameters

a	Vector operand
f	Scalar operand
result	Result of the division

static Vector3f makVrl.Vector3f.Divide	(	Vector3f	vector,
		float	scale
	)

inlinestatic

Divides a vector by a scalar.

Parameters

vector	Left operand.
scale	Right operand.

Returns: Result of the operation.

Referenced by makVrl.Vector3f.Divide().

static void makVrl.Vector3f.Divide	(	ref Vector3f	vector,
		float	scale,
		out Vector3f	result
	)

inlinestatic

Divides a vector by a scalar.

Parameters

vector	Left operand.
scale	Right operand.
result	Result of the operation.

References makVrl.Vector3f.Multiply().

static Vector3f makVrl.Vector3f.Divide	(	Vector3f	vector,
		Vector3f	scale
	)

inlinestatic

Divides a vector by the components of a vector (scale).

Parameters

vector	Left operand.
scale	Right operand.

Returns: Result of the operation.

References makVrl.Vector3f.Divide().

static void makVrl.Vector3f.Divide	(	ref Vector3f	vector,
		ref Vector3f	scale,
		out Vector3f	result
	)

inlinestatic

Divide a vector by the components of a vector (scale).

Parameters

vector	Left operand.
scale	Right operand.
result	Result of the operation.

References makVrl.Vector3f.Vector3f().

static float makVrl.Vector3f.Dot	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Calculate the dot (scalar) product of two vectors

Parameters

left	First operand
right	Second operand

Returns: The dot product of the two inputs

Referenced by makVrl.Vector3f.TransformPosition().

static void makVrl.Vector3f.Dot	(	ref Vector3f	left,
		ref Vector3f	right,
		out float	result
	)

inlinestatic

Calculate the dot (scalar) product of two vectors

Parameters

left	First operand
right	Second operand
result	The dot product of the two inputs

override bool makVrl.Vector3f.Equals ( object obj )

inline

Indicates whether this instance and a specified object are equal.

Parameters

obj	The object to compare to.

Returns: True if the instances are equal; false otherwise.

References makVrl.Vector3f.Vector3f().

bool makVrl.Vector3f.Equals ( Vector3f other )

inline

Indicates whether the current vector is equal to another vector.

Parameters

other A vector to compare with this vector.

Returns: true if the current vector is equal to the vector parameter; otherwise, false.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

override int makVrl.Vector3f.GetHashCode ( )

inline

Returns the hashcode for this instance.

Returns: A System.Int32 containing the unique hashcode for this instance.

References makVrl.Vector3f.Y.

Referenced by makVrl.Matrix3.GetHashCode().

static Vector3f makVrl.Vector3f.Lerp	(	Vector3f	a,
		Vector3f	b,
		float	blend
	)

inlinestatic

Returns a new Vector that is the linear blend of the 2 given Vectors

Parameters

a	First input vector
b	Second input vector
blend	The blend factor. a when blend=0, b when blend=1.

Returns: a when blend=0, b when blend=1, and a linear combination otherwise

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

static void makVrl.Vector3f.Lerp	(	ref Vector3f	a,
		ref Vector3f	b,
		float	blend,
		out Vector3f	result
	)

inlinestatic

Returns a new Vector that is the linear blend of the 2 given Vectors

Parameters

a	First input vector
b	Second input vector
blend	The blend factor. a when blend=0, b when blend=1.
result	a when blend=0, b when blend=1, and a linear combination otherwise

static Vector3f makVrl.Vector3f.Max	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Returns the Vector3 with the minimum magnitude

Parameters

left	Left operand
right	Right operand

Returns: The minimum Vector3

static Vector3f makVrl.Vector3f.Min	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Returns the Vector3 with the minimum magnitude

Parameters

left	Left operand
right	Right operand

Returns: The minimum Vector3

void makVrl.Vector3f.Mult ( float f )

inline

Multiply this instance by a scalar.

Parameters

f	Scalar operand.

static Vector3f makVrl.Vector3f.Mult	(	Vector3f	a,
		float	f
	)

inlinestatic

Multiply a vector and a scalar

Parameters

a	Vector operand
f	Scalar operand

Returns: Result of the multiplication

static void makVrl.Vector3f.Mult	(	ref Vector3f	a,
		float	f,
		out Vector3f	result
	)

inlinestatic

Multiply a vector and a scalar

Parameters

a	Vector operand
f	Scalar operand
result	Result of the multiplication

static Vector3f makVrl.Vector3f.Multiply	(	Vector3f	vector,
		float	scale
	)

inlinestatic

Multiplies a vector by a scalar.

Parameters

vector	Left operand.
scale	Right operand.

Returns: Result of the operation.

Referenced by makVrl.Vector3f.BaryCentric(), makVrl.Vector3f.Divide(), and makVrl.Vector3f.Multiply().

static void makVrl.Vector3f.Multiply	(	ref Vector3f	vector,
		float	scale,
		out Vector3f	result
	)

inlinestatic

Multiplies a vector by a scalar.

Parameters

vector	Left operand.
scale	Right operand.
result	Result of the operation.

References makVrl.Vector3f.Vector3f().

static Vector3f makVrl.Vector3f.Multiply	(	Vector3f	vector,
		Vector3f	scale
	)

inlinestatic

Multiplies a vector by the components a vector (scale).

Parameters

vector	Left operand.
scale	Right operand.

Returns: Result of the operation.

References makVrl.Vector3f.Multiply().

static void makVrl.Vector3f.Multiply	(	ref Vector3f	vector,
		ref Vector3f	scale,
		out Vector3f	result
	)

inlinestatic

Multiplies a vector by the components of a vector (scale).

Parameters

vector	Left operand.
scale	Right operand.
result	Result of the operation.

References makVrl.Vector3f.Vector3f().

void makVrl.Vector3f.Normalize ( )

inline

Scales the Vector3 to unit length.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

static Vector3f makVrl.Vector3f.Normalize ( Vector3f vec )

inlinestatic

Scale a vector to unit length

Parameters

vec	The input vector

Returns: The normalized vector

static void makVrl.Vector3f.Normalize	(	ref Vector3f	vec,
		out Vector3f	result
	)

inlinestatic

Scale a vector to unit length

Parameters

vec	The input vector
result	The normalized vector

Vector3f makVrl.Vector3f.Normalized ( )

inline

Returns a copy of the Vector3 scaled to unit length.

void makVrl.Vector3f.NormalizeFast ( )

inline

Scales the Vector3 to approximately unit length.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

static Vector3f makVrl.Vector3f.NormalizeFast ( Vector3f vec )

inlinestatic

Scale a vector to approximately unit length

Parameters

vec	The input vector

Returns: The normalized vector

static void makVrl.Vector3f.NormalizeFast	(	ref Vector3f	vec,
		out Vector3f	result
	)

inlinestatic

Scale a vector to approximately unit length

Parameters

vec	The input vector
result	The normalized vector

static bool makVrl.Vector3f.operator!=	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Compares two instances for inequality.

Parameters

left	The first instance.
right	The second instance.

Returns: True, if left does not equa lright; false otherwise.

static Vector3f makVrl.Vector3f.operator*	(	Vector3f	vec,
		float	scale
	)

inlinestatic

Multiplies an instance by a scalar.

Parameters

vec	The instance.
scale	The scalar.

Returns: The result of the calculation.

static Vector3f makVrl.Vector3f.operator*	(	float	scale,
		Vector3f	vec
	)

inlinestatic

Multiplies an instance by a scalar.

Parameters

scale	The scalar.
vec	The instance.

Returns: The result of the calculation.

static Vector3f makVrl.Vector3f.operator+	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Adds two instances.

Parameters

left	The first instance.
right	The second instance.

Returns: The result of the calculation.

static Vector3f makVrl.Vector3f.operator-	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Subtracts two instances.

Parameters

left	The first instance.
right	The second instance.

Returns: The result of the calculation.

static Vector3f makVrl.Vector3f.operator- ( Vector3f vec )

inlinestatic

Negates an instance.

Parameters

vec	The instance.

Returns: The result of the calculation.

static Vector3f makVrl.Vector3f.operator/	(	Vector3f	vec,
		float	scale
	)

inlinestatic

Divides an instance by a scalar.

Parameters

vec	The instance.
scale	The scalar.

Returns: The result of the calculation.

static bool makVrl.Vector3f.operator==	(	Vector3f	left,
		Vector3f	right
	)

inlinestatic

Compares two instances for equality.

Parameters

left	The first instance.
right	The second instance.

Returns: True, if left equals right; false otherwise.

void makVrl.Vector3f.Scale	(	float	sx,
		float	sy,
		float	sz
	)

inline

Scales the current Vector3 by the given amounts.

Parameters

sx	The scale of the X component.
sy	The scale of the Y component.
sz	The scale of the Z component.

References makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

void makVrl.Vector3f.Scale ( Vector3f scale )

inline

Scales this instance by the given parameter.

Parameters

scale The scaling of the individual components.

void makVrl.Vector3f.Scale ( ref Vector3f scale )

inline

Scales this instance by the given parameter.

Parameters

scale The scaling of the individual components.

void makVrl.Vector3f.Sub ( Vector3f right )

inline

Subtract the Vector passed as parameter from this instance.

Parameters

right Right operand. This parameter is only read from.

void makVrl.Vector3f.Sub ( ref Vector3f right )

inline

Subtract the Vector passed as parameter from this instance.

Parameters

right Right operand. This parameter is only read from.

static Vector3f makVrl.Vector3f.Sub	(	Vector3f	a,
		Vector3f	b
	)

inlinestatic

Subtract one Vector from another

Parameters

a	First operand
b	Second operand

Returns: Result of subtraction

static void makVrl.Vector3f.Sub	(	ref Vector3f	a,
		ref Vector3f	b,
		out Vector3f	result
	)

inlinestatic

Subtract one Vector from another

Parameters

a	First operand
b	Second operand
result	Result of subtraction

static Vector3f makVrl.Vector3f.Subtract	(	Vector3f	a,
		Vector3f	b
	)

inlinestatic

Subtract one Vector from another

Parameters

a	First operand
b	Second operand

Returns: Result of subtraction

Referenced by makVrl.Vector3f.BaryCentric().

static void makVrl.Vector3f.Subtract	(	ref Vector3f	a,
		ref Vector3f	b,
		out Vector3f	result
	)

inlinestatic

Subtract one Vector from another

Parameters

a	First operand
b	Second operand
result	Result of subtraction

References makVrl.Vector3f.Vector3f().

override string makVrl.Vector3f.ToString ( )

inline

Returns a System.String that represents the current Vector3.

Returns

References makVrl.Vector3f.listSeparator, makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

static Vector3f makVrl.Vector3f.Transform	(	Vector3f	vec,
		Matrix4	mat
	)

inlinestatic

Transform a Vector by the given Matrix

Parameters

vec	The vector to transform
mat	The desired transformation

Returns: The transformed vector

Referenced by makVrl.Vector3f.Transform().

static void makVrl.Vector3f.Transform	(	ref Vector3f	vec,
		ref Matrix4	mat,
		out Vector3f	result
	)

inlinestatic

Transform a Vector by the given Matrix

Parameters

vec	The vector to transform
mat	The desired transformation
result	The transformed vector

static Vector3f makVrl.Vector3f.Transform	(	Vector3f	vec,
		Quaternion	quat
	)

inlinestatic

Transforms a vector by a quaternion rotation.

Parameters

vec	The vector to transform.
quat	The quaternion to rotate the vector by.

Returns: The result of the operation.

References makVrl.Vector3f.Transform().

static void makVrl.Vector3f.Transform	(	ref Vector3f	vec,
		ref Quaternion	quat,
		out Vector3f	result
	)

inlinestatic

Transforms a vector by a quaternion rotation.

Parameters

vec	The vector to transform.
quat	The quaternion to rotate the vector by.
result	The result of the operation.

static Vector3f makVrl.Vector3f.TransformNormal	(	Vector3f	norm,
		Matrix4	mat
	)

inlinestatic

Transform a Normal by the given Matrix

This calculates the inverse of the given matrix, use TransformNormalInverse if you already have the inverse to avoid this extra calculation

Parameters

norm	The normal to transform
mat	The desired transformation

Returns: The transformed normal

References makVrl.Vector3f.TransformNormalInverse().

static void makVrl.Vector3f.TransformNormal	(	ref Vector3f	norm,
		ref Matrix4	mat,
		out Vector3f	result
	)

inlinestatic

Transform a Normal by the given Matrix

This calculates the inverse of the given matrix, use TransformNormalInverse if you already have the inverse to avoid this extra calculation

Parameters

norm	The normal to transform
mat	The desired transformation
result	The transformed normal

static Vector3f makVrl.Vector3f.TransformNormalInverse	(	Vector3f	norm,
		Matrix4	invMat
	)

inlinestatic

Transform a Normal by the (transpose of the) given Matrix

This version doesn't calculate the inverse matrix. Use this version if you already have the inverse of the desired transform to hand

Parameters

norm	The normal to transform
invMat	The inverse of the desired transformation

Returns: The transformed normal

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Vector3f.Vector3f().

Referenced by makVrl.Vector3f.TransformNormal().

static void makVrl.Vector3f.TransformNormalInverse	(	ref Vector3f	norm,
		ref Matrix4	invMat,
		out Vector3f	result
	)

inlinestatic

Transform a Normal by the (transpose of the) given Matrix

This version doesn't calculate the inverse matrix. Use this version if you already have the inverse of the desired transform to hand

Parameters

norm	The normal to transform
invMat	The inverse of the desired transformation
result	The transformed normal

static Vector3f makVrl.Vector3f.TransformPerspective	(	Vector3f	vec,
		Matrix4	mat
	)

inlinestatic

Transform a Vector3 by the given Matrix, and project the resulting Vector4 back to a Vector3

Parameters

vec	The vector to transform
mat	The desired transformation

Returns: The transformed vector

static void makVrl.Vector3f.TransformPerspective	(	ref Vector3f	vec,
		ref Matrix4	mat,
		out Vector3f	result
	)

inlinestatic

Transform a Vector3 by the given Matrix, and project the resulting Vector4 back to a Vector3

Parameters

vec	The vector to transform
mat	The desired transformation
result	The transformed vector

static Vector3f makVrl.Vector3f.TransformPosition	(	Vector3f	pos,
		Matrix4	mat
	)

inlinestatic

Transform a Position by the given Matrix

Parameters

pos	The position to transform
mat	The desired transformation

Returns: The transformed position

References makVrl.Matrix4.Column0, makVrl.Matrix4.Column1, makVrl.Matrix4.Column2, makVrl.Vector3f.Dot(), makVrl.Matrix4.Row3, makVrl.Vector3f.Vector3f(), makVrl.Vector4.X, makVrl.Vector3f.Y, and makVrl.Vector4.Z.

static void makVrl.Vector3f.TransformPosition	(	ref Vector3f	pos,
		ref Matrix4	mat,
		out Vector3f	result
	)

inlinestatic

Transform a Position by the given Matrix

Parameters

pos	The position to transform
mat	The desired transformation
result	The transformed position

static Vector3f makVrl.Vector3f.TransformVector	(	Vector3f	vec,
		Matrix4	mat
	)

inlinestatic

Transform a direction vector by the given Matrix Assumes the matrix has a bottom row of (0,0,0,1), that is the translation part is ignored.

Parameters

vec	The vector to transform
mat	The desired transformation

Returns: The transformed vector

References makVrl.Matrix4.Column0, makVrl.Matrix4.Column1, makVrl.Matrix4.Column2, and makVrl.Vector3f.Vector3f().

static void makVrl.Vector3f.TransformVector	(	ref Vector3f	vec,
		ref Matrix4	mat,
		out Vector3f	result
	)

inlinestatic

Transform a direction vector by the given Matrix Assumes the matrix has a bottom row of (0,0,0,1), that is the translation part is ignored.

Parameters

vec	The vector to transform
mat	The desired transformation
result	The transformed vector

Member Data Documentation

string makVrl.Vector3f.listSeparator = System.Globalization.CultureInfo.CurrentCulture.TextInfo.ListSeparator

staticprivate

Referenced by makVrl.Vector3f.ToString().

readonly Vector3f makVrl.Vector3f.One = new Vector3f(1, 1, 1)

static

Defines an instance with all components set to 1.

readonly int makVrl.Vector3f.SizeInBytes = Marshal.SizeOf(new Vector3f())

static

Defines the size of the Vector3 struct in bytes.

readonly Vector3f makVrl.Vector3f.UnitX = new Vector3f(1, 0, 0)

static

Defines a unit-length Vector3 that points towards the X-axis.

Referenced by makVrl.Quaternion.ToAxisAngle().

readonly Vector3f makVrl.Vector3f.UnitY = new Vector3f(0, 1, 0)

static

Defines a unit-length Vector3 that points towards the Y-axis.

readonly Vector3f makVrl.Vector3f.UnitZ = new Vector3f(0, 0, 1)

static

/// Defines a unit-length Vector3 that points towards the Z-axis.

float makVrl.Vector3f.X

The X component of the Vector3.

Referenced by makVrl.Matrix4.CreateTranslation(), makVrl.Vector3f.Equals(), makVrl.Vector3f.Lerp(), makVrl.Vector3f.Normalize(), makVrl.Vector3f.NormalizeFast(), makVrl.TaitBryan.operator TaitBryan(), makVrl.Vector3d.operator Vector3d(), makVrl.Vector3f.Scale(), makVrl.Matrix4.Scale(), makVrl.Vector3f.ToString(), and makVrl.Vector3f.Vector3f().

float makVrl.Vector3f.Y

The Y component of the Vector3.

Referenced by makVrl.Matrix4.CreateTranslation(), makVrl.Vector3f.Equals(), makVrl.Vector3f.GetHashCode(), makVrl.Vector3f.Lerp(), makVrl.Matrix4.LookAt(), makVrl.Vector3f.Normalize(), makVrl.Vector3f.NormalizeFast(), makVrl.TaitBryan.operator TaitBryan(), makVrl.Vector3d.operator Vector3d(), makVrl.Vector3f.Scale(), makVrl.Matrix4.Scale(), makVrl.Vector3f.ToString(), makVrl.Vector3f.TransformPosition(), and makVrl.Vector3f.Vector3f().

float makVrl.Vector3f.Z

The Z component of the Vector3.

Referenced by makVrl.Matrix4.CreateTranslation(), makVrl.Vector3f.Equals(), makVrl.Vector3f.Lerp(), makVrl.Vector3f.Normalize(), makVrl.Vector3f.NormalizeFast(), makVrl.TaitBryan.operator TaitBryan(), makVrl.Vector3d.operator Vector3d(), makVrl.Vector3f.Scale(), makVrl.Matrix4.Scale(), makVrl.Vector3f.ToString(), and makVrl.Vector3f.Vector3f().

readonly Vector3f makVrl.Vector3f.Zero = new Vector3f(0, 0, 0)

static

Defines a zero-length Vector3.

Referenced by makVrl.Matrix4.ClearTranslation(), makVrl.EmitterStateRepository.EmitterStateRepository(), makVrl.IffStateRepository.IffStateRepository(), and makVrl.JsonObject.operator Vector3f().

Property Documentation

float makVrl.Vector3f.Length

get

Gets the length (magnitude) of the vector.

LengthFast

See Also: LengthSquared

Referenced by makVrl.Matrix3.ClearRotation(), makVrl.Matrix4.ClearRotation(), makVrl.Matrix3.ExtractScale(), and makVrl.Matrix4.ExtractScale().

float makVrl.Vector3f.LengthFast

get

Gets an approximation of the vector length (magnitude).

This property uses an approximation of the square root function to calculate vector magnitude, with an upper error bound of 0.001.

Length

See Also: LengthSquared

float makVrl.Vector3f.LengthSquared

get

Gets the square of the vector length (magnitude).

This property avoids the costly square root operation required by the Length property. This makes it more suitable for comparisons.

Length

See Also: LengthFast

Referenced by makVrl.Quaternion.FromAxisAngle().

float makVrl.Vector3f.this[int index]

getset

Gets or sets the value at the index of the Vector.

Vector2 makVrl.Vector3f.Xy

getset

Gets or sets an makVrl.Vector2 with the X and Y components of this instance.

Vector2 makVrl.Vector3f.Xz

getset

Gets or sets an makVrl.Vector2 with the X and Z components of this instance.

Vector3f makVrl.Vector3f.Xzy

getset

Gets or sets an makVrl.Vector3 with the X, Z, and Y components of this instance.

Vector2 makVrl.Vector3f.Yx

getset

Gets or sets an makVrl.Vector2 with the Y and X components of this instance.

Vector3f makVrl.Vector3f.Yxz

getset

Gets or sets an makVrl.Vector3 with the Y, X, and Z components of this instance.

Vector2 makVrl.Vector3f.Yz

getset

Gets or sets an makVrl.Vector2 with the Y and Z components of this instance.

Vector3f makVrl.Vector3f.Yzx

getset

Gets or sets an makVrl.Vector3 with the Y, Z, and X components of this instance.

Vector2 makVrl.Vector3f.Zx

getset

Gets or sets an makVrl.Vector2 with the Z and X components of this instance.

Vector3f makVrl.Vector3f.Zxy

getset

Gets or sets an makVrl.Vector3 with the Z, X, and Y components of this instance.

Vector2 makVrl.Vector3f.Zy

getset

Gets or sets an makVrl.Vector2 with the Z and Y components of this instance.

Vector3f makVrl.Vector3f.Zyx

getset

Gets or sets an makVrl.Vector3 with the Z, Y, and X components of this instance.

The documentation for this struct was generated from the following file:

Vector3f.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation