VEE_ForceObject Class Reference

Base class for force objects. More...

#include <vee_force_object.h>

Inheritance diagram for VEE_ForceObject:

[legend]Collaboration diagram for VEE_ForceObject:

[legend]List of all members.

Public Types

• typedef VEE_PointerStoreSet<
  VEE_SceneBox > boxStore

Public Member Functions

• VEE_ForceObject ()

  Default force type is gravity.
  

• VEE_ForceObject (const VEE_Vector3 &location, const VEE_Vector3 &velocity, float ageLimit=1e+10)
• VEE_ForceObject (const VEE_Vector3 &location, float ageLimit=1e+10)
• virtual ~VEE_ForceObject ()
• 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.
  

• virtual VEE_Vector3 * centralLocation ()
• virtual void setForceType (VEE_ForceType t)
• virtual VEE_ForceType getForceType ()
• virtual void getForce (VEE_Vector3 *force, const VEE_Vector3 &velocity, const VEE_Vector3 &location)=0
• virtual void boundingBoxOfForce (VEE_BoundingBox *box)=0

  Get the bounding box of this force object.
  

• virtual void render (VEE_Renderer *)
• virtual void update (float dt)

  Update the location of this object.
  

• void linkBox (VEE_SceneBox *)
• void unlinkBox (VEE_SceneBox *)
• void unlinkBoxes ()
• void forgetLinks ()
• bool isLinked (VEE_SceneBox *b)
• void updateSceneLocation (int frame)
• boxStore & boxes ()
• bool renderAsForce () const

Protected Attributes

• VEE_ForceType m_forceType
• boxStore m_boxes
• bool m_moved
• bool m_renderAsForce
• int m_lastUpdateFrame

---

Detailed Description

Base class for force objects.

Author:

Tommi Ilmonen

---

Member Typedef Documentation

typedef VEE_PointerStoreSet<VEE_SceneBox> VEE_ForceObject::boxStore

---

Constructor & Destructor Documentation

VEE_ForceObject::VEE_ForceObject (   )  [inline]

Default force type is gravity.

VEE_ForceObject::VEE_ForceObject (  const VEE_Vector3 &  location, const VEE_Vector3 &  velocity, float  ageLimit = 1e+10 )  [inline]

VEE_ForceObject::VEE_ForceObject (  const VEE_Vector3 &  location, float  ageLimit = 1e+10 )  [inline]

VEE_ForceObject::~VEE_ForceObject (   )  [virtual]

---

Member Function Documentation

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

Receive and process a value. Parameters: "forcetype", int (VEE_ForceType) Reimplemented from VEE_Particle2. Reimplemented in VEE_Blow, VEE_Damping, VEE_Explosion, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_RandomForce, VEE_Tube, VEE_Vortex, VEE_Wind, and VEE_GridForceBase.

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

This method needs to be overridden if the child class wants to return its values. Reimplemented from VEE_Particle. Reimplemented in VEE_Explosion, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_RandomForce, VEE_Tube, VEE_Vortex, VEE_Wind, and VEE_GridForceBase.

virtual VEE_Vector3* VEE_ForceObject::centralLocation (   )  [inline, virtual]

virtual void VEE_ForceObject::setForceType (  VEE_ForceType  t  )  [inline, virtual]

virtual VEE_ForceType VEE_ForceObject::getForceType (   )  [inline, virtual]

virtual void VEE_ForceObject::getForce (  VEE_Vector3 *  force, const VEE_Vector3 &  velocity, const VEE_Vector3 &  location )  [pure virtual]

Implemented in VEE_Blow, VEE_Damping, VEE_Explosion, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_RandomForce, VEE_Tube, VEE_Vortex, VEE_Wind, VEE_GridForceBase, VEE_GridForce, and VEE_GridForce2.

virtual void VEE_ForceObject::boundingBoxOfForce (  VEE_BoundingBox *  box  )  [pure virtual]

Get the bounding box of this force object. Outside the bounding box the force must be zero. This method is needed since the scene boxes need to be able to determine where in the scene hierarchy the force object should be registered (VEE_SceneBox::m_forceObjects). Implemented in VEE_Blow, VEE_Damping, VEE_Explosion, VEE_ForcePlane, VEE_Gravitate, VEE_Gravity, VEE_RandomForce, VEE_Tube, VEE_Vortex, VEE_Wind, VEE_GridForceBase, VEE_GridForce, and VEE_GridForce2.

void VEE_ForceObject::render (  VEE_Renderer *   )  [virtual]

Reimplemented from VEE_Particle.

void VEE_ForceObject::update (  float  dt  )  [virtual]

Update the location of this object. Reimplemented from VEE_Particle2. Reimplemented in VEE_Blow, VEE_Explosion, VEE_Gravity, VEE_Vortex, VEE_Wind, VEE_GridForce, and VEE_GridForce2.

void VEE_ForceObject::linkBox (  VEE_SceneBox *   )

void VEE_ForceObject::unlinkBox (  VEE_SceneBox *   )

void VEE_ForceObject::unlinkBoxes (   )

void VEE_ForceObject::forgetLinks (   )  [inline]

bool VEE_ForceObject::isLinked (  VEE_SceneBox *  b  )  [inline]

void VEE_ForceObject::updateSceneLocation (  int  frame  )

boxStore& VEE_ForceObject::boxes (   )  [inline]

bool VEE_ForceObject::renderAsForce (   )  const [inline]

---

Member Data Documentation

VEE_ForceType VEE_ForceObject::m_forceType [protected]

boxStore VEE_ForceObject::m_boxes [protected]

bool VEE_ForceObject::m_moved [protected]

bool VEE_ForceObject::m_renderAsForce [protected]

int VEE_ForceObject::m_lastUpdateFrame [protected]

---

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

• vee_force_object.h
• vee_force_object.C

---