domLight::domTechnique_common::domSpot Class Reference

#include <domLight.h>

Inheritance diagram for domLight::domTechnique_common::domSpot:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const domTargetable_float3Ref getColor () const
const domTargetableFloat3Ref getColor () const
const domTargetable_floatRef getConstant_attenuation () const
const domTargetableFloatRef getConstant_attenuation () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domTargetable_floatRef getFalloff_angle () const
const domTargetableFloatRef getFalloff_angle () const
const domTargetable_floatRef getFalloff_exponent () const
const domTargetableFloatRef getFalloff_exponent () const
const domTargetable_floatRef getLinear_attenuation () const
const domTargetableFloatRef getLinear_attenuation () const
const domTargetable_floatRef getQuadratic_attenuation () const
const domTargetableFloatRef getQuadratic_attenuation () const
virtual daeInt typeID () const
virtual daeInt typeID () const

Static Public Member Functions

static DLLSPEC daeElementRef create (DAE &dae)
static DLLSPEC daeElementRef create (DAE &dae)
static daeInt ID ()
static daeInt ID ()
static DLLSPEC daeMetaElementregisterElement (DAE &dae)
static DLLSPEC daeMetaElementregisterElement (DAE &dae)

Protected Member Functions

 domSpot (DAE &dae)
 domSpot (DAE &dae)
virtual domSpotoperator= (const domSpot &cpy)
virtual domSpotoperator= (const domSpot &cpy)
virtual ~domSpot ()
virtual ~domSpot ()

Protected Attributes

domTargetable_float3Ref elemColor
domTargetableFloat3Ref elemColor
domTargetable_floatRef elemConstant_attenuation
domTargetableFloatRef elemConstant_attenuation
domTargetable_floatRef elemFalloff_angle
domTargetableFloatRef elemFalloff_angle
domTargetable_floatRef elemFalloff_exponent
domTargetableFloatRef elemFalloff_exponent
domTargetable_floatRef elemLinear_attenuation
domTargetableFloatRef elemLinear_attenuation
domTargetable_floatRef elemQuadratic_attenuation
domTargetableFloatRef elemQuadratic_attenuation

Detailed Description

The spot element declares the parameters required to describe a spot light source. A spot light source radiates light in one direction from a known location in space. The light radiates from the spot light source in a cone shape. The intensity of the light is attenuated as the radiation angle increases away from the direction of the light source. The intensity of a spot light source is also attenuated as the distance to the light source increases. The position of the light is defined by the transform of the node in which it is instantiated. The light’s default direction vector in local coordinates is [0,0,-1], pointing down the -Z axis. The actual direction of the light is defined by the transform of the node where the light is instantiated.

The spot element declares the parameters required to describe a spot light source. A spot light source radiates light in one direction from a known location in space. The light radiates from the spot light source in a cone shape. The intensity of the light is attenuated as the radiation angle increases away from the direction of the light source. The intensity of a spot light source is also attenuated as the distance to the light source increases. The position of the light is defined by the transform of the node in which it is instantiated. The light's default direction vector in local coordinates is [0,0,-1], pointing down the -Z axis. The actual direction of the light is defined by the transform of the node where the light is instantiated.

Definition at line 281 of file 1.4/dom/domLight.h.


Constructor & Destructor Documentation

domLight::domTechnique_common::domSpot::domSpot ( DAE dae  )  [inline, protected]

Constructor

Definition at line 358 of file 1.4/dom/domLight.h.

virtual domLight::domTechnique_common::domSpot::~domSpot (  )  [inline, protected, virtual]

Destructor

Definition at line 362 of file 1.4/dom/domLight.h.

domLight::domTechnique_common::domSpot::domSpot ( DAE dae  )  [inline, protected]

Constructor

Definition at line 350 of file dom/domLight.h.

virtual domLight::domTechnique_common::domSpot::~domSpot (  )  [inline, protected, virtual]

Destructor

Definition at line 354 of file dom/domLight.h.


Member Function Documentation

