VEE_Object Class Reference

Base class for both visual and non-visual classes that do have a location. More...

#include <vee_object.h>

Inheritance diagram for VEE_Object:

[legend]Collaboration diagram for VEE_Object:

[legend]List of all members.

Public Member Functions

• void addCheckCount ()
• void subCheckCount ()
• void addCheckCount ()
• void subCheckCount ()
• VEE_Object ()
• VEE_Object (VEE_SceneBox *box)
• VEE_Object (const VEE_Object &)
• VEE_Object (const VEE_Vector3 &location, const VEE_Vector3 &velocity, float ageLimit=1e+10)
• VEE_Object (const VEE_Vector3 &location, float ageLimit=1e+10)
• virtual ~VEE_Object ()
• virtual VEE_Object * clone () const =0
• virtual bool setValue (const char *, VEE_Value *)

  Receive and process a value.
  

• virtual VEE_Variable getVariable (const char *) const

  This method needs to be overridden if the child class wants to return its values.
  

• VEE_SceneBox * sceneBox ()
• void setSceneBox (VEE_SceneBox *b)
• virtual void update (float)

  Update the location of this object.
  

• virtual void updateVelocity (float)

  Get forces acting on this objects and add these vectors to velocity.
  

• virtual void collision (const VEE_Vector3 &)
• void setVelocityUpdate (bool p)
• float age ()
• void setAge (float age)
• float ageLimit ()
• void setAgeLimit (float ageLimit)
• void setMass (float m)

  is usually set between 0.0 and 1.0 but can be negative too
  

• void setArea (float a)
• float mass () const
• float area () const
• virtual void render (VEE_Renderer *)=0
• bool done () const
• void setDone (bool done)
• const char * className () const
• int objectType () const

  Usually one of VEE_ObjectType.
  

Static Public Member Functions

• static long count ()

Protected Attributes

• VEE_SceneBox * m_sceneBox

  Location in the scene.
  

• bool m_updateVelocity
• float m_age
• float m_ageLimit
• float m_mass

  default 1.0
  

• float m_area

  default 1.0
  

• int m_objectType
• bool m_done

Static Protected Attributes

• static long m_count = 0

  The number of VEE_Object instances floating around.
  

---

Detailed Description

Base class for both visual and non-visual classes that do have a location.

Author:

Tommi Ilmonen

---

Constructor & Destructor Documentation

VEE_Object::VEE_Object (   )

VEE_Object::VEE_Object (  VEE_SceneBox *  box  )

VEE_Object::VEE_Object (  const VEE_Object &   )

VEE_Object::VEE_Object (  const VEE_Vector3 &  location, const VEE_Vector3 &  velocity, float  ageLimit = 1e+10 )

VEE_Object::VEE_Object (  const VEE_Vector3 &  location, float  ageLimit = 1e+10 )

virtual VEE_Object::~VEE_Object (   )  [inline, virtual]

---

Member Function Documentation

void VEE_Object::addCheckCount (   )  [inline]

void VEE_Object::subCheckCount (   )  [inline]

void VEE_Object::addCheckCount (   )  [inline]

void VEE_Object::subCheckCount (   )  [inline]

static long VEE_Object::count (   )  [inline, static]

virtual VEE_Object* VEE_Object::clone (   )  const [pure virtual]

Implemented in VEE_Blow, VEE_CurveParticle, VEE_Damping, VEE_Emitter, VEE_Explosion, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_OperatorObject, VEE_Particle, VEE_Particle2, VEE_Polygon, VEE_RandomForce, VEE_TailParticle, VEE_TailParticle2, VEE_TailParticle3, VEE_Tube, VEE_Vortex, VEE_Wind, VEE_MagicRainDrop, VEE_MagicRain, VEE_PolygonFire, VEE_GridForce, VEE_GridForce2, VEE_OpcodeCollision, and VEE_RigidParticle.

bool VEE_Object::setValue (  const char *  id, VEE_Value *  msg )  [virtual]

