domEffect Class Reference

#include <domEffect.h>

Inheritance diagram for domEffect:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const domFx_annotate_Array & getAnnotate_array () const
domFx_annotate_Array & getAnnotate_array ()
const domFx_annotate_common_Array & getAnnotate_array () const
domFx_annotate_common_Array & getAnnotate_array ()
const domAssetRef getAsset () const
const domAssetRef getAsset () const
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
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 ()
const
domFx_profile_abstract_Array & 		getFx_profile_abstract_array () const
domFx_profile_abstract_Array & getFx_profile_abstract_array ()
const domFx_profile_Array & getFx_profile_array () const
domFx_profile_Array & getFx_profile_array ()
xsID getId () const
xsID getId () const
const domImage_Array & getImage_array () const
domImage_Array & getImage_array ()
xsToken getName () const
xsNCName getName () const
const domFx_newparam_Array & getNewparam_array () const
domFx_newparam_Array & getNewparam_array ()
const domFx_newparam_common_Array & getNewparam_array () const
domFx_newparam_common_Array & getNewparam_array ()
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

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

Protected Attributes

daeElementRefArray _contents
daeUIntArray _contentsOrder
xsID attrId
xsToken attrName
xsNCName attrName
domFx_annotate_Array elemAnnotate_array
domFx_annotate_common_Array elemAnnotate_array
domAssetRef elemAsset
domExtra_Array elemExtra_array
domFx_profile_abstract_Array elemFx_profile_abstract_array
domFx_profile_Array elemFx_profile_array
domImage_Array elemImage_array
domFx_newparam_Array elemNewparam_array
domFx_newparam_common_Array elemNewparam_array

Detailed Description

A self contained description of a shader effect.

Definition at line 27 of file 1.4/dom/domEffect.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 179 of file 1.4/dom/domEffect.h.

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

Destructor

Definition at line 183 of file 1.4/dom/domEffect.h.

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

Constructor

Definition at line 131 of file dom/domEffect.h.

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

Destructor

Definition at line 135 of file dom/domEffect.h.

Member Function Documentation

static DLLSPEC daeElementRef domEffect::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 domEffect::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 domFx_annotate_Array& domEffect::getAnnotate_array (  )  const [inline]

Gets the annotate element array.

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

Definition at line 96 of file dom/domEffect.h.

domFx_annotate_Array& domEffect::getAnnotate_array (  )  [inline]

Gets the annotate element array.

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

Definition at line 91 of file dom/domEffect.h.

const domFx_annotate_common_Array& domEffect::getAnnotate_array (  )  const [inline]

Gets the annotate element array.

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

Definition at line 123 of file 1.4/dom/domEffect.h.

domFx_annotate_common_Array& domEffect::getAnnotate_array (  )  [inline]

Gets the annotate element array.

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

Definition at line 118 of file 1.4/dom/domEffect.h.

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 86 of file dom/domEffect.h.

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 113 of file 1.4/dom/domEffect.h.

const daeElementRefArray& domEffect::getContents (  )  const [inline]

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

Definition at line 173 of file 1.4/dom/domEffect.h.

daeElementRefArray& domEffect::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 168 of file 1.4/dom/domEffect.h.

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

Reimplemented from daeElement.

Definition at line 21 of file dom/domEffect.h.

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

Reimplemented from daeElement.

Definition at line 30 of file 1.4/dom/domEffect.h.

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

Gets the extra element array.

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

Definition at line 126 of file dom/domEffect.h.

domExtra_Array& domEffect::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 121 of file dom/domEffect.h.

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

Gets the extra element array.

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

Definition at line 163 of file 1.4/dom/domEffect.h.

domExtra_Array& domEffect::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 158 of file 1.4/dom/domEffect.h.

const domFx_profile_abstract_Array& domEffect::getFx_profile_abstract_array (  )  const [inline]

Gets the fx_profile_abstract element array.

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

Definition at line 153 of file 1.4/dom/domEffect.h.

domFx_profile_abstract_Array& domEffect::getFx_profile_abstract_array (  )  [inline]

Gets the fx_profile_abstract element array.

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

Definition at line 148 of file 1.4/dom/domEffect.h.

const domFx_profile_Array& domEffect::getFx_profile_array (  )  const [inline]

Gets the fx_profile element array.

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

Definition at line 116 of file dom/domEffect.h.

