VEE_Variable Class Reference

A variable (or pointer to a variable). More...

#include <vee_variable.h>

Collaboration diagram for VEE_Variable:

[legend]List of all members.

Public Member Functions

• VEE_Variable ()
• ~VEE_Variable ()
• bool isNumber () const
• VEE_VariableType type () const

  Returns the type of the variable.
  

• bool isValid () const
• float getFloat (float def=0.0) const
• const float * getFloatPtr () const
• int getInt (int def=0) const
• const int * getIntPtr () const
• const VEE_Rgba & getRgba (const VEE_Rgba &def=VEE_Rgba::White)
• const VEE_Vector3 & getVector3 (const VEE_Vector3 &def=VEE_Vector3ZERO) const
• const VEE_Matrix3 & getMatrix3 (const VEE_Matrix3 &def=VEE_Matrix3IDENTITY)
• void setFloat (float v)
• void setFloatPtr (const float *v)
• void setInt (int v)
• void setIntPtr (const int *v)
• void setRgba (const VEE_Rgba &v)
• void setVector3 (const VEE_Vector3 &v)
• void setVector3Ptr (const VEE_Vector3 *v)
• void setMatrix3 (const VEE_Matrix3 &v)

  Link the matrix to this varible.
  

• VEE_Variable & operator= (float v)
• VEE_Variable & operator= (const float *v)
• VEE_Variable & operator= (int v)
• VEE_Variable & operator= (const int *v)
• VEE_Variable & operator= (const VEE_Vector3 &v)
• VEE_Variable & operator= (const VEE_Vector3 *v)
• VEE_Variable & operator= (const VEE_Rgba &v)
• VEE_Variable & operator= (const VEE_Matrix3 &v)

Protected Attributes

• VEE_VariableType m_type
• __VEE_Variable m_val

---

Detailed Description

A variable (or pointer to a variable).

This class is used to transmit data from the objects to hosting algorithms that may want to do calculus based on the variables.

---

Constructor & Destructor Documentation

VEE_Variable::VEE_Variable (   )  [inline]

VEE_Variable::~VEE_Variable (   )  [inline]

---

Member Function Documentation

bool VEE_Variable::isNumber (   )  const [inline]

VEE_VariableType VEE_Variable::type (   )  const [inline]

Returns the type of the variable.

bool VEE_Variable::isValid (   )  const [inline]

float VEE_Variable::getFloat (  float  def = 0.0  )  const [inline]

const float * VEE_Variable::getFloatPtr (   )  const [inline]

int VEE_Variable::getInt (  int  def = 0  )  const [inline]

const int * VEE_Variable::getIntPtr (   )  const [inline]

const VEE_Rgba& VEE_Variable::getRgba (  const VEE_Rgba &  def = VEE_Rgba::White  )  [inline]

const VEE_Vector3 & VEE_Variable::getVector3 (  const VEE_Vector3 &  def = VEE_Vector3ZERO  )  const [inline]

const VEE_Matrix3& VEE_Variable::getMatrix3 (  const VEE_Matrix3 &  def = VEE_Matrix3IDENTITY  )  [inline]

void VEE_Variable::setFloat (  float  v  )  [inline]

void VEE_Variable::setFloatPtr (  const float *  v  )  [inline]

void VEE_Variable::setInt (  int  v  )  [inline]

void VEE_Variable::setIntPtr (  const int *  v  )  [inline]

void VEE_Variable::setRgba (  const VEE_Rgba &  v  )  [inline]

void VEE_Variable::setVector3 (  const VEE_Vector3 &  v  )  [inline]

void VEE_Variable::setVector3Ptr (  const VEE_Vector3 *  v  )  [inline]

void VEE_Variable::setMatrix3 (  const VEE_Matrix3 &  v  )  [inline]

Link the matrix to this varible. Due to performance reasons the matrix is not copied, but only linked. Note that you must not delete the matrix (you cannot allocate from stack)

VEE_Variable& VEE_Variable::operator= (  float  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const float *  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  int  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const int *  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const VEE_Vector3 &  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const VEE_Vector3 *  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const VEE_Rgba &  v  )  [inline]

VEE_Variable& VEE_Variable::operator= (  const VEE_Matrix3 &  v  )  [inline]

---

Member Data Documentation

VEE_VariableType VEE_Variable::m_type [protected]

__VEE_Variable VEE_Variable::m_val [protected]

---

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

• vee_variable.h

---