Receive and process a value. Parameters: "age", float, range: 0 to inf "agelimit", float, range: 0 to inf "location", Vector3 "addlocation", Vector3 "velocity", Vector3 "addvelocity", Vector3 "mass", float, range: -1 to 1 "area", float, range: -1 to 1 "color", Vector3 "done", bool (int), range: true or false (1 or 0) Reimplemented from VEE_HasValues. Reimplemented in VEE_Blow, VEE_CurveParticle, VEE_Damping, VEE_Emitter, VEE_Explosion, VEE_ForceObject, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_Particle, VEE_Particle2, VEE_Polygon, VEE_RandomForce, VEE_TailParticle, VEE_TailParticle2, VEE_TailParticle3, VEE_Tube, VEE_Vortex, VEE_Wind, VEE_MagicRainDrop, VEE_MagicRain, VEE_PolygonFire, VEE_GridForceBase, VEE_OpcodeCollision, and VEE_RigidParticle.

VEE_Variable VEE_Object::getVariable (  const char *   )  const [virtual]

This method needs to be overridden if the child class wants to return its values. Reimplemented from VEE_HasVariables. Reimplemented in VEE_CurveParticle, VEE_Emitter, VEE_Explosion, VEE_ForceObject, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_Particle, VEE_RandomForce, VEE_TailParticle, VEE_TailParticle2, VEE_TailParticle3, VEE_Tube, VEE_Vortex, VEE_Wind, VEE_GridForceBase, and VEE_OpcodeCollision.

VEE_SceneBox* VEE_Object::sceneBox (   )  [inline]

void VEE_Object::setSceneBox (  VEE_SceneBox *  b  )  [inline]

void VEE_Object::update (  float   )  [virtual]

Update the location of this object. Reimplemented in VEE_Blow, VEE_CurveParticle, VEE_Emitter, VEE_Explosion, VEE_ForceObject, VEE_Gravity, VEE_OperatorObject, VEE_Particle, VEE_Particle2, VEE_Polygon, VEE_TailParticle, VEE_TailParticle2, VEE_TailParticle3, VEE_Vortex, VEE_Wind, VEE_MagicRainDrop, VEE_MagicRain, VEE_PolygonFire, VEE_GridForce, VEE_GridForce2, and VEE_OpcodeCollision.

void VEE_Object::updateVelocity (  float   )  [virtual]

Get forces acting on this objects and add these vectors to velocity. Reimplemented in VEE_CurveParticle, VEE_Gravity, and VEE_Polygon.

void VEE_Object::collision (  const VEE_Vector3 &   )  [virtual]

Reimplemented in VEE_Emitter.

void VEE_Object::setVelocityUpdate (  bool  p  )  [inline]

Reimplemented in VEE_MagicRainDrop.

float VEE_Object::age (   )  [inline]

void VEE_Object::setAge (  float  age  )  [inline]

float VEE_Object::ageLimit (   )  [inline]

void VEE_Object::setAgeLimit (  float  ageLimit  )  [inline]

void VEE_Object::setMass (  float  m  )  [inline]

is usually set between 0.0 and 1.0 but can be negative too

void VEE_Object::setArea (  float  a  )  [inline]

float VEE_Object::mass (   )  const [inline]

float VEE_Object::area (   )  const [inline]

virtual void VEE_Object::render (  VEE_Renderer *   )  [pure virtual]

Implemented in VEE_ForceObject, VEE_Particle, VEE_Polygon, VEE_MagicRain, and VEE_OpcodeCollision.

bool VEE_Object::done (   )  const [inline]

void VEE_Object::setDone (  bool  done  )  [inline]

const char * VEE_Object::className (   )  const

int VEE_Object::objectType (   )  const [inline]

Usually one of VEE_ObjectType.

---

Member Data Documentation

VEE_SceneBox* VEE_Object::m_sceneBox [protected]

Location in the scene.

bool VEE_Object::m_updateVelocity [protected]

float VEE_Object::m_age [protected]

float VEE_Object::m_ageLimit [protected]

float VEE_Object::m_mass [protected]

default 1.0

float VEE_Object::m_area [protected]

default 1.0

int VEE_Object::m_objectType [protected]

bool VEE_Object::m_done [protected]

long VEE_Object::m_count = 0 [static, protected]

The number of VEE_Object instances floating around. If the system runs with threads, then this variable may get random values even tough the system behaves correctly. Reimplemented in VEE_Emitter.

---

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

• vee_object.h
• vee_object.C

---