domImage Class Reference

#include <domImage.h>

Inheritance diagram for domImage:
Inheritance graph
[legend]

List of all members.

Classes

class  domCreate_2d
class  domCreate_3d
class  domCreate_cube
class  domData
class  domInit_from
class  domRenderable

Public Types

typedef daeTArray
< domCreate_2dRef > 		domCreate_2d_Array
typedef daeSmartRef< domCreate_2d > domCreate_2dRef
typedef daeTArray
< domCreate_3dRef > 		domCreate_3d_Array
typedef daeSmartRef< domCreate_3d > domCreate_3dRef
typedef daeTArray
< domCreate_cubeRef > 		domCreate_cube_Array
typedef daeSmartRef
< domCreate_cube > 		domCreate_cubeRef
typedef daeTArray< domDataRef > domData_Array
typedef daeSmartRef< domData > domDataRef
typedef daeTArray
< domInit_fromRef > 		domInit_from_Array
typedef daeTArray
< domInit_fromRef > 		domInit_from_Array
typedef daeSmartRef< domInit_from > domInit_fromRef
typedef daeSmartRef< domInit_from > domInit_fromRef
typedef daeTArray
< domRenderableRef > 		domRenderable_Array
typedef daeSmartRef
< domRenderable > 		domRenderableRef

Public Member Functions

const domAssetRef getAsset () const
const domAssetRef getAsset () const
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
const domCreate_2dRef getCreate_2d () const
const domCreate_3dRef getCreate_3d () const
const domCreate_cubeRef getCreate_cube () const
const domDataRef getData () const
domUint getDepth () 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 ()
xsToken getFormat () const
domUint getHeight () const
xsID getId () const
xsID getId () const
const domInit_fromRef getInit_from () const
const domInit_fromRef getInit_from () const
xsToken getName () const
xsNCName getName () const
const domRenderableRef getRenderable () const
domSid getSid () const
domUint getWidth () const
void setDepth (domUint atDepth)
void setFormat (xsToken atFormat)
void setHeight (domUint atHeight)
void setId (xsID atId)
void setId (xsID atId)
void setName (xsToken atName)
void setName (xsNCName atName)
void setSid (domSid atSid)
void setWidth (domUint atWidth)
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

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

Protected Attributes

daeTArray< daeCharArray * > _CMData
daeElementRefArray _contents
daeUIntArray _contentsOrder
domUint attrDepth
xsToken attrFormat
domUint attrHeight
xsID attrId
xsToken attrName
xsNCName attrName
domSid attrSid
domUint attrWidth
domAssetRef elemAsset
domCreate_2dRef elemCreate_2d
domCreate_3dRef elemCreate_3d
domCreate_cubeRef elemCreate_cube
domDataRef elemData
domExtra_Array elemExtra_array
domInit_fromRef elemInit_from
domRenderableRef elemRenderable

Detailed Description

The image element declares the storage for the graphical representation of an object. The image element best describes raster image data, but can conceivably handle other forms of imagery. The image elements allows for specifying an external image file with the init_from element or embed image data with the data element.

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

Member Typedef Documentation

typedef daeTArray<domCreate_2dRef> domImage::domCreate_2d_Array

Definition at line 148 of file dom/domImage.h.

typedef daeSmartRef<domCreate_2d> domImage::domCreate_2dRef

Definition at line 145 of file dom/domImage.h.

typedef daeTArray<domCreate_3dRef> domImage::domCreate_3d_Array

Definition at line 849 of file dom/domImage.h.

typedef daeSmartRef<domCreate_3d> domImage::domCreate_3dRef

Definition at line 846 of file dom/domImage.h.

typedef daeTArray<domCreate_cubeRef> domImage::domCreate_cube_Array

Definition at line 1414 of file dom/domImage.h.

typedef daeSmartRef<domCreate_cube> domImage::domCreate_cubeRef

Definition at line 1411 of file dom/domImage.h.

typedef daeTArray<domDataRef> domImage::domData_Array

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

typedef daeSmartRef<domData> domImage::domDataRef

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

typedef daeTArray<domInit_fromRef> domImage::domInit_from_Array

Definition at line 86 of file dom/domImage.h.

typedef daeTArray<domInit_fromRef> domImage::domInit_from_Array

Definition at line 104 of file 1.4/dom/domImage.h.

typedef daeSmartRef<domInit_from> domImage::domInit_fromRef

Definition at line 83 of file dom/domImage.h.

