domPolygons Class Reference

#include <domPolygons.h>

Inheritance diagram for domPolygons:
Inheritance graph
[legend]

List of all members.

Classes

class  domPh

Public Types

typedef daeTArray< domPhRef > domPh_Array
typedef daeTArray< domPhRef > domPh_Array
typedef daeSmartRef< domPh > domPhRef
typedef daeSmartRef< domPh > domPhRef

Public Member Functions

const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
domUint getCount () const
domUint getCount () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
const domInput_local_offset_Array & getInput_array () const
domInput_local_offset_Array & getInput_array ()
const domInputLocalOffset_Array & getInput_array () const
domInputLocalOffset_Array & getInput_array ()
xsNCName getMaterial () const
xsNCName getMaterial () const
xsToken getName () const
xsNCName getName () const
const domP_Array & getP_array () const
domP_Array & getP_array ()
const domP_Array & getP_array () const
domP_Array & getP_array ()
const domPh_Array & getPh_array () const
domPh_Array & getPh_array ()
const domPh_Array & getPh_array () const
domPh_Array & getPh_array ()
void setCount (domUint atCount)
void setCount (domUint atCount)
void setMaterial (xsNCName atMaterial)
void setMaterial (xsNCName atMaterial)
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

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

Protected Attributes

daeTArray< daeCharArray * > _CMData
daeElementRefArray _contents
daeUIntArray _contentsOrder
domUint attrCount
xsNCName attrMaterial
xsToken attrName
xsNCName attrName
domExtra_Array elemExtra_array
domInput_local_offset_Array elemInput_array
domInputLocalOffset_Array elemInput_array
domP_Array elemP_array
domPh_Array elemPh_array

Detailed Description

The polygons element provides the information needed to bind vertex attributes together and then organize those vertices into individual polygons. The polygons described can contain arbitrary numbers of vertices. These polygons may be self intersecting and may also contain holes.

Definition at line 27 of file 1.4/dom/domPolygons.h.

Member Typedef Documentation

typedef daeTArray<domPhRef> domPolygons::domPh_Array

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

typedef daeTArray<domPhRef> domPolygons::domPh_Array

Definition at line 37 of file 1.4/dom/domPolygons.h.

typedef daeSmartRef<domPh> domPolygons::domPhRef

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

typedef daeSmartRef<domPh> domPolygons::domPhRef

Definition at line 34 of file 1.4/dom/domPolygons.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 314 of file 1.4/dom/domPolygons.h.

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

Destructor

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

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

Constructor

Definition at line 303 of file dom/domPolygons.h.

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

Destructor

Definition at line 307 of file dom/domPolygons.h.

Member Function Documentation

static DLLSPEC daeElementRef domPolygons::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 domPolygons::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 daeElementRefArray& domPolygons::getContents (  )  const [inline]

Gets the _contents array.

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

Definition at line 297 of file dom/domPolygons.h.

daeElementRefArray& domPolygons::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 292 of file dom/domPolygons.h.

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

Gets the _contents array.

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

Definition at line 308 of file 1.4/dom/domPolygons.h.

daeElementRefArray& domPolygons::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 303 of file 1.4/dom/domPolygons.h.

domUint domPolygons::getCount (  )  const [inline]

Gets the count attribute.

Returns:
Returns a domUint of the count attribute.

Definition at line 230 of file dom/domPolygons.h.

domUint domPolygons::getCount (  )  const [inline]

Gets the count attribute.

Returns:
Returns a domUint of the count attribute.

Definition at line 241 of file 1.4/dom/domPolygons.h.

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

Reimplemented from daeElement.

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

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

Reimplemented from daeElement.

Definition at line 30 of file 1.4/dom/domPolygons.h.

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

Gets the extra element array.

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

Definition at line 287 of file dom/domPolygons.h.

domExtra_Array& domPolygons::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 282 of file dom/domPolygons.h.

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

Gets the extra element array.

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

Definition at line 298 of file 1.4/dom/domPolygons.h.

domExtra_Array& domPolygons::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 293 of file 1.4/dom/domPolygons.h.

const domInput_local_offset_Array& domPolygons::getInput_array (  )  const [inline]

Gets the input element array.

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

Definition at line 257 of file dom/domPolygons.h.

domInput_local_offset_Array& domPolygons::getInput_array (  )  [inline]

Gets the input element array.

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

Definition at line 252 of file dom/domPolygons.h.

const domInputLocalOffset_Array& domPolygons::getInput_array (  )  const [inline]

Gets the input element array.

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

Definition at line 268 of file 1.4/dom/domPolygons.h.

domInputLocalOffset_Array& domPolygons::getInput_array (  )  [inline]

Gets the input element array.

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

Definition at line 263 of file 1.4/dom/domPolygons.h.

xsNCName domPolygons::getMaterial (  )  const [inline]

Gets the material attribute.

Returns:
Returns a xsNCName of the material attribute.

Definition at line 241 of file dom/domPolygons.h.

