Drag[en]gine Game Engine  1.0
deLumimeter Class Reference

Lumimeter Resource. More...

#include <deLumimeter.h>

Inheritance diagram for deLumimeter:
deResource deObject

Public Member Functions

Management
const decDVectorGetPosition () const
 
void SetPosition (const decDVector &position)
 
const decVectorGetDirection () const
 
void SetDirection (const decVector &direction)
 
float GetConeInnerAngle () const
 
void SetConeInnerAngle (float angle)
 
float GetConeOuterAngle () const
 
void SetConeOuterAngle (float angle)
 
float GetConeExponent () const
 
void SetConeExponent (float exponent)
 
Measuring
float MeasureLuminance ()
 
decColor MeasureColor ()
 
System Peers
deBaseGraphicLumimeterGetGraphicLumimeter () const
 
void SetGraphicLumimeter (deBaseGraphicLumimeter *graLumimeter)
 
Linked List
deWorldGetParentWorld () const
 Parent world or NULL. More...
 
void SetParentWorld (deWorld *world)
 Set parent world or NULL. More...
 
deLumimeterGetLLWorldPrev () const
 Previous lumimeter in the parent world linked list. More...
 
void SetLLWorldPrev (deLumimeter *lumimeter)
 Set next lumimeter in the parent world linked list. More...
 
deLumimeterGetLLWorldNext () const
 Next lumimeter in the parent world linked list. More...
 
void SetLLWorldNext (deLumimeter *lumimeter)
 Set next lumimeter in the parent world linked list. More...
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deLumimeter (deLumimeterManager *manager)
 
virtual ~deLumimeter ()
 Clean up lumimeter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Lumimeter Resource.

Lumimeters are sensors to measure the light conditions. This services is provided by the graphic module. A lumimeter measures light at a point in space with an optional cone restriction. Lumimeters without a cone restriction are omni direction lumimeters measuring light from all directions. Using a cone a lumi meter only measures the light coming from source located in the cone. An additional drop off parameter can be specified to determine the attenutation of light sources near the cone boundaries. A lumimeter is considered omni directional if the cone outer angle is PI or above. Lumimeters store the luminance as well as the color.

Author
Pl├╝ss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deLumimeter()

deLumimeter::deLumimeter ( deLumimeterManager manager)

Creates a new lumimeter.

◆ ~deLumimeter()

virtual deLumimeter::~deLumimeter ( )
protectedvirtual

Clean up lumimeter.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetConeExponent()

float deLumimeter::GetConeExponent ( ) const
inline

Retrieves the cone exponent.

References MeasureColor(), MeasureLuminance(), and SetConeExponent().

◆ GetConeInnerAngle()

float deLumimeter::GetConeInnerAngle ( ) const
inline

Retrieves the cone inner angle.

References SetConeInnerAngle().

◆ GetConeOuterAngle()

float deLumimeter::GetConeOuterAngle ( ) const
inline

Retrieves the cone outer angle.

References SetConeOuterAngle().

◆ GetDirection()

const decVector& deLumimeter::GetDirection ( ) const
inline

Retrieves the direction.

References SetDirection().

◆ GetGraphicLumimeter()

deBaseGraphicLumimeter* deLumimeter::GetGraphicLumimeter ( ) const
inline

Retrieves the graphic system peer.

References SetGraphicLumimeter().

◆ GetLLWorldNext()

deLumimeter* deLumimeter::GetLLWorldNext ( ) const
inline

Next lumimeter in the parent world linked list.

References SetLLWorldNext().

◆ GetLLWorldPrev()

deLumimeter* deLumimeter::GetLLWorldPrev ( ) const
inline

Previous lumimeter in the parent world linked list.

References SetLLWorldPrev().

◆ GetParentWorld()

deWorld* deLumimeter::GetParentWorld ( ) const
inline

Parent world or NULL.

References SetParentWorld().

◆ GetPosition()

const decDVector& deLumimeter::GetPosition ( ) const
inline

Retrieves the position.

References SetPosition().

◆ MeasureColor()

decColor deLumimeter::MeasureColor ( )

Measures the color.

Referenced by GetConeExponent().

◆ MeasureLuminance()

float deLumimeter::MeasureLuminance ( )

Measures the luminance.

Referenced by GetConeExponent().

◆ SetConeExponent()

void deLumimeter::SetConeExponent ( float  exponent)

Sets the cone exponent.

Referenced by GetConeExponent().

◆ SetConeInnerAngle()

void deLumimeter::SetConeInnerAngle ( float  angle)

Sets the cone inner angle.

Referenced by GetConeInnerAngle().

◆ SetConeOuterAngle()

void deLumimeter::SetConeOuterAngle ( float  angle)

Sets the cone outer angle.

Referenced by GetConeOuterAngle().

◆ SetDirection()

void deLumimeter::SetDirection ( const decVector direction)

Sets the direction.

Referenced by GetDirection().

◆ SetGraphicLumimeter()

void deLumimeter::SetGraphicLumimeter ( deBaseGraphicLumimeter graLumimeter)

Sets the graphic system peer.

Referenced by GetGraphicLumimeter().

◆ SetLLWorldNext()

void deLumimeter::SetLLWorldNext ( deLumimeter lumimeter)

Set next lumimeter in the parent world linked list.

Referenced by GetLLWorldNext().

◆ SetLLWorldPrev()

void deLumimeter::SetLLWorldPrev ( deLumimeter lumimeter)

Set next lumimeter in the parent world linked list.

Referenced by GetLLWorldPrev().

◆ SetParentWorld()

void deLumimeter::SetParentWorld ( deWorld world)

Set parent world or NULL.

Referenced by GetParentWorld().

◆ SetPosition()

void deLumimeter::SetPosition ( const decDVector position)

Sets the position.

Referenced by GetPosition().


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