typedef daeSmartRef<domInit_from> domImage::domInit_fromRef

Definition at line 101 of file 1.4/dom/domImage.h.

typedef daeTArray<domRenderableRef> domImage::domRenderable_Array

Definition at line 24 of file dom/domImage.h.

typedef daeSmartRef<domRenderable> domImage::domRenderableRef

Definition at line 21 of file dom/domImage.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 350 of file 1.4/dom/domImage.h.

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

Destructor

Definition at line 354 of file 1.4/dom/domImage.h.

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

Constructor

Definition at line 2105 of file dom/domImage.h.

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

Destructor

Definition at line 2109 of file dom/domImage.h.

Member Function Documentation

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 2054 of file dom/domImage.h.

const domAssetRef domImage::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

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

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

Gets the _contents array.

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

Definition at line 2099 of file dom/domImage.h.

daeElementRefArray& domImage::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 2094 of file dom/domImage.h.

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

Gets the _contents array.

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

Definition at line 344 of file 1.4/dom/domImage.h.

daeElementRefArray& domImage::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 339 of file 1.4/dom/domImage.h.

const domCreate_2dRef domImage::getCreate_2d (  )  const [inline]

Gets the create_2d element.

Returns:
a daeSmartRef to the create_2d element.

Definition at line 2069 of file dom/domImage.h.

const domCreate_3dRef domImage::getCreate_3d (  )  const [inline]

Gets the create_3d element.

Returns:
a daeSmartRef to the create_3d element.

Definition at line 2074 of file dom/domImage.h.

const domCreate_cubeRef domImage::getCreate_cube (  )  const [inline]

Gets the create_cube element.

Returns:
a daeSmartRef to the create_cube element.

Definition at line 2079 of file dom/domImage.h.

const domDataRef domImage::getData (  )  const [inline]

Gets the data element.

Returns:
a daeSmartRef to the data element.

Definition at line 319 of file 1.4/dom/domImage.h.

domUint domImage::getDepth (  )  const [inline]

Gets the depth attribute.

Returns:
Returns a domUint of the depth attribute.

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

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

Reimplemented from daeElement.

Definition at line 17 of file dom/domImage.h.

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

Reimplemented from daeElement.

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

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

Gets the extra element array.

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

Definition at line 2089 of file dom/domImage.h.

domExtra_Array& domImage::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 2084 of file dom/domImage.h.

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

Gets the extra element array.

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

Definition at line 334 of file 1.4/dom/domImage.h.

domExtra_Array& domImage::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 329 of file 1.4/dom/domImage.h.

xsToken domImage::getFormat (  )  const [inline]

Gets the format attribute.

Returns:
Returns a xsToken of the format attribute.

Definition at line 270 of file 1.4/dom/domImage.h.

domUint domImage::getHeight (  )  const [inline]

Gets the height attribute.

Returns:
Returns a domUint of the height attribute.

Definition at line 281 of file 1.4/dom/domImage.h.

xsID domImage::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 2019 of file dom/domImage.h.

xsID domImage::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

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

const domInit_fromRef domImage::getInit_from (  )  const [inline]

Gets the init_from element.

Returns:
a daeSmartRef to the init_from element.

Definition at line 2064 of file dom/domImage.h.

const domInit_fromRef domImage::getInit_from (  )  const [inline]

Gets the init_from element.

Returns:
a daeSmartRef to the init_from element.

Definition at line 324 of file 1.4/dom/domImage.h.

xsToken domImage::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 2043 of file dom/domImage.h.

xsNCName domImage::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 259 of file 1.4/dom/domImage.h.

const domRenderableRef domImage::getRenderable (  )  const [inline]

Gets the renderable element.

Returns:
a daeSmartRef to the renderable element.

Definition at line 2059 of file dom/domImage.h.

domSid domImage::getSid (  )  const [inline]

Gets the sid attribute.

Returns:
Returns a domSid of the sid attribute.

Definition at line 2032 of file dom/domImage.h.

domUint domImage::getWidth (  )  const [inline]

Gets the width attribute.

Returns:
Returns a domUint of the width attribute.

Definition at line 292 of file 1.4/dom/domImage.h.

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

Definition at line 18 of file dom/domImage.h.

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

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

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

Overloaded assignment operator

Definition at line 2113 of file dom/domImage.h.

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

Overloaded assignment operator

Definition at line 358 of file 1.4/dom/domImage.h.

