A3DL::Light Class Reference

#include <light.hh>

Inheritance diagram for A3DL::Light:

List of all members.

Public Member Functions

• Light (MetaObject *superobject)
• virtual ~Light ()
• void setPropertyAccessControl (PropertyAccessControl *pac)
• PropertyAccessControl * getPropertyAccessControl ()
• virtual void setPosition (double x, double y, double z) throw (NoSuchObjectError)

  Set position of this light.
  
  

• virtual void getPosition (double &x, double &y, double &z) throw (NoSuchObjectError)

  Get position of this light.
  
  

• virtual void setRadius (double r) throw (NoSuchObjectError)

  Set light radius.
  
  

• virtual double getRadius () throw (NoSuchObjectError)

  Get light radius.
  
  

• virtual void setColor (double r, double g, double b) throw (NoSuchObjectError)

  Set the light's color.
  
  

• virtual void getColor (double &r, double &g, double &b) throw (NoSuchObjectError)

  Get the light's color.
  
  

• virtual void setStatic (bool is_static) throw (NoSuchObjectError)

  Set light's "static" property.
  
  

• virtual bool getStatic () throw (NoSuchObjectError)

  Get light's "static" property.
  
  

• virtual void initialize (bool is_static, PropertyAccessControl *access=NULL)

  Initialize subproperties: position=(0,0,0), radius=1, color=(1,1,1).
  
  

• virtual void initialize ()
• virtual const string getType ()

Static Public Member Functions

• void registerExtenders ()
• MetaObject * new_Light (MetaObject *superobject, const string &type)

Protected Attributes

• PropertyAccessControl * accesscontrol

---

Constructor & Destructor Documentation

Light::Light (  MetaObject *  superobject  )

Definition at line 29 of file light.cc. Referenced by new_Light().

Light::~Light (   )  [virtual]

Definition at line 34 of file light.cc.

---

Member Function Documentation

void Light::getColor (  double &  r, double &  g, double &  b )  throw (NoSuchObjectError) [virtual]

Get the light's color. See setColor() for details. Parameters: r  the red component g  the green component b  the blue component Definition at line 105 of file light.cc.

void Light::getPosition (  double &  x, double &  y, double &  z )  throw (NoSuchObjectError) [virtual]

Get position of this light. Parameters: x  X translation, relative to origin of parent object y  Y translation, relative to origin of parent object z  Z translation, relative to origin of parent object Exceptions: NoSuchObjectError  if "position" subobject does not exist, or is not a property. Definition at line 50 of file light.cc.

PropertyAccessControl* A3DL::Light::getPropertyAccessControl (   )  [inline]

Definition at line 50 of file light.hh.

double Light::getRadius (   )  throw (NoSuchObjectError) [virtual]

Get light radius. See setRadius() to see what this value means. Returns: the light radius Definition at line 79 of file light.cc.

bool Light::getStatic (   )  throw (NoSuchObjectError) [virtual]

Get light's "static" property. Definition at line 132 of file light.cc.

const string Light::getType (   )  [virtual]

Definition at line 165 of file light.cc.

virtual void A3DL::Light::initialize (   )  [inline, virtual]

Definition at line 115 of file light.hh.

void Light::initialize (  bool  is_static, PropertyAccessControl *  access = NULL )  [virtual]

Initialize subproperties: position=(0,0,0), radius=1, color=(1,1,1). Parameters: is_static  If true, this will be a static light, and the properties cannot be changed. (Allows optimizations by rendering agent). Default is false. access  Access control object for subproperties. Default is none. Warning: sets No access control by default! Definition at line 149 of file light.cc.

MetaObject * Light::new_Light (  MetaObject *  superobject, const string &  type )  [static]

Definition at line 160 of file light.cc.

void Light::registerExtenders (   )  [static]

Definition at line 170 of file light.cc.

void Light::setColor (  double  r, double  g, double  b )  throw (NoSuchObjectError) [virtual]

Set the light's color. Components are specified between 0 (black) and 1 (full saturation). Parameters: r  the red component g  the green component b  the blue component Definition at line 94 of file light.cc. Referenced by initialize().

void Light::setPosition (  double  x, double  y, double  z )  throw (NoSuchObjectError) [virtual]

Set position of this light. Parameters: x  X translation, relative to origin of parent object y  Y translation, relative to origin of parent object z  Z translation, relative to origin of parent object Exceptions: NoSuchObjectError  if "position" subobject does not exist, or is not a property. Definition at line 38 of file light.cc. Referenced by initialize().

void A3DL::Light::setPropertyAccessControl (  PropertyAccessControl *  pac  )  [inline]

Definition at line 49 of file light.hh.

void Light::setRadius (  double  r  )  throw (NoSuchObjectError) [virtual]

Set light radius. Light falls off as a function of of the proportional distance between the center and radius distance. You could also think of this (along with the intensity or saturation of the light's color) it as a brightness factor. Parameters: r  Exceptions: NoSuchObjectError  if "position" subobject does not exist, or is not a property. Definition at line 70 of file light.cc. Referenced by initialize().

void Light::setStatic (  bool  is_static  )  throw (NoSuchObjectError) [virtual]

Set light's "static" property. Should only be set once, at creation. Definition at line 118 of file light.cc. Referenced by initialize().

---

Member Data Documentation

PropertyAccessControl* A3DL::Light::accesscontrol [protected]

Definition at line 44 of file light.hh. Referenced by initialize().

---

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

• vos/3D/a3dl/light.hh
• vos/3D/a3dl/light.cc

---