COLLADA 1.4 DOM: domController Class Reference

COLLADA

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

domController Class Reference

#include <domController.h>

Inheritance diagram for domController:

Inheritance graph
[legend]
Collaboration diagram for domController:

Collaboration graph
[legend]
List of all members.

Detailed Description

The controller element categorizes the declaration of generic control information.

A controller is a device or mechanism that manages and directs the operations of another object. A controller element contains the elements that describe control data. The actual type and complexity of the data is left to the child elements to represent in detail.

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.
xsIDREF & getTarget ()
 Gets the target attribute.
const xsIDREF & getTarget () const
 Gets the target attribute.
void setTarget (const xsIDREF &atTarget)
 Sets the target attribute.
const domSkinRef getSkin () const
 Gets the skin element.

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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the controller element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsIDREF attrTarget
 The target attribute indicates the ID of the geometry element bound to the controller.
domSkinRef elemSkin
 The skin element must occur exactly one time.

Member Function Documentation

daeElementRef domController::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.

xsID domController::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domController::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domSkinRef domController::getSkin (   )  const [inline]
 

Gets the skin element.

Returns:
a daeSmartRef to the skin element.

const xsIDREF& domController::getTarget (   )  const [inline]
 

Gets the target attribute.

Returns:
Returns a constant xsIDREF reference of the target attribute.

xsIDREF& domController::getTarget (   )  [inline]
 

Gets the target attribute.

Returns:
Returns a xsIDREF reference of the target attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domController::setTarget (  const xsIDREF &  atTarget  )  [inline]
 

Sets the target attribute.

Parameters:
atTarget The new value for the target attribute.

Member Data Documentation

xsID domController::attrId [protected]
 

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

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

xsNCName domController::attrName [protected]
 

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

Optional attribute.

xsIDREF domController::attrTarget [protected]
 

The target attribute indicates the ID of the geometry element bound to the controller.

Required attribute.

domSkinRef domController::elemSkin [protected]
 

The skin element must occur exactly one time.

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

previous page start next page