Burger::FixedVector2D_t Struct Reference

2 dimensional fixed point vector More...

Public Member Functions
void	Zero (void)
	Initialize the vector elements to zero.
void	One (void)
	Initialize the vector elements to 1.0f (Fixed)
fixed16_16_t	GetX (void) const
	Return the x component of the vector.
fixed16_16_t	GetY (void) const
	Return the y component of the vector.
void	SetX (fixed16_16_t fX)
	Set the x component of the vector.
void	SetY (fixed16_16_t fY)
	Set the y component of the vector.
void	Set (fixed16_16_t fX, fixed16_16_t fY)
	Initialize the vector elements to specific values,.
void	Negate (void)
	Negate a 2D vector.
void	Negate (fixed16_16_t fX, fixed16_16_t fY)
	Negate the input and store it in this structure.
void	Negate (const FixedVector2D_t *pInput)
	Make a copy of the input after it's been negated.

Public Attributes
fixed16_16_t	x
	32 bit fixed point X value for the 2D Vector
fixed16_16_t	y
	32 bit fixed point Y value for the 2D Vector

Detailed Description

2 dimensional fixed point vector

---

This 8 byte vector contains x and y 32 bit fixed point coordinates. A set of common functions for simple 2 dimensional math are part of the structure.

It is expected to be 4 byte aligned and use scalar math. The members are hard coded to be "x" and "y" for maximum compatibility

Note

Since this is a structure, there is no constructor or destructor, so assume the data is uninitialized when creating this data type.

See also

Burger::FixedVector3D_t, Burger::FixedVector4D_t or Burger::Vector2D_t

Member Function Documentation

GetX()

fixed16_16_t Burger::FixedVector2D_t::GetX ( void ) const

inline

Return the x component of the vector.

---

Returns

The x component of the vector.

See also

GetY(void) const or SetX(fixed16_16_t)

GetY()

fixed16_16_t Burger::FixedVector2D_t::GetY ( void ) const

inline

Return the y component of the vector.

---

Returns

The y component of the vector.

See also

GetX(void) const or SetY(fixed16_16_t)

Negate() [1/3]

void Burger::FixedVector2D_t::Negate ( const FixedVector2D_t * pInput )

inline

Make a copy of the input after it's been negated.

---

Copy the input data and negate it.

Parameters

pInput

Valid pointer to a FixedVector2D_t structure to copy and negate

See also

Negate(fixed16_16_t,fixed16_16_t) or Negate(void)

Negate() [2/3]

void Burger::FixedVector2D_t::Negate ( fixed16_16_t fX, fixed16_16_t fY )

inline

Negate the input and store it in this structure.

---

Set the x and y value to -fX and -fY respectively

Parameters

fX	X value to negate
fY	Y value to negate

See also

Negate(const FixedVector2D_t *) or Negate(void)

Negate() [3/3]

void Burger::FixedVector2D_t::Negate ( void )

inline

Negate a 2D vector.

---

Set the x and y value to -x and -y respectively

See also

Negate(const FixedVector2D_t *) or Negate(fixed16_16_t,fixed16_16_t)

One()

void Burger::FixedVector2D_t::One ( void )

inline

Initialize the vector elements to 1.0f (Fixed)

---

Fills in all of the entries with zero, thereby initializing the structure to a known state.

See also

Set(fixed16_16_t,fixed16_16_t), SetX(fixed16_16_t) or SetY(fixed16_16_t)

Set()

void Burger::FixedVector2D_t::Set ( fixed16_16_t fX, fixed16_16_t fY )

inline

Initialize the vector elements to specific values,.

---

Given the new values for x and y, store them into the structure.

Parameters

fX	The new x component to store in the vector.
fY	The new y component to store in the vector.

See also

Zero(void), SetX(fixed16_16_t) or SetY(fixed16_16_t)

SetX()

void Burger::FixedVector2D_t::SetX ( fixed16_16_t fX )

inline

Set the x component of the vector.

---

Parameters

fX	The new x component of the vector.

See also

GetX(void) const or SetY(fixed16_16_t)

SetY()

void Burger::FixedVector2D_t::SetY ( fixed16_16_t fY )

inline

Set the y component of the vector.

---

Parameters

fY	The new y component of the vector.

See also

GetY(void) const or SetX(fixed16_16_t)

Zero()

void Burger::FixedVector2D_t::Zero ( void )

inline

Initialize the vector elements to zero.

---

Fills in all of the entries with zero, thereby initializing the structure to a known state.

See also

Set(fixed16_16_t,fixed16_16_t), SetX(fixed16_16_t) or SetY(fixed16_16_t)

Member Data Documentation

x

fixed16_16_t Burger::FixedVector2D_t::x

32 bit fixed point X value for the 2D Vector

y

fixed16_16_t Burger::FixedVector2D_t::y

32 bit fixed point Y value for the 2D Vector