cavewriting::SurroundEffect Class Reference

#include <SurroundEffect.H>

Inherits cavewriting::Effect.

List of all members.

Public Member Functions
	SurroundEffect (Array< Word * > &words, double startTime, double duration=100.0, bool startPaused=true, const Vector3 &initialPosition=Vector3(0, 0, 0), float speed=0.1f, const Vector3 &range=Vector3(2, 2, 2), bool collapse=false, double collapseDuration=10.0, const Vector3 &collapseTarget=Vector3(0, 0, 0))
	SurroundEffect (Word *words, double startTime, double duration=100.0, bool startPaused=true, const Vector3 &initialPosition=Vector3(0, 0, 0), float speed=0.1f, const Vector3 &range=Vector3(2, 2, 2), bool collapse=false, double collapseDuration=10.0, const Vector3 &collapseTarget=Vector3(0, 0, 0))
virtual	~SurroundEffect ()
virtual void	animate ()
	Subclasses should implement.
Static Public Member Functions
static SurroundEffect *	fromXML (xercesc::DOMElement *node, bool startPaused=true)
static void	stopAll ()
static SurroundEffect *	createDefaultSurroundEffect (Word *word)
Protected Member Functions
void	setupOffsets (const Vector3 &firstCalculatedPos, const Vector3 &curPosition)
void	doGrabHack (double frac)
	grab a screenshot -- for remote debuggingg
Protected Attributes
float	_speed
Vector3	_positionOffset
Vector3	_range
bool	_firstTime
bool	_collapse
	Determines if this surround effect will ever collapse.
float	_collapseDuration
	How long it takes for this effect to completely collapse.
float	_collapseStartTime
	When does/did the collapse start?
Vector3	_collapseTarget
	The point where the collapse is heading for.
int	_framesSinceCreation
Static Protected Attributes
static bool	_stopAll

---

Detailed Description

/brief Effect in which words surround and hover around the goal position, within the range specified

---

Constructor & Destructor Documentation

cavewriting::SurroundEffect::SurroundEffect (  Array< Word * > &  words, double  startTime, double  duration = 100.0, bool  startPaused = true, const Vector3 &  initialPosition = Vector3(0, 0, 0), float  speed = 0.1f, const Vector3 &  range = Vector3(2, 2, 2), bool  collapse = false, double  collapseDuration = 10.0, const Vector3 &  collapseTarget = Vector3(0, 0, 0) )

cavewriting::SurroundEffect::SurroundEffect (  Word *  words, double  startTime, double  duration = 100.0, bool  startPaused = true, const Vector3 &  initialPosition = Vector3(0, 0, 0), float  speed = 0.1f, const Vector3 &  range = Vector3(2, 2, 2), bool  collapse = false, double  collapseDuration = 10.0, const Vector3 &  collapseTarget = Vector3(0, 0, 0) )

virtual cavewriting::SurroundEffect::~SurroundEffect (   )  [virtual]

---

Member Function Documentation

virtual void cavewriting::SurroundEffect::animate (   )  [virtual]

Subclasses should implement. Reimplemented from cavewriting::Effect.

static SurroundEffect* cavewriting::SurroundEffect::createDefaultSurroundEffect (  Word *  word  )  [static]

void cavewriting::SurroundEffect::doGrabHack (  double  frac  )  [protected]

grab a screenshot -- for remote debuggingg

static SurroundEffect* cavewriting::SurroundEffect::fromXML (  xercesc::DOMElement *  node, bool  startPaused = true )  [static]

Reads an Effect in from xml. Creates and returns an instance of the appropriate subclass. Reimplemented from cavewriting::Effect.

void cavewriting::SurroundEffect::setupOffsets (  const Vector3 &  firstCalculatedPos, const Vector3 &  curPosition )  [protected]

Set up the position offset so that the word doesn't jump from its current position when it switches from PeelEffect to this effect.

static void cavewriting::SurroundEffect::stopAll (   )  [static]

---

Member Data Documentation

bool cavewriting::SurroundEffect::_collapse [protected]

Determines if this surround effect will ever collapse.

float cavewriting::SurroundEffect::_collapseDuration [protected]

How long it takes for this effect to completely collapse.

float cavewriting::SurroundEffect::_collapseStartTime [protected]

When does/did the collapse start?

Vector3 cavewriting::SurroundEffect::_collapseTarget [protected]

The point where the collapse is heading for.

bool cavewriting::SurroundEffect::_firstTime [protected]

int cavewriting::SurroundEffect::_framesSinceCreation [protected]

Vector3 cavewriting::SurroundEffect::_positionOffset [protected]

Vector3 cavewriting::SurroundEffect::_range [protected]

float cavewriting::SurroundEffect::_speed [protected]

bool cavewriting::SurroundEffect::_stopAll [static, protected]

---

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

• SurroundEffect.H

---