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

#include <Lightning.h>

Classes

struct  Segment
 Segment struct. More...
 

Public Member Functions

 Lightning (Ogre::SceneManager *sm, Ogre::SceneNode *sn, const Ogre::Vector3 &orig, const Ogre::Vector3 &dir, const Ogre::Real &l, const Ogre::uint32 &d, const Ogre::uint32 &rec, const Ogre::Real &tm, const Ogre::Real &wm, const Ogre::Vector2 &b=Ogre::Vector2(0, 1))
 Constructor. More...
 
 ~Lightning ()
 Destructor. More...
 
void _updateRenderQueueGroup (const Ogre::uint8 &rqg)
 Update render queue group. More...
 
void create ()
 Create. More...
 
Ogre::BillboardSet * getBillboardSet () const
 Get billboard set. More...
 
const Ogre::Vector3 & getDirection () const
 Get ray direction. More...
 
const Ogre::Real & getIntensity () const
 Get lightning intensity. More...
 
const Ogre::Real & getLength () const
 Get ray length. More...
 
Ogre::SceneNode * getSceneNode () const
 Get scene node. More...
 
const bool & isFinished () const
 Has the ray finished? More...
 
void remove ()
 Remove. More...
 
void update (Ogre::Real timeSinceLastFrame)
 Update. More...
 

Constructor & Destructor Documentation

SkyX::VClouds::Lightning::Lightning ( Ogre::SceneManager *  sm,
Ogre::SceneNode *  sn,
const Ogre::Vector3 &  orig,
const Ogre::Vector3 &  dir,
const Ogre::Real &  l,
const Ogre::uint32 &  d,
const Ogre::uint32 &  rec,
const Ogre::Real &  tm,
const Ogre::Real &  wm,
const Ogre::Vector2 &  b = Ogre::Vector2(0, 1) 
)

Constructor.

Parameters
smScene manager
snScene node
origLighting origin
dirLighting direction
lLighting lenth
dDivisions
recRecursivity level
tmTime multiplier
wmWidth multiplier
bBounds
SkyX::VClouds::Lightning::~Lightning ( )

Destructor.

Member Function Documentation

void SkyX::VClouds::Lightning::_updateRenderQueueGroup ( const Ogre::uint8 &  rqg)

Update render queue group.

Parameters
rqgRender queue group
Remarks
Only for internal use. Use VClouds::setRenderQueueGroups(...) instead.
void SkyX::VClouds::Lightning::create ( )

Create.

Ogre::BillboardSet* SkyX::VClouds::Lightning::getBillboardSet ( ) const
inline

Get billboard set.

Returns
Billboard set
const Ogre::Vector3& SkyX::VClouds::Lightning::getDirection ( ) const
inline

Get ray direction.

Returns
Ray direction
const Ogre::Real& SkyX::VClouds::Lightning::getIntensity ( ) const
inline

Get lightning intensity.

Returns
Lightning intensity
const Ogre::Real& SkyX::VClouds::Lightning::getLength ( ) const
inline

Get ray length.

Returns
Ray length
Ogre::SceneNode* SkyX::VClouds::Lightning::getSceneNode ( ) const
inline

Get scene node.

Returns
Scene node
const bool& SkyX::VClouds::Lightning::isFinished ( ) const
inline

Has the ray finished?

Returns
true if the ray has finished, false otherwise
void SkyX::VClouds::Lightning::remove ( )

Remove.

void SkyX::VClouds::Lightning::update ( Ogre::Real  timeSinceLastFrame)

Update.

Parameters
timeSinceLastFrameTime since last frame

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