domLight Class Reference

#include <domLight.h>

Inheritance diagram for domLight:
Inheritance graph
[legend]

List of all members.

Classes

class  domTechnique_common

Public Types

typedef daeTArray
< domTechnique_commonRef > 		domTechnique_common_Array
typedef daeTArray
< domTechnique_commonRef > 		domTechnique_common_Array
typedef daeSmartRef
< domTechnique_common > 		domTechnique_commonRef
typedef daeSmartRef
< domTechnique_common > 		domTechnique_commonRef

Public Member Functions

const domAssetRef getAsset () const
const domAssetRef getAsset () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
xsID getId () const
xsID getId () const
xsToken getName () const
xsNCName getName () const
const domTechnique_Array & getTechnique_array () const
domTechnique_Array & getTechnique_array ()
const domTechnique_Array & getTechnique_array () const
domTechnique_Array & getTechnique_array ()
const domTechnique_commonRef getTechnique_common () const
const domTechnique_commonRef getTechnique_common () const
void setId (xsID atId)
void setId (xsID atId)
void setName (xsToken atName)
void setName (xsNCName atName)
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 daeMetaElement * registerElement (DAE &dae)
static DLLSPEC daeMetaElement * registerElement (DAE &dae)

Protected Member Functions

 domLight (DAE &dae)
 domLight (DAE &dae)
virtual domLight & operator= (const domLight &cpy)
virtual domLight & operator= (const domLight &cpy)
virtual ~domLight ()
virtual ~domLight ()

Protected Attributes

xsID attrId
xsToken attrName
xsNCName attrName
domAssetRef elemAsset
domExtra_Array elemExtra_array
domTechnique_Array elemTechnique_array
domTechnique_commonRef elemTechnique_common

Detailed Description

The light element declares a light source that illuminates the scene. Light sources have many different properties and radiate light in many different patterns and frequencies.

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

Member Typedef Documentation

typedef daeTArray<domTechnique_commonRef> domLight::domTechnique_common_Array

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

typedef daeTArray<domTechnique_commonRef> domLight::domTechnique_common_Array

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

typedef daeSmartRef<domTechnique_common> domLight::domTechnique_commonRef

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

typedef daeSmartRef<domTechnique_common> domLight::domTechnique_commonRef

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

Constructor & Destructor Documentation

domLight::domLight ( DAE &  dae  )  [inline, protected]

Constructor

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

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

Destructor

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

domLight::domLight ( DAE &  dae  )  [inline, protected]

Constructor

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

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

Destructor

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

Member Function Documentation

static DLLSPEC daeElementRef domLight::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::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 domAssetRef domLight::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

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

const domAssetRef domLight::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

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

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

Reimplemented from daeElement.

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

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

Reimplemented from daeElement.

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

const domExtra_Array& domLight::getExtra_array (  )  const [inline]

Gets the extra element array.

Returns:
Returns a constant reference to the array of extra elements.

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

domExtra_Array& domLight::getExtra_array (  )  [inline]

Gets the extra element array.

Returns:
Returns a reference to the array of extra elements.

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

const domExtra_Array& domLight::getExtra_array (  )  const [inline]

Gets the extra element array.

Returns:
Returns a constant reference to the array of extra elements.

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

domExtra_Array& domLight::getExtra_array (  )  [inline]

Gets the extra element array.

Returns:
Returns a reference to the array of extra elements.

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

xsID domLight::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

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

xsID domLight::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

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

xsToken domLight::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

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

xsNCName domLight::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

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

const domTechnique_Array& domLight::getTechnique_array (  )  const [inline]

Gets the technique element array.

Returns:
Returns a constant reference to the array of technique elements.

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

domTechnique_Array& domLight::getTechnique_array (  )  [inline]

Gets the technique element array.

Returns:
Returns a reference to the array of technique elements.

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

const domTechnique_Array& domLight::getTechnique_array (  )  const [inline]

Gets the technique element array.

Returns:
Returns a constant reference to the array of technique elements.

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

domTechnique_Array& domLight::getTechnique_array (  )  [inline]

Gets the technique element array.

Returns:
Returns a reference to the array of technique elements.

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

const domTechnique_commonRef domLight::getTechnique_common (  )  const [inline]

Gets the technique_common element.

Returns:
a daeSmartRef to the technique_common element.

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

const domTechnique_commonRef domLight::getTechnique_common (  )  const [inline]

Gets the technique_common element.

Returns:
a daeSmartRef to the technique_common element.

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

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

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

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

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

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

Overloaded assignment operator

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

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

Overloaded assignment operator

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

static DLLSPEC daeMetaElement* domLight::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::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.
void domLight::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

void domLight::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

void domLight::setName ( xsToken  atName  )  [inline]

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

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

void domLight::setName ( xsNCName  atName  )  [inline]

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

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

virtual daeInt domLight::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 25 of file dom/domLight.h.

virtual daeInt domLight::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 33 of file 1.4/dom/domLight.h.

Member Data Documentation

xsID domLight::attrId [protected]

The id attribute is a text string containing the unique identifier of this element. This value must be unique within the instance document. Optional attribute.

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

xsToken domLight::attrName [protected]

The name attribute is the text string name of this element. Optional attribute.

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

xsNCName domLight::attrName [protected]

The name attribute is the text string name of this element. Optional attribute.

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

domAssetRef domLight::elemAsset [protected]

The light element may contain an asset element.

See also:
domAsset

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

domExtra_Array domLight::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

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

domTechnique_Array domLight::elemTechnique_array [protected]

This element may contain any number of non-common profile techniques.

See also:
domTechnique

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

domTechnique_commonRef domLight::elemTechnique_common [protected]

The technique_common element specifies the light information for the common profile which all COLLADA implementations need to support.

See also:
domTechnique_common

Definition at line 520 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:38 2013