COLLADA 1.4 DOM: domScene Class Reference

COLLADA

previous page next page
Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages

domScene Class Reference

#include <domScene.h>

Inheritance diagram for domScene:

Inheritance graph
[legend]
Collaboration diagram for domScene:

Collaboration graph
[legend]
List of all members.

Detailed Description

The scene embodies the entire set of information that can be visualized from the contents of a COLLADA resource.

The scene element declares the base of the 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. The hierarchical structure of the scene is organized into a scene graph. A scene graph is a directed acyclic graph (DAG) or tree data structure that contains nodes of visual information and related data. The structure of the scene graph contributes to optimal processing and rendering of the data and is therefore widely used in the computer graphics domain.

Public Member Functions

xsID getId () const
 Gets the id attribute.
void setId (xsID atId)
 Sets the id attribute.
xsNCName getName () const
 Gets the name attribute.
void setName (xsNCName atName)
 Sets the name attribute.
domLookat_Array & getLookat_array ()
 Gets the lookat element array.
const domLookat_Array & getLookat_array () const
 Gets the lookat element array.
domMatrix_Array & getMatrix_array ()
 Gets the matrix element array.
const domMatrix_Array & getMatrix_array () const
 Gets the matrix element array.
domPerspective_Array & getPerspective_array ()
 Gets the perspective element array.
const domPerspective_Array & getPerspective_array () const
 Gets the perspective element array.
domRotate_Array & getRotate_array ()
 Gets the rotate element array.
const domRotate_Array & getRotate_array () const
 Gets the rotate element array.
domScale_Array & getScale_array ()
 Gets the scale element array.
const domScale_Array & getScale_array () const
 Gets the scale element array.
domSkew_Array & getSkew_array ()
 Gets the skew element array.
const domSkew_Array & getSkew_array () const
 Gets the skew element array.
domTranslate_Array & getTranslate_array ()
 Gets the translate element array.
const domTranslate_Array & getTranslate_array () const
 Gets the translate element array.
domBoundingbox_Array & getBoundingbox_array ()
 Gets the boundingbox element array.
const domBoundingbox_Array & getBoundingbox_array () const
 Gets the boundingbox element array.
domNode_Array & getNode_array ()
 Gets the node element array.
const domNode_Array & getNode_array () const
 Gets the node element array.
domExtra_Array & getExtra_array ()
 Gets the extra element array.
const domExtra_Array & getExtra_array () const
 Gets the extra element array.
daeElementRefArray & getContents ()
 Gets the _contents array.
const daeElementRefArray & getContents () const
 Gets the _contents array.

Static Public Member Functions

static daeElementRef create (daeInt bytes)
 Creates an instance of this class and returns a daeElementRef referencing it.
static daeMetaElement * registerElement ()
 Creates a daeMetaElement object that describes this element in the meta object reflection framework.

Static Public Attributes

static daeMetaElement * _Meta = NULL
 The daeMetaElement that describes this element in the meta object reflection framework.

Protected Member Functions

 domScene ()
 Constructor.
virtual ~domScene ()
 Destructor.
 domScene (const domScene &cpy)
 Copy Constructor.
virtual domScene & operator= (const domScene &cpy)
 Overloaded assignment operator.

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the scene element.
xsNCName attrName
 The name attribute is a text string containing the name of the scene element.
domLookat_Array elemLookat_array
 Allows the scene to express a lookat transform.
domMatrix_Array elemMatrix_array
 Allows the scene to express a matrix transform.
domPerspective_Array elemPerspective_array
 Allows the scene to express a perspective transform.
domRotate_Array elemRotate_array
 Allows the scene to express a rotational transform.
domScale_Array elemScale_array
 Allows the scene to express a scale transform.
domSkew_Array elemSkew_array
 Allows the scene to express a skew transform.
domTranslate_Array elemTranslate_array
 Allows the scene to express a translational transform.
domBoundingbox_Array elemBoundingbox_array
 Allows the scene to express a bounding box.
domNode_Array elemNode_array
 Allows the scene to recursively define hierarchy.
domExtra_Array elemExtra_array
 Allows the scene to define extra information.
daeElementRefArray _contents
 Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Member Function Documentation

daeElementRef domScene::create (  daeInt  bytes  )  [static]
 

