The Nebula Device 3: Lighting::LightServerBase Class Reference

The Nebula Device 3

Lighting::LightServerBase Class Reference

#include <lightserverbase.h>

Inheritance diagram for Lighting::LightServerBase:

Core::RefCounted Lighting::SM30LightServer Lighting::LightServer


Detailed Description

Base class for the light server. The light server collects all lights contributing to the scene. Subclasses of LightServerBase implement specific lighting techniques.

(C) 2007 Radon Labs GmbH

Public Member Functions

 LightServerBase ()
 constructor
virtual ~LightServerBase ()
 destructor
void Open ()
 open the light server
void Close ()
 close the light server
bool IsOpen () const
 return true if light server is open
void BeginFrame (const Ptr< Graphics::CameraEntity > &cameraEntity)
 begin lighting frame
void BeginAttachVisibleLights ()
 begin attaching visible light sources
void AttachVisibleLight (const Ptr< AbstractLightEntity > &lightEntity)
 attach a visible light source
void EndAttachVisibleLights ()
 end attaching visible light sources
void ApplyModelEntityLights (const Ptr< Graphics::ModelEntity > &modelEntity)
 apply lighting parameters for a visible model entity
void EndFrame ()
 end lighting frame
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

void Lighting::LightServerBase::ApplyModelEntityLights ( const Ptr< Graphics::ModelEntity > &  modelEntity  ) 

apply lighting parameters for a visible model entity

This method is called during rendering to apply lighting parameters to the provided ModelEntity.

Reimplemented in Lighting::SM30LightServer.

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.