static DLLSPEC daeElementRef domLight::domTechnique_common::domSpot::create ( DAE dae  )  [static]

Creates an instance of this class and returns a daeElementRef referencing it.

Returns:
a daeElementRef referencing an instance of this object.
static DLLSPEC daeElementRef domLight::domTechnique_common::domSpot::create ( DAE dae  )  [static]

Creates an instance of this class and returns a daeElementRef referencing it.

Returns:
a daeElementRef referencing an instance of this object.
const domTargetable_float3Ref domLight::domTechnique_common::domSpot::getColor (  )  const [inline]

Gets the color element.

Returns:
a daeSmartRef to the color element.

Definition at line 320 of file dom/domLight.h.

const domTargetableFloat3Ref domLight::domTechnique_common::domSpot::getColor (  )  const [inline]

Gets the color element.

Returns:
a daeSmartRef to the color element.

Definition at line 328 of file 1.4/dom/domLight.h.

const domTargetable_floatRef domLight::domTechnique_common::domSpot::getConstant_attenuation (  )  const [inline]

Gets the constant_attenuation element.

Returns:
a daeSmartRef to the constant_attenuation element.

Definition at line 325 of file dom/domLight.h.

const domTargetableFloatRef domLight::domTechnique_common::domSpot::getConstant_attenuation (  )  const [inline]

Gets the constant_attenuation element.

Returns:
a daeSmartRef to the constant_attenuation element.

Definition at line 333 of file 1.4/dom/domLight.h.

virtual COLLADA_TYPE::TypeEnum domLight::domTechnique_common::domSpot::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 276 of file dom/domLight.h.

virtual COLLADA_TYPE::TypeEnum domLight::domTechnique_common::domSpot::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 284 of file 1.4/dom/domLight.h.

const domTargetable_floatRef domLight::domTechnique_common::domSpot::getFalloff_angle (  )  const [inline]

Gets the falloff_angle element.

Returns:
a daeSmartRef to the falloff_angle element.

Definition at line 340 of file dom/domLight.h.

const domTargetableFloatRef domLight::domTechnique_common::domSpot::getFalloff_angle (  )  const [inline]

Gets the falloff_angle element.

Returns:
a daeSmartRef to the falloff_angle element.

Definition at line 348 of file 1.4/dom/domLight.h.

const domTargetable_floatRef domLight::domTechnique_common::domSpot::getFalloff_exponent (  )  const [inline]

Gets the falloff_exponent element.

Returns:
a daeSmartRef to the falloff_exponent element.

Definition at line 345 of file dom/domLight.h.

const domTargetableFloatRef domLight::domTechnique_common::domSpot::getFalloff_exponent (  )  const [inline]

Gets the falloff_exponent element.

Returns:
a daeSmartRef to the falloff_exponent element.

Definition at line 353 of file 1.4/dom/domLight.h.

const domTargetable_floatRef domLight::domTechnique_common::domSpot::getLinear_attenuation (  )  const [inline]

Gets the linear_attenuation element.

Returns:
a daeSmartRef to the linear_attenuation element.

Definition at line 330 of file dom/domLight.h.

const domTargetableFloatRef domLight::domTechnique_common::domSpot::getLinear_attenuation (  )  const [inline]

Gets the linear_attenuation element.

Returns:
a daeSmartRef to the linear_attenuation element.

Definition at line 338 of file 1.4/dom/domLight.h.

const domTargetable_floatRef domLight::domTechnique_common::domSpot::getQuadratic_attenuation (  )  const [inline]

Gets the quadratic_attenuation element.

Returns:
a daeSmartRef to the quadratic_attenuation element.

Definition at line 335 of file dom/domLight.h.

const domTargetableFloatRef domLight::domTechnique_common::domSpot::getQuadratic_attenuation (  )  const [inline]

Gets the quadratic_attenuation element.

Returns:
a daeSmartRef to the quadratic_attenuation element.

Definition at line 343 of file 1.4/dom/domLight.h.

static daeInt domLight::domTechnique_common::domSpot::ID (  )  [inline, static]

