VEE_Gravitate Class Reference

An abstract particle that pulls other particles towards itself. More...

#include <vee_gravitate.h>

Inheritance diagram for VEE_Gravitate:

[legend]Collaboration diagram for VEE_Gravitate:

[legend]List of all members.

Public Member Functions

• VEE_Gravitate ()
• VEE_Gravitate (VEE_Vector3 location, VEE_Vector3 velocity, float ageLimit, float m, bool updateVelocity=false)
• ~VEE_Gravitate ()
• 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_Object * clone () const
• float epsilon ()
• float magnitude ()
• void setEpsilon (float e)
• void setMagnitude (float m)
• void setRange (float r)
• void setDecayPower (float decay)

  Sets the decay speed of the force [0 - inf].
  

• void getForce (VEE_Vector3 *force, const VEE_Vector3 &, const VEE_Vector3 &location)
• void boundingBoxOfForce (VEE_BoundingBox *box)

  Get the bounding box of this force object.
  

Static Public Member Functions

• static VEE_Object * factory ()

Protected Attributes

• float m_epsilon
• float m_magnitude
• float m_decayPower
• float m_range
• float m_maxForce

---

Detailed Description

An abstract particle that pulls other particles towards itself.

---

Constructor & Destructor Documentation

VEE_Gravitate::VEE_Gravitate (   )

VEE_Gravitate::VEE_Gravitate (  VEE_Vector3  location, VEE_Vector3  velocity, float  ageLimit, float  m, bool  updateVelocity = false )

VEE_Gravitate::~VEE_Gravitate (   )  [inline]

---

Member Function Documentation

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

Receive and process a value. Parameters: "decaypower", float, range: 0 to inf "epsilon", float, range: 0 to inf "magnitude", float, range: -inf to inf "range", float, range: 0 to inf "maxforce", float, range: -inf to inf Reimplemented from VEE_ForceObject.

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

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

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

Reimplemented from VEE_Particle2.

float VEE_Gravitate::epsilon (   )  [inline]

float VEE_Gravitate::magnitude (   )  [inline]

void VEE_Gravitate::setEpsilon (  float  e  )  [inline]

void VEE_Gravitate::setMagnitude (  float  m  )  [inline]

void VEE_Gravitate::setRange (  float  r  )  [inline]

void VEE_Gravitate::setDecayPower (  float  decay  )  [inline]

Sets the decay speed of the force [0 - inf].

void VEE_Gravitate::getForce (  VEE_Vector3 *  force, const VEE_Vector3 &  , const VEE_Vector3 &  location )  [virtual]

Implements VEE_ForceObject.

void VEE_Gravitate::boundingBoxOfForce (  VEE_BoundingBox *  box  )  [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). Implements VEE_ForceObject.

VEE_Object * VEE_Gravitate::factory (   )  [static]

Reimplemented from VEE_Particle.

---

Member Data Documentation

float VEE_Gravitate::m_epsilon [protected]

float VEE_Gravitate::m_magnitude [protected]

float VEE_Gravitate::m_decayPower [protected]

float VEE_Gravitate::m_range [protected]

float VEE_Gravitate::m_maxForce [protected]

---

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

• vee_gravitate.h
• vee_gravitate.C

---