The Nebula Device 3: Base::ParticleRendererBase Class Reference

The Nebula Device 3

Base::ParticleRendererBase Class Reference

#include <particlerendererbase.h>

Inheritance diagram for Base::ParticleRendererBase:

Core::RefCounted Direct3D9::D3D9ParticleRenderer Particles::ParticleRenderer

Detailed Description

Base class for platform-specific particle renders.

(C) 2008 Radon Labs GmbH

Public Member Functions

 ParticleRendererBase ()
 constructor
virtual ~ParticleRendererBase ()
 destructor
virtual void Setup ()
 setup the particle renderer
virtual void Discard ()
 discard the particle renderer
bool IsValid () const
 return true if particle renderer has been setup
virtual void BeginAttach ()
 begin adding visible particle systems
void AddVisibleParticleSystem (const Ptr< Particles::ParticleSystemInstance > &particleSystemInstance)
 attach a visible particle system instance
bool IsInAttach () const
 is renderer in attach?
virtual void EndAttach ()
 finish adding visible particle sytems
void RenderParticleSystem (const Ptr< Particles::ParticleSystemInstance > &particleSystemInstance)
 render particles of previously attached particle system
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.