domVisual_scene Class Reference

#include <domVisual_scene.h>

Inheritance diagram for domVisual_scene:
Inheritance graph
[legend]

List of all members.

Classes

class  domEvaluate_scene

Public Types

typedef daeTArray
< domEvaluate_sceneRef > 		domEvaluate_scene_Array
typedef daeTArray
< domEvaluate_sceneRef > 		domEvaluate_scene_Array
typedef daeSmartRef
< domEvaluate_scene > 		domEvaluate_sceneRef
typedef daeSmartRef
< domEvaluate_scene > 		domEvaluate_sceneRef

Public Member Functions

const domAssetRef getAsset () const
const domAssetRef getAsset () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domEvaluate_scene_Array & getEvaluate_scene_array () const
domEvaluate_scene_Array & getEvaluate_scene_array ()
const domEvaluate_scene_Array & getEvaluate_scene_array () const
domEvaluate_scene_Array & getEvaluate_scene_array ()
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 domNode_Array & getNode_array () const
domNode_Array & getNode_array ()
const domNode_Array & getNode_array () const
domNode_Array & getNode_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

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

Protected Attributes

xsID attrId
xsToken attrName
xsNCName attrName
domAssetRef elemAsset
domEvaluate_scene_Array elemEvaluate_scene_array
domExtra_Array elemExtra_array
domNode_Array elemNode_array

Detailed Description

The visual_scene element declares the base of the visual_scene hierarchy or scene graph. The scene contains elements that comprise much of the visual and transformational information content as created by the authoring tools.

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

Member Typedef Documentation

typedef daeTArray<domEvaluate_sceneRef> domVisual_scene::domEvaluate_scene_Array

Definition at line 29 of file dom/domVisual_scene.h.

typedef daeTArray<domEvaluate_sceneRef> domVisual_scene::domEvaluate_scene_Array

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

typedef daeSmartRef<domEvaluate_scene> domVisual_scene::domEvaluate_sceneRef

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

typedef daeSmartRef<domEvaluate_scene> domVisual_scene::domEvaluate_sceneRef

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

Constructor & Destructor Documentation

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

Constructor

Definition at line 377 of file 1.4/dom/domVisual_scene.h.

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

Destructor

Definition at line 381 of file 1.4/dom/domVisual_scene.h.

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

Constructor

Definition at line 732 of file dom/domVisual_scene.h.

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

Destructor

Definition at line 736 of file dom/domVisual_scene.h.

Member Function Documentation

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 697 of file dom/domVisual_scene.h.

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 342 of file 1.4/dom/domVisual_scene.h.

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

Reimplemented from daeElement.

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

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

Reimplemented from daeElement.

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

const domEvaluate_scene_Array& domVisual_scene::getEvaluate_scene_array (  )  const [inline]

Gets the evaluate_scene element array.

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

Definition at line 717 of file dom/domVisual_scene.h.

domEvaluate_scene_Array& domVisual_scene::getEvaluate_scene_array (  )  [inline]

Gets the evaluate_scene element array.

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

Definition at line 712 of file dom/domVisual_scene.h.

const domEvaluate_scene_Array& domVisual_scene::getEvaluate_scene_array (  )  const [inline]

Gets the evaluate_scene element array.

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

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

domEvaluate_scene_Array& domVisual_scene::getEvaluate_scene_array (  )  [inline]

Gets the evaluate_scene element array.

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

Definition at line 357 of file 1.4/dom/domVisual_scene.h.

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

Gets the extra element array.

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

Definition at line 727 of file dom/domVisual_scene.h.

domExtra_Array& domVisual_scene::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 722 of file dom/domVisual_scene.h.

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

Gets the extra element array.

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

Definition at line 372 of file 1.4/dom/domVisual_scene.h.

domExtra_Array& domVisual_scene::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 367 of file 1.4/dom/domVisual_scene.h.

xsID domVisual_scene::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 673 of file dom/domVisual_scene.h.

xsID domVisual_scene::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 318 of file 1.4/dom/domVisual_scene.h.

xsToken domVisual_scene::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 686 of file dom/domVisual_scene.h.

xsNCName domVisual_scene::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 331 of file 1.4/dom/domVisual_scene.h.

const domNode_Array& domVisual_scene::getNode_array (  )  const [inline]

Gets the node element array.

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

Definition at line 707 of file dom/domVisual_scene.h.

domNode_Array& domVisual_scene::getNode_array (  )  [inline]

Gets the node element array.

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

Definition at line 702 of file dom/domVisual_scene.h.

const domNode_Array& domVisual_scene::getNode_array (  )  const [inline]

Gets the node element array.

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

Definition at line 352 of file 1.4/dom/domVisual_scene.h.

domNode_Array& domVisual_scene::getNode_array (  )  [inline]

Gets the node element array.

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

Definition at line 347 of file 1.4/dom/domVisual_scene.h.

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

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

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

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

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

Overloaded assignment operator

Definition at line 740 of file dom/domVisual_scene.h.

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

Overloaded assignment operator

Definition at line 385 of file 1.4/dom/domVisual_scene.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 678 of file dom/domVisual_scene.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 323 of file 1.4/dom/domVisual_scene.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 691 of file dom/domVisual_scene.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 336 of file 1.4/dom/domVisual_scene.h.

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

virtual daeInt domVisual_scene::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/domVisual_scene.h.

Member Data Documentation

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

xsToken domVisual_scene::attrName [protected]

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

Definition at line 645 of file dom/domVisual_scene.h.

xsNCName domVisual_scene::attrName [protected]

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

Definition at line 291 of file 1.4/dom/domVisual_scene.h.

domAssetRef domVisual_scene::elemAsset [protected]

The visual_scene element may contain an asset element.

See also:
domAsset

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

domEvaluate_scene_Array domVisual_scene::elemEvaluate_scene_array [protected]

The evaluate_scene element declares information specifying a specific way to evaluate this visual_scene. There may be any number of evaluate_scene elements.

See also:
domEvaluate_scene

The evaluate_scene element declares information specifying how to evaluate this visual_scene. There may be any number of evaluate_scene elements. They are evaluated in order and particular one may be disabled via setting enabled=false.

See also:
domEvaluate_scene

Definition at line 307 of file 1.4/dom/domVisual_scene.h.

domExtra_Array domVisual_scene::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

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

domNode_Array domVisual_scene::elemNode_array [protected]

The visual_scene element must have at least one node element.

See also:
domNode

Definition at line 301 of file 1.4/dom/domVisual_scene.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:59 2013