Public Member Functions | Protected Member Functions

cyber::world::lights::AttenuatedLightDesc Class Reference

#include <AttenuatedLightDesc.h>

Inheritance diagram for cyber::world::lights::AttenuatedLightDesc:
cyber::world::lights::LightDesc cyber::world::ObjectDesc cyber::world::lights::PointLightDesc cyber::world::lights::SpotLightDesc

List of all members.

Public Member Functions

const bl7::geometry2::Sphereget_sphere () const
void set_sphere (const bl7::geometry2::Sphere &sphere)
const ml7::Vector2get_position () const
void set_position (const ml7::Vector2 &position)
float get_range () const
void set_range (float range)
float get_attenuation0 () const
void set_attenuation0 (float attenuation0)
float get_attenuation1 () const
void set_attenuation1 (float attenuation1)
float get_attenuation2 () const
void set_attenuation2 (float attenuation2)

Protected Member Functions

 AttenuatedLightDesc (ClassID class_id, unsigned id, unsigned long color, const bl7::geometry2::Sphere &sphere, const ml7::Vector2 &position, float range)
 AttenuatedLightDesc (const AttenuatedLightDesc &rhs)
AttenuatedLightDescoperator= (const AttenuatedLightDesc &rhs)
virtual ~AttenuatedLightDesc (void)

Detailed Description

The base attenuated light object description class.


Constructor & Destructor Documentation

cyber::world::lights::AttenuatedLightDesc::AttenuatedLightDesc ( ClassID  class_id,
unsigned  id,
unsigned long  color,
const bl7::geometry2::Sphere sphere,
const ml7::Vector2 position,
float  range 
) [protected]

Explicit constructor.

cyber::world::lights::AttenuatedLightDesc::AttenuatedLightDesc ( const AttenuatedLightDesc rhs  )  [protected]

Copy constructor.

cyber::world::lights::AttenuatedLightDesc::~AttenuatedLightDesc ( void   )  [protected, virtual]

Destructor.


Member Function Documentation

float cyber::world::lights::AttenuatedLightDesc::get_attenuation0 (  )  const [inline]

Returns the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

float cyber::world::lights::AttenuatedLightDesc::get_attenuation1 (  )  const [inline]

Returns the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

float cyber::world::lights::AttenuatedLightDesc::get_attenuation2 (  )  const [inline]

Returns the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

const ml7::Vector2& cyber::world::lights::AttenuatedLightDesc::get_position (  )  const [inline]

Returns linear position in world-space.

float cyber::world::lights::AttenuatedLightDesc::get_range (  )  const [inline]

Returns the distance beyond which the light has no effect.

const bl7::geometry2::Sphere& cyber::world::lights::AttenuatedLightDesc::get_sphere (  )  const [inline]

Returns the sphere describing the light source.

AttenuatedLightDesc & cyber::world::lights::AttenuatedLightDesc::operator= ( const AttenuatedLightDesc rhs  )  [protected]

Copy assignment operator.

void cyber::world::lights::AttenuatedLightDesc::set_attenuation0 ( float  attenuation0  )  [inline]

Sets the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

void cyber::world::lights::AttenuatedLightDesc::set_attenuation1 ( float  attenuation1  )  [inline]

Sets the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

void cyber::world::lights::AttenuatedLightDesc::set_attenuation2 ( float  attenuation2  )  [inline]

Sets the value specifying how the light intensity changes over distance. Valid values range from 0 to infinity. All three attenuation values should not be set to 0 at the same time.

void cyber::world::lights::AttenuatedLightDesc::set_position ( const ml7::Vector2 position  )  [inline]

Sets linear position in world-space.

void cyber::world::lights::AttenuatedLightDesc::set_range ( float  range  )  [inline]

Sets the distance beyond which the light has no effect.

void cyber::world::lights::AttenuatedLightDesc::set_sphere ( const bl7::geometry2::Sphere sphere  )  [inline]

Sets the sphere describing the light source.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines