deLumimeter Class Reference

Lumimeter Resource. More...

#include <deLumimeter.h>

Inheritance diagram for deLumimeter:
deResource deObject

List of all members.

Public Member Functions

Constructors and Destructors
 deLumimeter (deLumimeterManager *manager)
 Creates a new lumimeter.
virtual ~deLumimeter ()
 Cleans up the lumimeter.
Management
const decDVectorGetPosition () const
 Retrieves the position.
void SetPosition (const decDVector &position)
 Sets the position.
const decVectorGetDirection () const
 Retrieves the direction.
void SetDirection (const decVector &direction)
 Sets the direction.
float GetConeInnerAngle () const
 Retrieves the cone inner angle.
void SetConeInnerAngle (float angle)
 Sets the cone inner angle.
float GetConeOuterAngle () const
 Retrieves the cone outer angle.
void SetConeOuterAngle (float angle)
 Sets the cone outer angle.
float GetConeExponent () const
 Retrieves the cone exponent.
void SetConeExponent (float exponent)
 Sets the cone exponent.
deWorldGetParentWorld () const
 Retrieves the parent world or NULL if not added to a world yet.
void SetParentWorld (deWorld *world)
 Sets the parent world or NULL if not added to a world.
Measuring
float MeasureLuminance ()
 Measures the luminance.
decColor MeasureColor ()
 Measures the color.
System Peers
deBaseGraphicLumimeterGetGraphicLumimeter () const
 Retrieves the graphic system peer.
void SetGraphicLumimeter (deBaseGraphicLumimeter *graLumimeter)
 Sets the graphic system peer.

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 ( deLumimeterManager manager )

Creates a new lumimeter.

virtual deLumimeter::~deLumimeter (  ) [virtual]

Cleans up the lumimeter.


Member Function Documentation

float deLumimeter::GetConeExponent (  ) const [inline]

Retrieves the cone exponent.

float deLumimeter::GetConeInnerAngle (  ) const [inline]

Retrieves the cone inner angle.

float deLumimeter::GetConeOuterAngle (  ) const [inline]

Retrieves the cone outer angle.

const decVector& deLumimeter::GetDirection (  ) const [inline]

Retrieves the direction.

deBaseGraphicLumimeter* deLumimeter::GetGraphicLumimeter (  ) const [inline]

Retrieves the graphic system peer.

deWorld* deLumimeter::GetParentWorld (  ) const [inline]

Retrieves the parent world or NULL if not added to a world yet.

const decDVector& deLumimeter::GetPosition (  ) const [inline]

Retrieves the position.

decColor deLumimeter::MeasureColor (  )

Measures the color.

float deLumimeter::MeasureLuminance (  )

Measures the luminance.

void deLumimeter::SetConeExponent ( float  exponent )

Sets the cone exponent.

void deLumimeter::SetConeInnerAngle ( float  angle )

Sets the cone inner angle.

void deLumimeter::SetConeOuterAngle ( float  angle )

Sets the cone outer angle.

void deLumimeter::SetDirection ( const decVector direction )

Sets the direction.

void deLumimeter::SetGraphicLumimeter ( deBaseGraphicLumimeter graLumimeter )

Sets the graphic system peer.

void deLumimeter::SetParentWorld ( deWorld world )

Sets the parent world or NULL if not added to a world.

void deLumimeter::SetPosition ( const decDVector position )

Sets the position.


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