GEE_Operator Class Reference

Base class for operators in GEE. More...

#include <gee_operator.h>

Inheritance diagram for GEE_Operator:

[legend]Collaboration diagram for GEE_Operator:

[legend]List of all members.

Public Member Functions

• GEE_Operator ()
• virtual ~GEE_Operator ()
• virtual bool start (GEE_World *, const GEE_TimeStamp &)

  A virtual function that starts to do the work.
  

• virtual bool act (GEE_World *, const GEE_TimeStamp &)

  A virtual function that does something.
  

• virtual bool stop (GEE_World *, const GEE_TimeStamp &)

  A virtual function that ends/finalizes the work.
  

• virtual bool read (GEE_Io *)
• virtual bool write (GEE_Io *)
• virtual const char * type ()
• bool readBasics (GEE_Io *)
• bool writeBasics (GEE_Io *)
• void copyBasics (const GEE_Operator &)
• const GEE_Interval & interval () const
• GEE_Interval & interval ()
• GEE_id_t group () const
• void setGroup (GEE_id_t g)
• void setManager (GEE_OperatorManager *manager)
• bool keepAlive ()
• void setKeepAlive (bool keep)

Static Public Member Functions

• static GEE_Operator * create (const char *type)

Static Protected Member Functions

• static void init ()

Protected Attributes

• GEE_Interval m_interval
• GEE_id_t m_group
• bool m_keepAlive

  Should we try to keep this operator active even after its time has passed.
  

• GEE_OperatorManager * m_manager

---

Detailed Description

Base class for operators in GEE.

An operator is responsible for transforming the GEE_Geometry objects in some way.

Author:

Tommi Ilmonen

---

Constructor & Destructor Documentation

GEE_Operator::GEE_Operator (   )

GEE_Operator::~GEE_Operator (   )  [virtual]

---

Member Function Documentation

bool GEE_Operator::start (  GEE_World *  , const GEE_TimeStamp &  )  [virtual]

A virtual function that starts to do the work. This method is called once before "act" is called. The default implementation returns true. Reimplemented in GEE_PathMultiply, GEE_PathToCamera, GEE_PathToLines, GEE_PathToMesh, GEE_PathToParticles, GEE_PathToX, and GEE_TurnAroundPath.

bool GEE_Operator::act (  GEE_World *  , const GEE_TimeStamp &  )  [virtual]

A virtual function that does something. This method is called at least once between "start" and "stop". The default implementation returns true. Reimplemented in GEE_ColorAroundPath, GEE_CopyGeometry, GEE_EraseAroundPath, GEE_GroupGeos, GEE_IdSelect, GEE_InsertParticle, GEE_MoveAroundPath, GEE_ParticleRotate, GEE_PathInsert, GEE_PathToX, GEE_ScaleAroundPaths, GEE_TurnAroundPath, and GEE_UnGroupGeos.

bool GEE_Operator::stop (  GEE_World *  , const GEE_TimeStamp &  )  [virtual]

A virtual function that ends/finalizes the work. This method is called once after "act" has been called. The default implementation returns true. Reimplemented in GEE_GroupAroundPath, GEE_PathMultiply, GEE_PathToLines, GEE_PathToMesh, GEE_PathToParticles, and GEE_PathToX.

bool GEE_Operator::read (  GEE_Io *   )  [virtual]

Reimplemented in GEE_ColorAroundPath, GEE_CopyGeometry, GEE_EraseAroundPath, GEE_GroupAroundPath, GEE_GroupGeos, GEE_IdSelect, GEE_InsertParticle, GEE_MoveAroundPath, GEE_ParticleRotate, GEE_PathInsert, GEE_PathMultiply, GEE_PathToCamera, GEE_PathToLines, GEE_PathToMesh, GEE_PathToParticles, GEE_ScaleAroundPaths, GEE_TextureAroundPath, GEE_TurnAroundPath, and GEE_UnGroupGeos.

bool GEE_Operator::write (  GEE_Io *   )  [virtual]

Reimplemented in GEE_ColorAroundPath, GEE_CopyGeometry, GEE_EraseAroundPath, GEE_GroupAroundPath, GEE_GroupGeos, GEE_IdSelect, GEE_InsertParticle, GEE_MoveAroundPath, GEE_ParticleRotate, GEE_PathInsert, GEE_PathMultiply, GEE_PathToCamera, GEE_PathToLines, GEE_PathToMesh, GEE_PathToParticles, GEE_ScaleAroundPaths, GEE_TextureAroundPath, GEE_TurnAroundPath, and GEE_UnGroupGeos.

const char * GEE_Operator::type (   )  [virtual]

Reimplemented in GEE_ColorAroundPath, GEE_CopyGeometry, GEE_EraseAroundPath, GEE_GroupAroundPath, GEE_GroupGeos, GEE_IdSelect, GEE_InsertParticle, GEE_MoveAroundPath, GEE_ParticleRotate, GEE_PathInsert, GEE_PathMultiply, GEE_PathToCamera, GEE_PathToLines, GEE_PathToMesh, GEE_PathToParticles, GEE_ScaleAroundPaths, GEE_TextureAroundPath, GEE_TurnAroundPath, and GEE_UnGroupGeos.

bool GEE_Operator::readBasics (  GEE_Io *   )

bool GEE_Operator::writeBasics (  GEE_Io *   )

void GEE_Operator::copyBasics (  const GEE_Operator &   )

const GEE_Interval& GEE_Operator::interval (   )  const [inline]

GEE_Interval& GEE_Operator::interval (   )  [inline]

GEE_id_t GEE_Operator::group (   )  const [inline]

void GEE_Operator::setGroup (  GEE_id_t  g  )  [inline]

void GEE_Operator::setManager (  GEE_OperatorManager *  manager  )  [inline]

GEE_Operator * GEE_Operator::create (  const char *  type  )  [static]

bool GEE_Operator::keepAlive (   )  [inline]

void GEE_Operator::setKeepAlive (  bool  keep  )  [inline]

void GEE_Operator::init (   )  [static, protected]

---

Member Data Documentation

GEE_Interval GEE_Operator::m_interval [protected]

GEE_id_t GEE_Operator::m_group [protected]

Reimplemented in GEE_GroupAroundPath.

bool GEE_Operator::m_keepAlive [protected]

Should we try to keep this operator active even after its time has passed.

GEE_OperatorManager* GEE_Operator::m_manager [protected]

---

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

• gee_operator.h
• gee_operator.C

---