OpenGUI::FVector2

OpenGUI::FVector2 Class Reference
[Types]

#include <OpenGUI_Types.h>

List of all members.

Detailed Description

The FVector2 is a two dimensional vector based on floats.

This object often represents a screen coordinate starting from the upper left corner of the screen. The value a FVector2 represents is very much an issue of context. In the rendering areas of OpenGUI, a FVector2 is quite often a representation of screen position between 0,0 (upper left) and 1,1 (lower right).


Public Member Functions

 FVector2 ()
 constructor
 FVector2 (float x, float y)
 constructor
FVector2 operator+ (const FVector2 &right) const
 operator +
FVector2 operator- (const FVector2 &right) const
 operator -
FVector2 operator * (const FVector2 &right) const
 operator *
FVector2 operator/ (const FVector2 &right) const
 operator /
FVector2 & operator+= (const FVector2 &right)
 operator +=
FVector2 & operator-= (const FVector2 &right)
 operator -=
FVector2 & operator *= (const FVector2 &right)
 operator *=
FVector2 & operator/= (const FVector2 &right)
 operator /=
bool operator== (const FVector2 &right) const
 comparison operator
bool operator!= (const FVector2 &right) const
 comparison operator
FVector2 operator- () const
 returns inverse FVector2 -x,-y
FVector2 pixelAligned (const IVector2 &resolution) const
 Returns a pixel aligned copy of this FVector2.
float length ()
 Returns the length of vector.
FVector2 operator- ()
 inverse operator
String toStr () const
 Return a string representation of this value.

Public Attributes

float x
 direct access to x
float y
 direct access to y

Constructor & Destructor Documentation

OpenGUI::FVector2::FVector2 (   )  [inline]
 

constructor

OpenGUI::FVector2::FVector2 (  float  x,
float  y
)  [inline]
 

constructor

Member Function Documentation

float OpenGUI::FVector2::length (   )  [inline]
 

Returns the length of vector.

FVector2 OpenGUI::FVector2::operator * (  const FVector2 &  right  )  const [inline]
 

operator *

FVector2& OpenGUI::FVector2::operator *= (  const FVector2 &  right  )  [inline]
 

operator *=

bool OpenGUI::FVector2::operator!= (  const FVector2 &  right  )  const [inline]
 

comparison operator

FVector2 OpenGUI::FVector2::operator+ (  const FVector2 &  right  )  const [inline]
 

operator +

FVector2& OpenGUI::FVector2::operator+= (  const FVector2 &  right  )  [inline]
 

operator +=

FVector2 OpenGUI::FVector2::operator- (   )  [inline]
 

inverse operator

FVector2 OpenGUI::FVector2::operator- (   )  const [inline]
 

returns inverse FVector2 -x,-y

FVector2 OpenGUI::FVector2::operator- (  const FVector2 &  right  )  const [inline]
 

operator -

FVector2& OpenGUI::FVector2::operator-= (  const FVector2 &  right  )  [inline]
 

operator -=

FVector2 OpenGUI::FVector2::operator/ (  const FVector2 &  right  )  const [inline]
 

operator /

FVector2& OpenGUI::FVector2::operator/= (  const FVector2 &  right  )  [inline]
 

operator /=

bool OpenGUI::FVector2::operator== (  const FVector2 &  right  )  const [inline]
 

comparison operator

FVector2 OpenGUI::FVector2::pixelAligned (  const IVector2 &  resolution  )  const [inline]
 

Returns a pixel aligned copy of this FVector2.

String OpenGUI::FVector2::toStr (   )  const
 

Return a string representation of this value.

Member Data Documentation

float OpenGUI::FVector2::x
 

direct access to x

float OpenGUI::FVector2::y
 

direct access to y

The documentation for this class was generated from the following files:
Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Sun Sep 9 02:00:22 2007