Public Member Functions | List of all members
SkyX::VClouds::Ellipsoid Class Reference

Ellipsoid class x^2 y^2 z^2 / + / + / = 1 a^2 b^2 c^2. More...

#include <Ellipsoid.h>

Public Member Functions

 Ellipsoid (const int &a, const int &b, const int &c, const int &nx, const int &ny, const int &nz, const int &x, const int &y, const int &z, const Ogre::Real &DynLibManager=1.0f)
 Constructor. More...
 
 ~Ellipsoid ()
 Destructor. More...
 
const Ogre::Vector3 getDimensions () const
 Get dimensions. More...
 
const Ogre::Vector3 getPosition () const
 Get position. More...
 
const Ogre::Vector3 getProbabilities (const int &x, const int &y, const int &z) const
 Get probabilities at a point. More...
 
bool isOutOfCells () const
 Determines if the ellipsoid is out of the cells domain and needs to be removed. More...
 
void move (const int &Ax, const int &Ay, const int &Az)
 Move the ellipsoid. More...
 
void setDimensions (const Ogre::Vector3 &Dimensions)
 Set dimensions. More...
 
void setPosition (const Ogre::Vector3 &Position)
 Set position. More...
 
void updateProbabilities (DataManager::Cell ***c, const int &nx, const int &ny, const int &nz, const bool &delayedResponse=true)
 Update probabilities. More...
 

Detailed Description

Ellipsoid class x^2 y^2 z^2 / + / + / = 1 a^2 b^2 c^2.

Constructor & Destructor Documentation

SkyX::VClouds::Ellipsoid::Ellipsoid ( const int &  a,
const int &  b,
const int &  c,
const int &  nx,
const int &  ny,
const int &  nz,
const int &  x,
const int &  y,
const int &  z,
const Ogre::Real &  DynLibManager = 1.0f 
)

Constructor.

Parameters
aA constant
bB constant
cC constant
nxX size
nyY size
nzZ size
xx Coord (position)
yy Coord (position)
zz Coord (position)
DensityCloud density
SkyX::VClouds::Ellipsoid::~Ellipsoid ( )

Destructor.

Member Function Documentation

const Ogre::Vector3 SkyX::VClouds::Ellipsoid::getDimensions ( ) const
inline

Get dimensions.

Returns
Ellipsoid dimensions
const Ogre::Vector3 SkyX::VClouds::Ellipsoid::getPosition ( ) const
inline

Get position.

Returns
Position
const Ogre::Vector3 SkyX::VClouds::Ellipsoid::getProbabilities ( const int &  x,
const int &  y,
const int &  z 
) const

Get probabilities at a point.

Parameters
xx Coord
yy Coord
zz Coord
Returns
Probabilities (Hum, Ext, Act)
bool SkyX::VClouds::Ellipsoid::isOutOfCells ( ) const

Determines if the ellipsoid is out of the cells domain and needs to be removed.

void SkyX::VClouds::Ellipsoid::move ( const int &  Ax,
const int &  Ay,
const int &  Az 
)

Move the ellipsoid.

Parameters
Axx increment
Ayy increment
Azz increment
void SkyX::VClouds::Ellipsoid::setDimensions ( const Ogre::Vector3 &  Dimensions)

Set dimensions.

Parameters
DimensionsNew dimensions
void SkyX::VClouds::Ellipsoid::setPosition ( const Ogre::Vector3 &  Position)
inline

Set position.

Parameters
PositionNew position
void SkyX::VClouds::Ellipsoid::updateProbabilities ( DataManager::Cell ***  c,
const int &  nx,
const int &  ny,
const int &  nz,
const bool &  delayedResponse = true 
)

Update probabilities.

Parameters
cCells
nxX complexity
nyY complexity
nzZ complexity
delayedResponsetrue to get a delayed response, updating only probabilities, false to also set clouds

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