xsNCName domPolygons::getMaterial (  )  const [inline]

Gets the material attribute.

Returns:
Returns a xsNCName of the material attribute.

Definition at line 252 of file 1.4/dom/domPolygons.h.

xsToken domPolygons::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 219 of file dom/domPolygons.h.

xsNCName domPolygons::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 230 of file 1.4/dom/domPolygons.h.

const domP_Array& domPolygons::getP_array (  )  const [inline]

Gets the p element array.

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

Definition at line 267 of file dom/domPolygons.h.

domP_Array& domPolygons::getP_array (  )  [inline]

Gets the p element array.

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

Definition at line 262 of file dom/domPolygons.h.

const domP_Array& domPolygons::getP_array (  )  const [inline]

Gets the p element array.

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

Definition at line 278 of file 1.4/dom/domPolygons.h.

domP_Array& domPolygons::getP_array (  )  [inline]

Gets the p element array.

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

Definition at line 273 of file 1.4/dom/domPolygons.h.

const domPh_Array& domPolygons::getPh_array (  )  const [inline]

Gets the ph element array.

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

Definition at line 277 of file dom/domPolygons.h.

domPh_Array& domPolygons::getPh_array (  )  [inline]

Gets the ph element array.

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

Definition at line 272 of file dom/domPolygons.h.

const domPh_Array& domPolygons::getPh_array (  )  const [inline]

Gets the ph element array.

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

Definition at line 288 of file 1.4/dom/domPolygons.h.

domPh_Array& domPolygons::getPh_array (  )  [inline]

Gets the ph element array.

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

Definition at line 283 of file 1.4/dom/domPolygons.h.

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

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

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

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

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

Overloaded assignment operator

Definition at line 311 of file dom/domPolygons.h.

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

Overloaded assignment operator

Definition at line 322 of file 1.4/dom/domPolygons.h.

static DLLSPEC daeMetaElement* domPolygons::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* domPolygons::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 domPolygons::setCount ( domUint  atCount  )  [inline]

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

Definition at line 235 of file dom/domPolygons.h.

void domPolygons::setCount ( domUint  atCount  )  [inline]

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

Definition at line 246 of file 1.4/dom/domPolygons.h.

void domPolygons::setMaterial ( xsNCName  atMaterial  )  [inline]

Sets the material attribute.

Parameters:
atMaterial The new value for the material attribute.

Definition at line 246 of file dom/domPolygons.h.

void domPolygons::setMaterial ( xsNCName  atMaterial  )  [inline]

Sets the material attribute.

Parameters:
atMaterial The new value for the material attribute.

Definition at line 257 of file 1.4/dom/domPolygons.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 224 of file dom/domPolygons.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 235 of file 1.4/dom/domPolygons.h.

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

virtual daeInt domPolygons::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 32 of file 1.4/dom/domPolygons.h.

Member Data Documentation

daeTArray< daeCharArray * > domPolygons::_CMData [protected]

Used to store information needed for some content model objects.

Definition at line 222 of file 1.4/dom/domPolygons.h.

daeElementRefArray domPolygons::_contents [protected]

Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Definition at line 213 of file 1.4/dom/domPolygons.h.

daeUIntArray domPolygons::_contentsOrder [protected]

Used to preserve order in elements that have a complex content model.

Definition at line 217 of file 1.4/dom/domPolygons.h.

domUint domPolygons::attrCount [protected]

The count attribute indicates the number of polygon primitives. Required attribute.

Definition at line 183 of file 1.4/dom/domPolygons.h.

xsNCName domPolygons::attrMaterial [protected]

The material attribute declares a symbol for a material. This symbol is bound to a material at the time of instantiation. If the material attribute is not specified then the lighting and shading results are application defined. Optional attribute.

Definition at line 190 of file 1.4/dom/domPolygons.h.

xsToken domPolygons::attrName [protected]

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

Definition at line 166 of file dom/domPolygons.h.

xsNCName domPolygons::attrName [protected]

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

Definition at line 178 of file 1.4/dom/domPolygons.h.

domExtra_Array domPolygons::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

Definition at line 209 of file 1.4/dom/domPolygons.h.

domInput_local_offset_Array domPolygons::elemInput_array [protected]

The input element may occur any number of times. This input is a local input with the offset and set attributes.

See also:
domInput

Definition at line 185 of file dom/domPolygons.h.

domInputLocalOffset_Array domPolygons::elemInput_array [protected]

The input element may occur any number of times. This input is a local input with the offset and set attributes.

See also:
domInput

Definition at line 197 of file 1.4/dom/domPolygons.h.

domP_Array domPolygons::elemP_array [protected]

The p element may occur any number of times.

See also:
domP

Definition at line 201 of file 1.4/dom/domPolygons.h.

domPh_Array domPolygons::elemPh_array [protected]

The ph element descripes a polygon with holes.

See also:
domPh

The ph element may occur any number of times. It describes a polygon with holes.

See also:
domPh

Definition at line 205 of file 1.4/dom/domPolygons.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:43 2013