static DLLSPEC daeMetaElement* domImage::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* domImage::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 domImage::setDepth ( domUint  atDepth  )  [inline]

Sets the depth attribute.

Parameters:
atDepth The new value for the depth attribute.

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

void domImage::setFormat ( xsToken  atFormat  )  [inline]

Sets the format attribute.

Parameters:
atFormat The new value for the format attribute.

Definition at line 275 of file 1.4/dom/domImage.h.

void domImage::setHeight ( domUint  atHeight  )  [inline]

Sets the height attribute.

Parameters:
atHeight The new value for the height attribute.

Definition at line 286 of file 1.4/dom/domImage.h.

void domImage::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 2024 of file dom/domImage.h.

void domImage::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 251 of file 1.4/dom/domImage.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 2048 of file dom/domImage.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 264 of file 1.4/dom/domImage.h.

void domImage::setSid ( domSid  atSid  )  [inline]

Sets the sid attribute.

Parameters:
atSid The new value for the sid attribute.

Definition at line 2037 of file dom/domImage.h.

void domImage::setWidth ( domUint  atWidth  )  [inline]

Sets the width attribute.

Parameters:
atWidth The new value for the width attribute.

Definition at line 297 of file 1.4/dom/domImage.h.

virtual daeInt domImage::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 19 of file dom/domImage.h.

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

Member Data Documentation

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

Used to store information needed for some content model objects.

Definition at line 238 of file 1.4/dom/domImage.h.

daeElementRefArray domImage::_contents [protected]

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

Definition at line 229 of file 1.4/dom/domImage.h.

daeUIntArray domImage::_contentsOrder [protected]

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

Definition at line 233 of file 1.4/dom/domImage.h.

domUint domImage::attrDepth [protected]

The depth attribute is an integer value that indicates the depth of the image in pixel units. A 2-D image has a depth of 1, which is also the default value. Optional attribute.

Definition at line 205 of file 1.4/dom/domImage.h.

xsToken domImage::attrFormat [protected]

The format attribute is a text string value that indicates the image format. Optional attribute.

Definition at line 189 of file 1.4/dom/domImage.h.

domUint domImage::attrHeight [protected]

The height attribute is an integer value that indicates the height of the image in pixel units. Optional attribute.

Definition at line 194 of file 1.4/dom/domImage.h.

xsID domImage::attrId [protected]

The id attribute is a text string containing the unique identifier of this element. This value must be unique within the instance document. Optional attribute.

Definition at line 180 of file 1.4/dom/domImage.h.

xsToken domImage::attrName [protected]

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

Definition at line 1967 of file dom/domImage.h.

xsNCName domImage::attrName [protected]

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

Definition at line 184 of file 1.4/dom/domImage.h.

domSid domImage::attrSid [protected]

sub identifier

Definition at line 1963 of file dom/domImage.h.

domUint domImage::attrWidth [protected]

The width attribute is an integer value that indicates the width of the image in pixel units. Optional attribute.

Definition at line 199 of file 1.4/dom/domImage.h.

domAssetRef domImage::elemAsset [protected]

The image element may contain an asset element.

See also:
domAsset

Definition at line 211 of file 1.4/dom/domImage.h.

domCreate_2dRef domImage::elemCreate_2d [protected]

Initialize a custom 2d image

See also:
domCreate_2d

Definition at line 1986 of file dom/domImage.h.

domCreate_3dRef domImage::elemCreate_3d [protected]

Initialize a custom 3d image

See also:
domCreate_3d

Definition at line 1990 of file dom/domImage.h.

domCreate_cubeRef domImage::elemCreate_cube [protected]

Initialize a custom cube image

See also:
domCreate_cube

Definition at line 1994 of file dom/domImage.h.

domDataRef domImage::elemData [protected]

The data child element contains a sequence of hexadecimal encoded binary octets representing the embedded image data.

See also:
domData

Definition at line 216 of file 1.4/dom/domImage.h.

domExtra_Array domImage::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

Definition at line 225 of file 1.4/dom/domImage.h.

domInit_fromRef domImage::elemInit_from [protected]

The init_from element allows you to specify an external image file to use for the image element.

See also:
domInit_from

initialize the whole image structure and data from formats like DDS

See also:
domInit_from

Definition at line 221 of file 1.4/dom/domImage.h.

domRenderableRef domImage::elemRenderable [protected]

This image is renderable if this element is used

See also:
domRenderable

Definition at line 1977 of file dom/domImage.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:24 2013