domVisual_scene::domEvaluate_scene::domRender Class Reference

#include <domVisual_scene.h>

Inheritance diagram for domVisual_scene::domEvaluate_scene::domRender:
Inheritance graph
[legend]

List of all members.

Classes

class  domInstance_material
class  domLayer

Public Types

typedef daeTArray
< domInstance_materialRef
domInstance_material_Array
typedef daeSmartRef
< domInstance_material
domInstance_materialRef
typedef daeTArray< domLayerRefdomLayer_Array
typedef daeTArray< domLayerRefdomLayer_Array
typedef daeSmartRef< domLayerdomLayerRef
typedef daeSmartRef< domLayerdomLayerRef

Public Member Functions

const xsAnyURIgetCamera_node () const
xsAnyURIgetCamera_node ()
const xsAnyURIgetCamera_node () const
xsAnyURIgetCamera_node ()
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domExtra_ArraygetExtra_array () const
domExtra_ArraygetExtra_array ()
const domInstance_effectRef getInstance_effect () const
const domInstance_materialRef getInstance_material () const
const domLayer_ArraygetLayer_array () const
domLayer_ArraygetLayer_array ()
const domLayer_ArraygetLayer_array () const
domLayer_ArraygetLayer_array ()
xsToken getName () const
domSid getSid () const
void setCamera_node (xsString atCamera_node)
void setCamera_node (const xsAnyURI &atCamera_node)
void setCamera_node (xsString atCamera_node)
void setCamera_node (const xsAnyURI &atCamera_node)
void setName (xsToken atName)
void setSid (domSid atSid)
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

 domRender (DAE &dae)
 domRender (DAE &dae)
virtual domRenderoperator= (const domRender &cpy)
virtual domRenderoperator= (const domRender &cpy)
virtual ~domRender ()
virtual ~domRender ()

Protected Attributes

xsAnyURI attrCamera_node
xsToken attrName
domSid attrSid
domExtra_Array elemExtra_array
domInstance_effectRef elemInstance_effect
domInstance_materialRef elemInstance_material
domLayer_Array elemLayer_array

Detailed Description

The render element describes one effect pass to evaluate the scene. There must be at least one render element.

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


Member Typedef Documentation

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

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

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

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

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

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


Constructor & Destructor Documentation

domVisual_scene::domEvaluate_scene::domRender::domRender ( DAE dae  )  [inline, protected]

Constructor

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

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

Destructor

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

domVisual_scene::domEvaluate_scene::domRender::domRender ( DAE dae  )  [inline, protected]

Constructor

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

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

Destructor

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


Member Function Documentation

static DLLSPEC daeElementRef domVisual_scene::domEvaluate_scene::domRender::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::domEvaluate_scene::domRender::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 xsAnyURI& domVisual_scene::domEvaluate_scene::domRender::getCamera_node (  )  const [inline]

Gets the camera_node attribute.

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

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

xsAnyURI& domVisual_scene::domEvaluate_scene::domRender::getCamera_node (  )  [inline]

Gets the camera_node attribute.

Returns:
Returns a xsAnyURI reference of the camera_node attribute.

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

const xsAnyURI& domVisual_scene::domEvaluate_scene::domRender::getCamera_node (  )  const [inline]

Gets the camera_node attribute.

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

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

xsAnyURI& domVisual_scene::domEvaluate_scene::domRender::getCamera_node (  )  [inline]

Gets the camera_node attribute.

Returns:
Returns a xsAnyURI reference of the camera_node attribute.

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

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

Reimplemented from daeElement.

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

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

Reimplemented from daeElement.

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

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

Gets the extra element array.

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

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

domExtra_Array& domVisual_scene::domEvaluate_scene::domRender::getExtra_array (  )  [inline]

Gets the extra element array.

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

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

const domInstance_effectRef domVisual_scene::domEvaluate_scene::domRender::getInstance_effect (  )  const [inline]

Gets the instance_effect element.

Returns:
a daeSmartRef to the instance_effect element.

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

const domInstance_materialRef domVisual_scene::domEvaluate_scene::domRender::getInstance_material (  )  const [inline]

Gets the instance_material element.

Returns:
a daeSmartRef to the instance_material element.

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

const domLayer_Array& domVisual_scene::domEvaluate_scene::domRender::getLayer_array (  )  const [inline]

Gets the layer element array.

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

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

domLayer_Array& domVisual_scene::domEvaluate_scene::domRender::getLayer_array (  )  [inline]

Gets the layer element array.

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

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

const domLayer_Array& domVisual_scene::domEvaluate_scene::domRender::getLayer_array (  )  const [inline]

Gets the layer element array.

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

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

domLayer_Array& domVisual_scene::domEvaluate_scene::domRender::getLayer_array (  )  [inline]

Gets the layer element array.

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

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

xsToken domVisual_scene::domEvaluate_scene::domRender::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

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

domSid domVisual_scene::domEvaluate_scene::domRender::getSid (  )  const [inline]

Gets the sid attribute.

Returns:
Returns a domSid of the sid attribute.

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

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

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

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

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

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

Overloaded assignment operator

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

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

Overloaded assignment operator

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

static DLLSPEC daeMetaElement* domVisual_scene::domEvaluate_scene::domRender::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::domEvaluate_scene::domRender::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::domEvaluate_scene::domRender::setCamera_node ( xsString  atCamera_node  )  [inline]

Sets the camera_node attribute.

Parameters:
atCamera_node The new value for the camera_node attribute.

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

void domVisual_scene::domEvaluate_scene::domRender::setCamera_node ( const xsAnyURI atCamera_node  )  [inline]

Sets the camera_node attribute.

Parameters:
atCamera_node The new value for the camera_node attribute.

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

void domVisual_scene::domEvaluate_scene::domRender::setCamera_node ( xsString  atCamera_node  )  [inline]

Sets the camera_node attribute.

Parameters:
atCamera_node The new value for the camera_node attribute.

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

void domVisual_scene::domEvaluate_scene::domRender::setCamera_node ( const xsAnyURI atCamera_node  )  [inline]

Sets the camera_node attribute.

Parameters:
atCamera_node The new value for the camera_node attribute.

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

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

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

void domVisual_scene::domEvaluate_scene::domRender::setSid ( domSid  atSid  )  [inline]

Sets the sid attribute.

Parameters:
atSid The new value for the sid attribute.

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

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

virtual daeInt domVisual_scene::domEvaluate_scene::domRender::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 66 of file 1.4/dom/domVisual_scene.h.


Member Data Documentation

The camera_node attribute refers to a node that contains a camera describing the viewpoint to render this compositing step from.

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

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

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

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

The extra element may appear any number of times.

See also:
domExtra

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

The instance_effect element specifies which effect to render in this compositing step while evaluating the scene.

See also:
domInstance_effect

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

The instance_material element specifies which effect to render in this compositing step while evaluating the scene.

See also:
domInstance_material

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

The layer element specifies which layer to render in this compositing step while evaluating the scene. You may specify any number of layers.

See also:
domLayer

The layer element specifies which layer to render in this compositing step while evaluating the scene. You may specify any number of layers. No layers mans that the entire scene will be used.

See also:
domLayer

Definition at line 144 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