Drag[en]gine Game Engine  1.21
deLumimeter Class Reference

Lumimeter Resource. More...

#include <deLumimeter.h>

Inheritance diagram for deLumimeter:
deResource deObject

Public Types

typedef deTObjectReference< deLumimeterRef
 Type holding strong reference. More...
 
- Public Types inherited from deResource
typedef deTObjectReference< deResourceRef
 Type holding strong reference. More...
 
- Public Types inherited from deObject
typedef deTObjectReference< deObjectRef
 Type holding strong reference. More...
 

Public Member Functions

Management
const decDVectorGetPosition () const
 Position. More...
 
void SetPosition (const decDVector &position)
 Set position. More...
 
const decVectorGetDirection () const
 Direction. More...
 
void SetDirection (const decVector &direction)
 Set direction. More...
 
float GetConeInnerAngle () const
 Cone inner angle. More...
 
void SetConeInnerAngle (float angle)
 Set cone inner angle. More...
 
float GetConeOuterAngle () const
 Cone outer angle. More...
 
void SetConeOuterAngle (float angle)
 Set cone outer angle. More...
 
float GetConeExponent () const
 Cone exponent. More...
 
void SetConeExponent (float exponent)
 Set cone exponent. More...
 
Measuring
float MeasureLuminance ()
 Measures the luminance. More...
 
decColor MeasureColor ()
 Measures the color. More...
 
System Peers
deBaseGraphicLumimeterGetPeerGraphic () const
 Graphic system peer. More...
 
void SetPeerGraphic (deBaseGraphicLumimeter *peer)
 Set graphic system peer. More...
 
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)
 Create new lumimeter. More...
 
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.

Member Typedef Documentation

◆ Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deLumimeter()

deLumimeter::deLumimeter ( deLumimeterManager manager)

Create 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

Cone exponent.

◆ GetConeInnerAngle()

float deLumimeter::GetConeInnerAngle ( ) const
inline

Cone inner angle.

◆ GetConeOuterAngle()

float deLumimeter::GetConeOuterAngle ( ) const
inline

Cone outer angle.

◆ GetDirection()

const decVector& deLumimeter::GetDirection ( ) const
inline

Direction.

◆ GetLLWorldNext()

deLumimeter* deLumimeter::GetLLWorldNext ( ) const
inline

Next lumimeter in the parent world linked list.

◆ GetLLWorldPrev()

deLumimeter* deLumimeter::GetLLWorldPrev ( ) const
inline

Previous lumimeter in the parent world linked list.

◆ GetParentWorld()

deWorld* deLumimeter::GetParentWorld ( ) const
inline

Parent world or NULL.

◆ GetPeerGraphic()

deBaseGraphicLumimeter* deLumimeter::GetPeerGraphic ( ) const
inline

Graphic system peer.

◆ GetPosition()

const decDVector& deLumimeter::GetPosition ( ) const
inline

Position.

◆ MeasureColor()

decColor deLumimeter::MeasureColor ( )

Measures the color.

◆ MeasureLuminance()

float deLumimeter::MeasureLuminance ( )

Measures the luminance.

◆ SetConeExponent()

void deLumimeter::SetConeExponent ( float  exponent)

Set cone exponent.

◆ SetConeInnerAngle()

void deLumimeter::SetConeInnerAngle ( float  angle)

Set cone inner angle.

◆ SetConeOuterAngle()

void deLumimeter::SetConeOuterAngle ( float  angle)

Set cone outer angle.

◆ SetDirection()

void deLumimeter::SetDirection ( const decVector direction)

Set direction.

◆ SetLLWorldNext()

void deLumimeter::SetLLWorldNext ( deLumimeter lumimeter)

Set next lumimeter in the parent world linked list.

◆ SetLLWorldPrev()

void deLumimeter::SetLLWorldPrev ( deLumimeter lumimeter)

Set next lumimeter in the parent world linked list.

◆ SetParentWorld()

void deLumimeter::SetParentWorld ( deWorld world)

Set parent world or NULL.

◆ SetPeerGraphic()

void deLumimeter::SetPeerGraphic ( deBaseGraphicLumimeter peer)

Set graphic system peer.

◆ SetPosition()

void deLumimeter::SetPosition ( const decDVector position)

Set position.


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