Creates an instance of this class and returns a daeElementRef referencing it.

Parameters:
bytes The size allocated for this instance.
Returns:
a daeElementRef referencing an instance of this object.

const domBoundingbox_Array& domScene::getBoundingbox_array (   )  const [inline]
 

Gets the boundingbox element array.

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

domBoundingbox_Array& domScene::getBoundingbox_array (   )  [inline]
 

Gets the boundingbox element array.

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

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

Gets the _contents array.

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

daeElementRefArray& domScene::getContents (   )  [inline]
 

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

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

Gets the extra element array.

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

domExtra_Array& domScene::getExtra_array (   )  [inline]
 

Gets the extra element array.

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

xsID domScene::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

const domLookat_Array& domScene::getLookat_array (   )  const [inline]
 

Gets the lookat element array.

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

domLookat_Array& domScene::getLookat_array (   )  [inline]
 

Gets the lookat element array.

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

const domMatrix_Array& domScene::getMatrix_array (   )  const [inline]
 

Gets the matrix element array.

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

domMatrix_Array& domScene::getMatrix_array (   )  [inline]
 

Gets the matrix element array.

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

xsNCName domScene::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

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

Gets the node element array.

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

domNode_Array& domScene::getNode_array (   )  [inline]
 

Gets the node element array.

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

const domPerspective_Array& domScene::getPerspective_array (   )  const [inline]
 

Gets the perspective element array.

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

domPerspective_Array& domScene::getPerspective_array (   )  [inline]
 

Gets the perspective element array.

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

const domRotate_Array& domScene::getRotate_array (   )  const [inline]
 

Gets the rotate element array.

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

domRotate_Array& domScene::getRotate_array (   )  [inline]
 

Gets the rotate element array.

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

const domScale_Array& domScene::getScale_array (   )  const [inline]
 

Gets the scale element array.

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

domScale_Array& domScene::getScale_array (   )  [inline]
 

Gets the scale element array.

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

const domSkew_Array& domScene::getSkew_array (   )  const [inline]
 

Gets the skew element array.

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

domSkew_Array& domScene::getSkew_array (   )  [inline]
 

Gets the skew element array.

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

const domTranslate_Array& domScene::getTranslate_array (   )  const [inline]
 

Gets the translate element array.

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

domTranslate_Array& domScene::getTranslate_array (   )  [inline]
 

Gets the translate element array.

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

daeMetaElement * domScene::registerElement (   )  [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 domScene::setId (  xsID  atId  )  [inline]
 

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domScene::attrId [protected]
 

The id attribute is a text string containing the unique identifier of the scene element.

This value must be unique within the instance document. Optional attribute.

xsNCName domScene::attrName [protected]
 

The name attribute is a text string containing the name of the scene element.

Optional attribute.

domBoundingbox_Array domScene::elemBoundingbox_array [protected]
 

Allows the scene to express a bounding box.

See also:
domBoundingbox

domExtra_Array domScene::elemExtra_array [protected]
 

Allows the scene to define extra information.

See also:
domExtra

domLookat_Array domScene::elemLookat_array [protected]
 

Allows the scene to express a lookat transform.

See also:
domLookat

domMatrix_Array domScene::elemMatrix_array [protected]
 

Allows the scene to express a matrix transform.

See also:
domMatrix

domNode_Array domScene::elemNode_array [protected]
 

Allows the scene to recursively define hierarchy.

See also:
domNode

domPerspective_Array domScene::elemPerspective_array [protected]
 

Allows the scene to express a perspective transform.

See also:
domPerspective

domRotate_Array domScene::elemRotate_array [protected]
 

Allows the scene to express a rotational transform.

See also:
domRotate

domScale_Array domScene::elemScale_array [protected]
 

Allows the scene to express a scale transform.

See also:
domScale

domSkew_Array domScene::elemSkew_array [protected]
 

Allows the scene to express a skew transform.

See also:
domSkew

domTranslate_Array domScene::elemTranslate_array [protected]
 

Allows the scene to express a translational transform.

See also:
domTranslate
The documentation for this class was generated from the following files:
  • C:/SVN_wf/COLLADA_DOM/include/1.3/dom/domScene.h
  • C:/SVN_wf/COLLADA_DOM/src/1.3/dom/domScene.cpp
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:49:51 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page