COLLADA 1.4 DOM: domProgram Class Reference

COLLADA

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

domProgram Class Reference

#include <domProgram.h>

Inheritance diagram for domProgram:

Inheritance graph
[legend]
Collaboration diagram for domProgram:

Collaboration graph
[legend]
List of all members.

Detailed Description

The program element declares parameters and program code that executes within the application runtime environment or the graphics pipeline.

Programs use the same id/url linking (define/reference) facility as other elements. To define a program, specify an id attribute value. To refer to a program (i.e. a "function call"), reference that id value in a url attribute. Another way to refer to a program is by using a name as the URL value such as: <program url="PHONG"> In this case, the name refers to a well-known or built-in program. It's not a URI fragment (PHONG) because it's not in the same instance document. It's implicitly defined in the COMMON profile.

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.
xsAnyURI & getUrl ()
 Gets the url attribute.
const xsAnyURI & getUrl () const
 Gets the url attribute.
void setUrl (const xsAnyURI &atUrl)
 Sets the url attribute.
const domAssetRef getAsset () const
 Gets the asset element.
domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param element array.
domEntry_Array & getEntry_array ()
 Gets the entry element array.
const domEntry_Array & getEntry_array () const
 Gets the entry element array.
domCode_Array & getCode_array ()
 Gets the code element array.
const domCode_Array & getCode_array () const
 Gets the code element 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the program element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsAnyURI attrUrl
 The url attribute is a valid URL to the location of the program resource.
domAssetRef elemAsset
 This element may contain an asset element.
domParam_Array elemParam_array
 The param element may occur zero or more times.
domEntry_Array elemEntry_array
domCode_Array elemCode_array
 The code element may occur zero or one time.

Member Function Documentation

daeElementRef domProgram::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 domAssetRef domProgram::getAsset (   )  const [inline]
 

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

const domCode_Array& domProgram::getCode_array (   )  const [inline]
 

Gets the code element array.

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

domCode_Array& domProgram::getCode_array (   )  [inline]
 

Gets the code element array.

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

const domEntry_Array& domProgram::getEntry_array (   )  const [inline]
 

Gets the entry element array.

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

domEntry_Array& domProgram::getEntry_array (   )  [inline]
 

Gets the entry element array.

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

xsID domProgram::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domProgram::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domParam_Array& domProgram::getParam_array (   )  const [inline]
 

Gets the param element array.

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

domParam_Array& domProgram::getParam_array (   )  [inline]
 

Gets the param element array.

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

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

Gets the url attribute.

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

xsAnyURI& domProgram::getUrl (   )  [inline]
 

Gets the url attribute.

Returns:
Returns a xsAnyURI reference of the url attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

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

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

Member Data Documentation

xsID domProgram::attrId [protected]
 

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

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

xsNCName domProgram::attrName [protected]
 

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

Optional attribute.

xsAnyURI domProgram::attrUrl [protected]
 

The url attribute is a valid URL to the location of the program resource.

This resource contains information understood by the application run-time according to the technique profile in scope. Optional attribute.

domAssetRef domProgram::elemAsset [protected]
 

This element may contain an asset element.

See also:
domAsset

domCode_Array domProgram::elemCode_array [protected]
 

The code element may occur zero or one time.

See also:
domCode

domEntry_Array domProgram::elemEntry_array [protected]
 

See also:
domEntry

domParam_Array domProgram::elemParam_array [protected]
 

The param element may occur zero or more times.

A param element, specified as a child of the program element, indicates the interface to the program. The value of such a parameter may vary each time the program executes.

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

previous page start next page