domInstance_effect Class Reference

#include <domInstance_effect.h>

Inheritance diagram for domInstance_effect:
Inheritance graph
[legend]

List of all members.

Classes

class  domSetparam
class  domTechnique_hint

Public Types

typedef daeTArray< domSetparamRef > domSetparam_Array
typedef daeTArray< domSetparamRef > domSetparam_Array
typedef daeSmartRef< domSetparam > domSetparamRef
typedef daeSmartRef< domSetparam > domSetparamRef
typedef daeTArray
< domTechnique_hintRef > 		domTechnique_hint_Array
typedef daeTArray
< domTechnique_hintRef > 		domTechnique_hint_Array
typedef daeSmartRef
< domTechnique_hint > 		domTechnique_hintRef
typedef daeSmartRef
< domTechnique_hint > 		domTechnique_hintRef

Public Member Functions

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 ()
xsToken getName () const
xsNCName getName () const
const domSetparam_Array & getSetparam_array () const
domSetparam_Array & getSetparam_array ()
const domSetparam_Array & getSetparam_array () const
domSetparam_Array & getSetparam_array ()
domSid getSid () const
xsNCName getSid () const
const domTechnique_hint_Array & getTechnique_hint_array () const
domTechnique_hint_Array & getTechnique_hint_array ()
const domTechnique_hint_Array & getTechnique_hint_array () const
domTechnique_hint_Array & getTechnique_hint_array ()
const xsAnyURI & getUrl () const
xsAnyURI & getUrl ()
const xsAnyURI & getUrl () const
xsAnyURI & getUrl ()
void setName (xsToken atName)
void setName (xsNCName atName)
void setSid (domSid atSid)
void setSid (xsNCName atSid)
void setUrl (xsString atUrl)
void setUrl (const xsAnyURI &atUrl)
void setUrl (xsString atUrl)
void setUrl (const xsAnyURI &atUrl)
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

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

Protected Attributes

xsToken attrName
xsNCName attrName
domSid attrSid
xsNCName attrSid
xsAnyURI attrUrl
domExtra_Array elemExtra_array
domSetparam_Array elemSetparam_array
domTechnique_hint_Array elemTechnique_hint_array

Detailed Description

The instance_effect element declares the instantiation of a COLLADA effect resource.

Definition at line 24 of file 1.4/dom/domInstance_effect.h.

Member Typedef Documentation

typedef daeTArray<domSetparamRef> domInstance_effect::domSetparam_Array

Definition at line 119 of file dom/domInstance_effect.h.

typedef daeTArray<domSetparamRef> domInstance_effect::domSetparam_Array

Definition at line 127 of file 1.4/dom/domInstance_effect.h.

typedef daeSmartRef<domSetparam> domInstance_effect::domSetparamRef

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

typedef daeSmartRef<domSetparam> domInstance_effect::domSetparamRef

Definition at line 124 of file 1.4/dom/domInstance_effect.h.

typedef daeTArray<domTechnique_hintRef> domInstance_effect::domTechnique_hint_Array

Definition at line 26 of file dom/domInstance_effect.h.

typedef daeTArray<domTechnique_hintRef> domInstance_effect::domTechnique_hint_Array

Definition at line 34 of file 1.4/dom/domInstance_effect.h.

typedef daeSmartRef<domTechnique_hint> domInstance_effect::domTechnique_hintRef

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

typedef daeSmartRef<domTechnique_hint> domInstance_effect::domTechnique_hintRef

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

Constructor & Destructor Documentation

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

Constructor

Definition at line 302 of file 1.4/dom/domInstance_effect.h.

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

Destructor

Definition at line 306 of file 1.4/dom/domInstance_effect.h.

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

Constructor

Definition at line 294 of file dom/domInstance_effect.h.

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

Destructor

Definition at line 298 of file dom/domInstance_effect.h.

Member Function Documentation

static DLLSPEC daeElementRef domInstance_effect::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 domInstance_effect::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.
virtual COLLADA_TYPE::TypeEnum domInstance_effect::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 19 of file dom/domInstance_effect.h.

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

Reimplemented from daeElement.

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

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

Gets the extra element array.

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

Definition at line 289 of file dom/domInstance_effect.h.

domExtra_Array& domInstance_effect::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 284 of file dom/domInstance_effect.h.

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

Gets the extra element array.

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

Definition at line 297 of file 1.4/dom/domInstance_effect.h.

domExtra_Array& domInstance_effect::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 292 of file 1.4/dom/domInstance_effect.h.

xsToken domInstance_effect::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 253 of file dom/domInstance_effect.h.

xsNCName domInstance_effect::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 261 of file 1.4/dom/domInstance_effect.h.

const domSetparam_Array& domInstance_effect::getSetparam_array (  )  const [inline]

Gets the setparam element array.

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

Definition at line 279 of file dom/domInstance_effect.h.

domSetparam_Array& domInstance_effect::getSetparam_array (  )  [inline]

Gets the setparam element array.

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

Definition at line 274 of file dom/domInstance_effect.h.

const domSetparam_Array& domInstance_effect::getSetparam_array (  )  const [inline]

Gets the setparam element array.

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

Definition at line 287 of file 1.4/dom/domInstance_effect.h.

domSetparam_Array& domInstance_effect::getSetparam_array (  )  [inline]

Gets the setparam element array.

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

Definition at line 282 of file 1.4/dom/domInstance_effect.h.

domSid domInstance_effect::getSid (  )  const [inline]

