Particle Universe  1.2
ParticleUniverse::Sphere Class Reference

#include <ParticleUniverseSphere.h>

Inheritance diagram for ParticleUniverse::Sphere:

Public Member Functions

 Sphere (void)
 
virtual ~Sphere (void)
 
 Sphere (const Vector3 &position, SphereSet *owner)
 
void setPosition (const Vector3 &position)
 
void setPosition (Real x, Real y, Real z)
 
const Vector3getPosition (void) const
 
void setColour (const ColourValue &colour)
 
const ColourValuegetColour (void) const
 
void resetRadius (void)
 
void setRadius (Real radius)
 
bool hasOwnRadius (void) const
 
Real getOwnRadius (void) const
 
void _notifyOwner (SphereSet *owner)
 

Public Attributes

Vector3 mPosition
 
ColourValue mColour
 
Quaternion mOrientation
 
SphereSetmParentSet
 

Protected Attributes

bool mOwnRadius
 
Real mRadius
 
bool mRadiusChanged
 

Friends

class SphereSet
 
class SphereRenderer
 

Constructor & Destructor Documentation

ParticleUniverse::Sphere::Sphere ( void  )

Default constructor.

virtual ParticleUniverse::Sphere::~Sphere ( void  )
virtual

Default destructor.

ParticleUniverse::Sphere::Sphere ( const Vector3 position,
SphereSet owner 
)

Constructor as called by SphereSet.

Member Function Documentation

void ParticleUniverse::Sphere::_notifyOwner ( SphereSet owner)

Internal method for notifying the box of it's owner.

const ColourValue& ParticleUniverse::Sphere::getColour ( void  ) const

Get the colour of this sphere.

Real ParticleUniverse::Sphere::getOwnRadius ( void  ) const

Retrieves the sphere's personal radius, if hasOwnRadius is true.

const Vector3& ParticleUniverse::Sphere::getPosition ( void  ) const
bool ParticleUniverse::Sphere::hasOwnRadius ( void  ) const

Returns true if this box deviates from the SphereSet's default radius.

void ParticleUniverse::Sphere::resetRadius ( void  )
inline

Resets this sphere to use the parent SphereSet's radius instead of it's own.

void ParticleUniverse::Sphere::setColour ( const ColourValue colour)

Sets the colour of this sphere.

void ParticleUniverse::Sphere::setPosition ( const Vector3 position)
void ParticleUniverse::Sphere::setPosition ( Real  x,
Real  y,
Real  z 
)
void ParticleUniverse::Sphere::setRadius ( Real  radius)

Sets the radius for this sphere.

Friends And Related Function Documentation

friend class SphereRenderer
friend
friend class SphereSet
friend

Member Data Documentation

ColourValue ParticleUniverse::Sphere::mColour
Quaternion ParticleUniverse::Sphere::mOrientation
bool ParticleUniverse::Sphere::mOwnRadius
protected
SphereSet* ParticleUniverse::Sphere::mParentSet
Vector3 ParticleUniverse::Sphere::mPosition
Real ParticleUniverse::Sphere::mRadius
protected
bool ParticleUniverse::Sphere::mRadiusChanged
protected

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