domFx_profile_Array& domEffect::getFx_profile_array (  )  [inline]

Gets the fx_profile element array.

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

Definition at line 111 of file dom/domEffect.h.

xsID domEffect::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 62 of file dom/domEffect.h.

xsID domEffect::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 89 of file 1.4/dom/domEffect.h.

const domImage_Array& domEffect::getImage_array (  )  const [inline]

Gets the image element array.

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

Definition at line 133 of file 1.4/dom/domEffect.h.

domImage_Array& domEffect::getImage_array (  )  [inline]

Gets the image element array.

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

Definition at line 128 of file 1.4/dom/domEffect.h.

xsToken domEffect::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 75 of file dom/domEffect.h.

xsNCName domEffect::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 102 of file 1.4/dom/domEffect.h.

const domFx_newparam_Array& domEffect::getNewparam_array (  )  const [inline]

Gets the newparam element array.

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

Definition at line 106 of file dom/domEffect.h.

domFx_newparam_Array& domEffect::getNewparam_array (  )  [inline]

Gets the newparam element array.

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

Definition at line 101 of file dom/domEffect.h.

const domFx_newparam_common_Array& domEffect::getNewparam_array (  )  const [inline]

Gets the newparam element array.

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

Definition at line 143 of file 1.4/dom/domEffect.h.

domFx_newparam_common_Array& domEffect::getNewparam_array (  )  [inline]

Gets the newparam element array.

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

Definition at line 138 of file 1.4/dom/domEffect.h.

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

Definition at line 22 of file dom/domEffect.h.

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

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

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

Overloaded assignment operator

Definition at line 139 of file dom/domEffect.h.

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

Overloaded assignment operator

Definition at line 187 of file 1.4/dom/domEffect.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 67 of file dom/domEffect.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 94 of file 1.4/dom/domEffect.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 80 of file dom/domEffect.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 107 of file 1.4/dom/domEffect.h.

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

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

Member Data Documentation

daeElementRefArray domEffect::_contents [protected]

Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Definition at line 77 of file 1.4/dom/domEffect.h.

daeUIntArray domEffect::_contentsOrder [protected]

Used to preserve order in elements that have a complex content model.

Definition at line 81 of file 1.4/dom/domEffect.h.

xsID domEffect::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 39 of file 1.4/dom/domEffect.h.

xsToken domEffect::attrName [protected]

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

Definition at line 34 of file dom/domEffect.h.

xsNCName domEffect::attrName [protected]

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

Definition at line 43 of file 1.4/dom/domEffect.h.

domFx_annotate_Array domEffect::elemAnnotate_array [protected]

The annotate element allows you to specify an annotation on this effect.

See also:
domAnnotate

Definition at line 45 of file dom/domEffect.h.

domFx_annotate_common_Array domEffect::elemAnnotate_array [protected]

The annotate element allows you to specify an annotation on this effect.

See also:
domAnnotate

Definition at line 54 of file 1.4/dom/domEffect.h.

domAssetRef domEffect::elemAsset [protected]

The effect element may contain an asset element.

See also:
domAsset

Definition at line 49 of file 1.4/dom/domEffect.h.

domExtra_Array domEffect::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

Definition at line 73 of file 1.4/dom/domEffect.h.

domFx_profile_abstract_Array domEffect::elemFx_profile_abstract_array [protected]

This is the substituion group hook which allows you to swap in other COLLADA FX profiles.

See also:
domFx_profile_abstract

Definition at line 69 of file 1.4/dom/domEffect.h.

domFx_profile_Array domEffect::elemFx_profile_array [protected]

Definition at line 51 of file dom/domEffect.h.

domImage_Array domEffect::elemImage_array [protected]

The image element allows you to create image resources which can be shared by multipe profiles.

See also:
domImage

Definition at line 59 of file 1.4/dom/domEffect.h.

domFx_newparam_Array domEffect::elemNewparam_array [protected]

The newparam element allows you to create new effect parameters which can be shared by multipe profiles.

See also:
domNewparam

Definition at line 50 of file dom/domEffect.h.

domFx_newparam_common_Array domEffect::elemNewparam_array [protected]

The newparam element allows you to create new effect parameters which can be shared by multipe profiles.

See also:
domNewparam

Definition at line 64 of file 1.4/dom/domEffect.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:29:52 2013