VEE_Vortex Class Reference

Makes other particles rotate around given axes. More...

#include <vee_vortex.h>

Inheritance diagram for VEE_Vortex:

[legend]Collaboration diagram for VEE_Vortex:

[legend]List of all members.

Public Member Functions

• VEE_Vortex ()
• virtual ~VEE_Vortex ()
• 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 () const
• float magnitude () const
• void setEpsilon (float e)
• void setMagnitude (float m)
• void setRange (float r)
• void setHeight (float h)
• float getRange () const
• float height () const
• double vortexed () const
• void setAxes (float a1, float a2, float a3)
• void setAxes (const VEE_Vector3 &axes)
• VEE_Vector3 & getAxes ()
• virtual void update (float dt)

  Update the location of this object.
  

• void getForce (VEE_Vector3 *force, const VEE_Vector3 &velocity, 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

• VEE_Vector3 m_axes
• float m_magnitude
• float m_epsilon
• float m_range
• float m_height
• float m_fadeRange
• float m_maxForce
• float m_strength
• float m_radialForce
• float m_minRadius
• double m_vortexed
• bool m_useHeight

  If this is false, then any radius change will also set the height.
  

---

Detailed Description

Makes other particles rotate around given axes.

---

Constructor & Destructor Documentation

VEE_Vortex::VEE_Vortex (   )

VEE_Vortex::~VEE_Vortex (   )  [virtual]

---

Member Function Documentation

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

Receive and process a value. Parameters: "axes", Vector3 "epsilon", float, range: 0 to 1 "magnitude", float, range: 0 to inf "range", float, range: 0 to inf "strength", float, range: 0 to 1 "maxforce", float, range: 0 to inf "gravitate", float, range: 0 to inf Reimplemented from VEE_ForceObject.

VEE_Variable VEE_Vortex::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_Vortex::clone (   )  const [virtual]

Reimplemented from VEE_Particle2.

float VEE_Vortex::epsilon (   )  const [inline]

float VEE_Vortex::magnitude (   )  const [inline]

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

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

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

void VEE_Vortex::setHeight (  float  h  )  [inline]

float VEE_Vortex::getRange (   )  const [inline]

float VEE_Vortex::height (   )  const [inline]

double VEE_Vortex::vortexed (   )  const [inline]

void VEE_Vortex::setAxes (  float  a1, float  a2, float  a3 )

void VEE_Vortex::setAxes (  const VEE_Vector3 &  axes  )  [inline]

VEE_Vector3& VEE_Vortex::getAxes (   )  [inline]

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

Update the location of this object. Reimplemented from VEE_ForceObject.

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

Implements VEE_ForceObject.

void VEE_Vortex::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_Vortex::factory (   )  [static]

Reimplemented from VEE_Particle.

---

Member Data Documentation

VEE_Vector3 VEE_Vortex::m_axes [protected]

float VEE_Vortex::m_magnitude [protected]

float VEE_Vortex::m_epsilon [protected]

float VEE_Vortex::m_range [protected]

float VEE_Vortex::m_height [protected]

float VEE_Vortex::m_fadeRange [protected]

float VEE_Vortex::m_maxForce [protected]

float VEE_Vortex::m_strength [protected]

float VEE_Vortex::m_radialForce [protected]

float VEE_Vortex::m_minRadius [protected]

double VEE_Vortex::m_vortexed [protected]

bool VEE_Vortex::m_useHeight [protected]

If this is false, then any radius change will also set the height. Any height change via "setValue" will as a side effect switch this value to true.

---

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

• vee_vortex.h
• vee_vortex.C

---