Gets the sid attribute.

Returns:
Returns a domSid of the sid attribute.

Definition at line 242 of file dom/domInstance_effect.h.

xsNCName domInstance_effect::getSid (  )  const [inline]

Gets the sid attribute.

Returns:
Returns a xsNCName of the sid attribute.

Definition at line 250 of file 1.4/dom/domInstance_effect.h.

const domTechnique_hint_Array& domInstance_effect::getTechnique_hint_array (  )  const [inline]

Gets the technique_hint element array.

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

Definition at line 269 of file dom/domInstance_effect.h.

domTechnique_hint_Array& domInstance_effect::getTechnique_hint_array (  )  [inline]

Gets the technique_hint element array.

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

Definition at line 264 of file dom/domInstance_effect.h.

const domTechnique_hint_Array& domInstance_effect::getTechnique_hint_array (  )  const [inline]

Gets the technique_hint element array.

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

Definition at line 277 of file 1.4/dom/domInstance_effect.h.

domTechnique_hint_Array& domInstance_effect::getTechnique_hint_array (  )  [inline]

Gets the technique_hint element array.

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

Definition at line 272 of file 1.4/dom/domInstance_effect.h.

const xsAnyURI& domInstance_effect::getUrl (  )  const [inline]

Gets the url attribute.

Returns:
Returns a constant xsAnyURI reference of the url attribute.

Definition at line 226 of file dom/domInstance_effect.h.

xsAnyURI& domInstance_effect::getUrl (  )  [inline]

Gets the url attribute.

Returns:
Returns a xsAnyURI reference of the url attribute.

Definition at line 221 of file dom/domInstance_effect.h.

const xsAnyURI& domInstance_effect::getUrl (  )  const [inline]

Gets the url attribute.

Returns:
Returns a constant xsAnyURI reference of the url attribute.

Definition at line 234 of file 1.4/dom/domInstance_effect.h.

xsAnyURI& domInstance_effect::getUrl (  )  [inline]

Gets the url attribute.

Returns:
Returns a xsAnyURI reference of the url attribute.

Definition at line 229 of file 1.4/dom/domInstance_effect.h.

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

Definition at line 20 of file dom/domInstance_effect.h.

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

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

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

Overloaded assignment operator

Definition at line 302 of file dom/domInstance_effect.h.

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

Overloaded assignment operator

Definition at line 310 of file 1.4/dom/domInstance_effect.h.

static DLLSPEC daeMetaElement* domInstance_effect::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* domInstance_effect::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 domInstance_effect::setName ( xsToken  atName  )  [inline]

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 258 of file dom/domInstance_effect.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 266 of file 1.4/dom/domInstance_effect.h.

void domInstance_effect::setSid ( domSid  atSid  )  [inline]

Sets the sid attribute.

Parameters:
atSid The new value for the sid attribute.

Definition at line 247 of file dom/domInstance_effect.h.

void domInstance_effect::setSid ( xsNCName  atSid  )  [inline]

Sets the sid attribute.

Parameters:
atSid The new value for the sid attribute.

Definition at line 255 of file 1.4/dom/domInstance_effect.h.

void domInstance_effect::setUrl ( xsString  atUrl  )  [inline]

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

Definition at line 236 of file dom/domInstance_effect.h.

void domInstance_effect::setUrl ( const xsAnyURI &  atUrl  )  [inline]

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

Definition at line 231 of file dom/domInstance_effect.h.

void domInstance_effect::setUrl ( xsString  atUrl  )  [inline]

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

Definition at line 244 of file 1.4/dom/domInstance_effect.h.

void domInstance_effect::setUrl ( const xsAnyURI &  atUrl  )  [inline]

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

Definition at line 239 of file 1.4/dom/domInstance_effect.h.

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

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

Member Data Documentation

xsToken domInstance_effect::attrName [protected]

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

Definition at line 199 of file dom/domInstance_effect.h.

xsNCName domInstance_effect::attrName [protected]

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

Definition at line 207 of file 1.4/dom/domInstance_effect.h.

domSid domInstance_effect::attrSid [protected]

The sid attribute is a text string value containing the sub-identifier of this element. This value must be unique within the scope of the parent element. Optional attribute.

Definition at line 195 of file dom/domInstance_effect.h.

xsNCName domInstance_effect::attrSid [protected]

The sid attribute is a text string value containing the sub-identifier of this element. This value must be unique within the scope of the parent element. Optional attribute.

Definition at line 203 of file 1.4/dom/domInstance_effect.h.

xsAnyURI domInstance_effect::attrUrl [protected]

The url attribute refers to resource. This may refer to a local resource using a relative URL fragment identifier that begins with the “#” character. The url attribute may refer to an external resource using an absolute or relative URL.

The url attribute refers to resource. This may refer to a local resource using a relative URL fragment identifier that begins with the "#" character. The url attribute may refer to an external resource using an absolute or relative URL.

Definition at line 197 of file 1.4/dom/domInstance_effect.h.

domExtra_Array domInstance_effect::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

Definition at line 222 of file 1.4/dom/domInstance_effect.h.

domSetparam_Array domInstance_effect::elemSetparam_array [protected]

Assigns a new value to a previously defined parameter

See also:
domSetparam

Definition at line 218 of file 1.4/dom/domInstance_effect.h.

domTechnique_hint_Array domInstance_effect::elemTechnique_hint_array [protected]

Add a hint for a platform of which technique to use in this effect.

See also:
domTechnique_hint

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