COLLADA 1.4 DOM: domImage Class Reference

COLLADA

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

domImage Class Reference

#include <domImage.h>

Inheritance diagram for domImage:

Inheritance graph
[legend]
Collaboration diagram for domImage:

Collaboration graph
[legend]
List of all members.

Detailed Description

Images embody the graphical representation of a scene or object.

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 element may contain a sequence of hexadecimal, binary octets representing the embedded image data. These values are interpreted at pixel values according to the format attribute.

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 & getSource ()
 Gets the source attribute.
const xsAnyURI & getSource () const
 Gets the source attribute.
void setSource (const xsAnyURI &atSource)
 Sets the source attribute.
xsString getFormat () const
 Gets the format attribute.
void setFormat (xsString atFormat)
 Sets the format attribute.
xsNonNegativeInteger getHeight () const
 Gets the height attribute.
void setHeight (xsNonNegativeInteger atHeight)
 Sets the height attribute.
xsNonNegativeInteger getWidth () const
 Gets the width attribute.
void setWidth (xsNonNegativeInteger atWidth)
 Sets the width attribute.
xsNonNegativeInteger getDepth () const
 Gets the depth attribute.
void setDepth (xsNonNegativeInteger atDepth)
 Sets the depth attribute.
domListOfHexBinary & getValue ()
 Gets the _value array.
const domListOfHexBinary & getValue () const
 Gets the _value array.
void setValue (const domListOfHexBinary &val)
 Sets the _value 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the image element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsAnyURI attrSource
 The source attribute is a valid URL of the image source data.
xsString attrFormat
 The format attribute is a text string value that indicates the image format.
xsNonNegativeInteger attrHeight
 The height attribute is an integer value that indicates the height of the image in pixel units.
xsNonNegativeInteger attrWidth
 The width attribute is an integer value that indicates the width of the image in pixel units.
xsNonNegativeInteger attrDepth
 The depth attribute is an integer value that indicates the depth of the image in pixel units.
domListOfHexBinary _value
 The domListOfHexBinary value of the text data of this element.

Member Function Documentation

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

xsNonNegativeInteger domImage::getDepth (   )  const [inline]
 

Gets the depth attribute.

Returns:
Returns a xsNonNegativeInteger of the depth attribute.

xsString domImage::getFormat (   )  const [inline]
 

Gets the format attribute.

Returns:
Returns a xsString of the format attribute.

xsNonNegativeInteger domImage::getHeight (   )  const [inline]
 

Gets the height attribute.

Returns:
Returns a xsNonNegativeInteger of the height attribute.

xsID domImage::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domImage::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const xsAnyURI& domImage::getSource (   )  const [inline]
 

Gets the source attribute.

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

xsAnyURI& domImage::getSource (   )  [inline]
 

Gets the source attribute.

Returns:
Returns a xsAnyURI reference of the source attribute.

const domListOfHexBinary& domImage::getValue (   )  const [inline]
 

Gets the _value array.

Returns:
Returns a constant domListOfHexBinary reference of the _value array.

domListOfHexBinary& domImage::getValue (   )  [inline]
 

Gets the _value array.

Returns:
Returns a domListOfHexBinary reference of the _value array.

xsNonNegativeInteger domImage::getWidth (   )  const [inline]
 

Gets the width attribute.

Returns:
Returns a xsNonNegativeInteger of the width attribute.

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

Sets the depth attribute.

Parameters:
atDepth The new value for the depth attribute.

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

Sets the format attribute.

Parameters:
atFormat The new value for the format attribute.

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

Sets the height attribute.

Parameters:
atHeight The new value for the height attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domImage::setSource (  const xsAnyURI &  atSource  )  [inline]
 

Sets the source attribute.

Parameters:
atSource The new value for the source attribute.

void domImage::setValue (  const domListOfHexBinary &  val  )  [inline]
 

Sets the _value array.

Parameters:
atDepth The new value for the _value array.

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

Sets the width attribute.

Parameters:
atWidth The new value for the width attribute.

Member Data Documentation

xsNonNegativeInteger 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.

xsString domImage::attrFormat [protected]
 

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

Optional attribute.

xsNonNegativeInteger domImage::attrHeight [protected]
 

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

Optional attribute.

xsID domImage::attrId [protected]
 

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

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

xsNCName domImage::attrName [protected]
 

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

Optional attribute.

xsAnyURI domImage::attrSource [protected]
 

The source attribute is a valid URL of the image source data.

If this attribute is present, then it refers to an image asset that may contain information about the dimensions and format of the image. Optional attribute.

xsNonNegativeInteger domImage::attrWidth [protected]
 

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

Optional attribute.

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

previous page start next page