Nimbus  0.2
A game... with arrows... which should be clouds
 All Classes Functions Variables Enumerations Enumerator
Public Member Functions | List of all members
Nimbus::WindCurrent Class Reference

#include <WindCurrent.h>

Public Member Functions

 WindCurrent (Ogre::Real strength, bool temporary=false)
 
void addPoint (Ogre::Vector2 position, Ogre::Vector2 influence)
 
void incrementTimer ()
 
pathList * getPath ()
 
Ogre::Real getStrength ()
 
Ogre::Real length ()
 
bool isTemporary ()
 
int getTimeAlive ()
 
bool operator== (const WindCurrent &other) const
 
bool operator!= (const WindCurrent &other) const
 

Detailed Description

Stores a path representing wind input Used by WindMap

Member Function Documentation

void WindCurrent::addPoint ( Ogre::Vector2  position,
Ogre::Vector2  influence 
)

Adds a point to the wind current.

Parameters
positionThe position of the point to add to the wind current
influenceThe influence of the point to add to the wind current
pathList * WindCurrent::getPath ( )

Gets the path of this wind current.

Returns
A pathList object containing the path of the wind current.

Here is the caller graph for this function:

Real WindCurrent::getStrength ( )

Gets the strength of this wind current.

Returns
An Ogre::Real representing the strength of the wind current.
int WindCurrent::getTimeAlive ( )

Returns the time that this timer has been alive.

Returns
An int containing the number of timer increments since creation.
void WindCurrent::incrementTimer ( )

Increments the time that this wind current has been alive.

bool WindCurrent::isTemporary ( )

True, then temporary, false, then permanent.

Returns
A bool indicating whether or not this wind current is temporary.
Real WindCurrent::length ( )

Gets the length of the wind current.

Returns
An Ogre::Real sum of the current's contained vector lengths.

Here is the caller graph for this function:

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