IOLink.Vector2f Class Reference

An arithmetic vector. More...

Inheritance diagram for IOLink.Vector2f:

Public Member Functions
	Vector2f (global::System.IntPtr cPtr, bool cMemoryOwn)
void	Dispose ()
	Vector2f (params float[] values)
override bool	Equals (object obj)
	Vector2f ()
	Create a vector with unitialized values.
	Vector2f (VectorXf other)
	Build a Vector from a VectorX of same type.
	Vector2f (VectorXf other, float padding)
	Build a vector from a VectorX of same type.
	Vector2f (Vector2f other)
uint	Size ()
	Returns the size of the vector, which also correspond to vector number of dimension.
float	At (uint index)
	Access vector's value at given index.
void	SetAt (uint index, float value)
	Set value as given index.
double	SquaredLength ()
	Returns the vector's norm, squared.
double	Length ()
	Returns the vector's norm.
void	Normalize ()
	Normalize the vector.
string	ToString ()
float	Dot (Vector2f v)
	Dot product of two vectors.
Vector2f	Cross (Vector2f v)
	Cross product of two vectors.

Static Public Member Functions
static global::System.Runtime.InteropServices.HandleRef	getCPtr (Vector2f obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (Vector2f obj)
static bool	operator== (Vector2f v1, Vector2f v2)
static bool	operator!= (Vector2f v1, Vector2f v2)
static Vector2f	operator+ (Vector2f v1, Vector2f v2)
static Vector2f	operator- (Vector2f v1, Vector2f v2)
static Vector2f	operator* (Vector2f v, float value)
static Vector2f	operator* (float value, Vector2f v)
static Vector2f	operator/ (Vector2f v, float value)
static Vector2f	operator* (Vector2f v1, Vector2f v2)
static Vector2f	operator/ (Vector2f v1, Vector2f v2)
static bool	operator< (Vector2f v1, Vector2f v2)
static bool	operator<= (Vector2f v1, Vector2f v2)
static bool	operator> (Vector2f v1, Vector2f v2)
static bool	operator>= (Vector2f v1, Vector2f v2)
static Vector2f	CreateUniform (float value)
	Create a vector with the given value for all components.
static Vector2f	InternalDivides (Vector2f v, float value)
static Vector2f	InternalDivides (Vector2f v1, Vector2f v2)
static bool	InternalLess (Vector2f v1, Vector2f v2)
static bool	InternalLessEqual (Vector2f v1, Vector2f v2)
static bool	InternalGreater (Vector2f v1, Vector2f v2)
static bool	InternalGreaterEqual (Vector2f v1, Vector2f v2)

Protected Member Functions
virtual void	Dispose (bool disposing)

Protected Attributes
bool	swigCMemOwn

Properties
float	this[uint index] [get, set]

Detailed Description

An arithmetic vector.

Parameters

T	The type wrote in the vector.
N	The size, or number of dimension of the vector.

Aliases can be used to made this class more practical to use. They use the following convention: VectorNX Where N is the size and X the type. The types currently available are:

• U8 and I8 respectively for unsigned and signed 8bits integers.
• U16 and I16 respectively for unsigned and signed 16bits integers.
• U32 and I32 respectively for unsigned and signed 32bits integers.
• U64 and I64 respectively for unsigned and signed 64bits integers.
• F for single precision floats.
• D for double precision floats.

Examples:

• Vector2i32: 2 dimensional 32bits signed integer.
• Vector3f: 3 dimensionnal single precision float.

Examples

GradientFloatToInt.cs.

Constructor & Destructor Documentation

Vector2f() [1/2]

IOLink.Vector2f.Vector2f ( VectorXf  other )

inline

Build a Vector from a VectorX of same type.

If the VectorX has a size different of N, behavior is undefined.

Vector2f() [2/2]

IOLink.Vector2f.Vector2f ( VectorXf  other, float  padding  )

inline

Build a vector from a VectorX of same type.

Parameters

other	VectorX to use to build the new vector
padding	Value to put at the end of vector to fill missing values. Fox example, Vector4({4, 5}, 0) will create the Vector {4, 5, 0, 0}.

Member Function Documentation

CreateUniform()

static Vector2f IOLink.Vector2f.CreateUniform ( float  value )

inlinestatic

Create a vector with the given value for all components.

Parameters

value

The value wich the vector's data will be filled.

Cross()

Vector2f IOLink.Vector2f.Cross ( Vector2f  v )

inline

Cross product of two vectors.

Work only for vectors of size 3.

Length()

double IOLink.Vector2f.Length ( )

inline

Returns the vector's norm.

Specifically, it is the L1 norm that's computed here.

SquaredLength()

double IOLink.Vector2f.SquaredLength ( )

inline

Returns the vector's norm, squared.

Specifically, it is the L1 norm that's computed here.

---

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

• Release/net/generated/Vector2f.cs