Definition at line 277 of file dom/domLight.h.

static daeInt domLight::domTechnique_common::domSpot::ID (  )  [inline, static]

Definition at line 285 of file 1.4/dom/domLight.h.

virtual domSpot& domLight::domTechnique_common::domSpot::operator= ( const domSpot cpy  )  [inline, protected, virtual]

Overloaded assignment operator

Definition at line 358 of file dom/domLight.h.

virtual domSpot& domLight::domTechnique_common::domSpot::operator= ( const domSpot cpy  )  [inline, protected, virtual]

Overloaded assignment operator

Definition at line 366 of file 1.4/dom/domLight.h.

static DLLSPEC daeMetaElement* domLight::domTechnique_common::domSpot::registerElement ( DAE dae  )  [static]

Creates a daeMetaElement object that describes this element in the meta object reflection framework. If a daeMetaElement already exists it will return that instead of creating a new one.

Returns:
A daeMetaElement describing this COLLADA element.
static DLLSPEC daeMetaElement* domLight::domTechnique_common::domSpot::registerElement ( DAE dae  )  [static]

Creates a daeMetaElement object that describes this element in the meta object reflection framework. If a daeMetaElement already exists it will return that instead of creating a new one.

Returns:
A daeMetaElement describing this COLLADA element.
virtual daeInt domLight::domTechnique_common::domSpot::typeID (  )  const [inline, virtual]

Returns this element's type ID. Every element is an instance of a type specified in the Collada schema, and every schema type has a unique ID.

Returns:
The element's type ID.

Implements daeElement.

Definition at line 278 of file dom/domLight.h.

virtual daeInt domLight::domTechnique_common::domSpot::typeID (  )  const [inline, virtual]

Returns this element's type ID. Every element is an instance of a type specified in the Collada schema, and every schema type has a unique ID.

Returns:
The element's type ID.

Implements daeElement.

Definition at line 286 of file 1.4/dom/domLight.h.


Member Data Documentation

The color element contains three floating point numbers specifying the color of the light. The color element must occur exactly once.

See also:
domColor

Definition at line 285 of file dom/domLight.h.

The color element contains three floating point numbers specifying the color of the light. The color element must occur exactly once.

See also:
domColor

Definition at line 293 of file 1.4/dom/domLight.h.

The constant_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domConstant_attenuation

Definition at line 291 of file dom/domLight.h.

The constant_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domConstant_attenuation

Definition at line 299 of file 1.4/dom/domLight.h.

The falloff_angle is used to specify the amount of attenuation based on the direction of the light.

See also:
domFalloff_angle

Definition at line 308 of file dom/domLight.h.

The falloff_angle is used to specify the amount of attenuation based on the direction of the light.

See also:
domFalloff_angle

Definition at line 316 of file 1.4/dom/domLight.h.

The falloff_exponent is used to specify the amount of attenuation based on the direction of the light.

See also:
domFalloff_exponent

Definition at line 313 of file dom/domLight.h.

The falloff_exponent is used to specify the amount of attenuation based on the direction of the light.

See also:
domFalloff_exponent

Definition at line 321 of file 1.4/dom/domLight.h.

The linear_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domLinear_attenuation

Definition at line 297 of file dom/domLight.h.

The linear_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domLinear_attenuation

Definition at line 305 of file 1.4/dom/domLight.h.

The quadratic_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domQuadratic_attenuation

Definition at line 303 of file dom/domLight.h.

The quadratic_attenuation is used to calculate the total attenuation of this light given a distance. The equation used is A = constant_attenuation + Dist*linear_attenuation + Dist^2*quadratic_attenuation.

See also:
domQuadratic_attenuation

Definition at line 311 of file 1.4/dom/domLight.h.


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


colladadom
Author(s): Du Hung Hou, Khronos.org, Marcus Barnes, Greg Corson, Herbert Law, Sebastian Schwarz, Steven Thomas, John Hsu (ros package), Tim Field (ros package)
autogenerated on Fri Jan 11 09:31:39 2013