domFx_surface_init_common Class Reference

#include <domFx_surface_init_common.h>

Inheritance diagram for domFx_surface_init_common:

Classes
class	domInit_as_null
class	domInit_as_target
Public Types
typedef daeTArray < domInit_as_nullRef >	domInit_as_null_Array
typedef daeSmartRef < domInit_as_null >	domInit_as_nullRef
typedef daeTArray < domInit_as_targetRef >	domInit_as_target_Array
typedef daeSmartRef < domInit_as_target >	domInit_as_targetRef
Public Member Functions
const daeElementRefArray &	getContents () const
daeElementRefArray &	getContents ()
virtual COLLADA_TYPE::TypeEnum	getElementType () const
const domInit_as_nullRef	getInit_as_null () const
const domInit_as_targetRef	getInit_as_target () const
const domFx_surface_init_cube_commonRef	getInit_cube () const
const domFx_surface_init_from_common_Array &	getInit_from_array () const
domFx_surface_init_from_common_Array &	getInit_from_array ()
const domFx_surface_init_planar_commonRef	getInit_planar () const
const domFx_surface_init_volume_commonRef	getInit_volume () const
virtual daeInt	typeID () const
Static Public Member Functions
static DLLSPEC daeElementRef	create (DAE &dae)
static daeInt	ID ()
static DLLSPEC daeMetaElement *	registerElement (DAE &dae)
Protected Member Functions
	domFx_surface_init_common (DAE &dae)
virtual domFx_surface_init_common &	operator= (const domFx_surface_init_common &cpy)
virtual	~domFx_surface_init_common ()
Protected Attributes
daeTArray< daeCharArray * >	_CMData
daeElementRefArray	_contents
daeUIntArray	_contentsOrder
domInit_as_nullRef	elemInit_as_null
domInit_as_targetRef	elemInit_as_target
domFx_surface_init_cube_commonRef	elemInit_cube
domFx_surface_init_from_common_Array	elemInit_from_array
domFx_surface_init_planar_commonRef	elemInit_planar
domFx_surface_init_volume_commonRef	elemInit_volume

Detailed Description

The common set of initalization options for surfaces. Choose which is appropriate for your surface based on type and other characteristics. described by the annotation docs on the child elements.

Definition at line 27 of file domFx_surface_init_common.h.

Member Typedef Documentation

typedef daeTArray<domInit_as_nullRef> domFx_surface_init_common::domInit_as_null_Array

Definition at line 37 of file domFx_surface_init_common.h.

typedef daeSmartRef<domInit_as_null> domFx_surface_init_common::domInit_as_nullRef

Definition at line 34 of file domFx_surface_init_common.h.

typedef daeTArray<domInit_as_targetRef> domFx_surface_init_common::domInit_as_target_Array

Definition at line 84 of file domFx_surface_init_common.h.

typedef daeSmartRef<domInit_as_target> domFx_surface_init_common::domInit_as_targetRef

Definition at line 81 of file domFx_surface_init_common.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 229 of file domFx_surface_init_common.h.

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

Destructor

Definition at line 233 of file domFx_surface_init_common.h.

Member Function Documentation

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

Gets the _contents array.

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

Definition at line 223 of file domFx_surface_init_common.h.

daeElementRefArray& domFx_surface_init_common::getContents ( ) [inline]

Gets the _contents array.

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

Definition at line 218 of file domFx_surface_init_common.h.

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

Reimplemented from daeElement.

Definition at line 30 of file domFx_surface_init_common.h.

const domInit_as_nullRef domFx_surface_init_common::getInit_as_null ( ) const [inline]

Gets the init_as_null element.

Returns:: a daeSmartRef to the init_as_null element.

Definition at line 183 of file domFx_surface_init_common.h.

const domInit_as_targetRef domFx_surface_init_common::getInit_as_target ( ) const [inline]

Gets the init_as_target element.

Returns:: a daeSmartRef to the init_as_target element.

Definition at line 188 of file domFx_surface_init_common.h.

const domFx_surface_init_cube_commonRef domFx_surface_init_common::getInit_cube ( ) const [inline]

Gets the init_cube element.

Returns:: a daeSmartRef to the init_cube element.

Definition at line 193 of file domFx_surface_init_common.h.

const domFx_surface_init_from_common_Array& domFx_surface_init_common::getInit_from_array ( ) const [inline]

Gets the init_from element array.

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

Definition at line 213 of file domFx_surface_init_common.h.

domFx_surface_init_from_common_Array& domFx_surface_init_common::getInit_from_array ( ) [inline]

Gets the init_from element array.

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

Definition at line 208 of file domFx_surface_init_common.h.

const domFx_surface_init_planar_commonRef domFx_surface_init_common::getInit_planar ( ) const [inline]

Gets the init_planar element.

Returns:: a daeSmartRef to the init_planar element.

Definition at line 203 of file domFx_surface_init_common.h.

const domFx_surface_init_volume_commonRef domFx_surface_init_common::getInit_volume ( ) const [inline]

Gets the init_volume element.

Returns:: a daeSmartRef to the init_volume element.

Definition at line 198 of file domFx_surface_init_common.h.

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

Definition at line 31 of file domFx_surface_init_common.h.

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

Overloaded assignment operator

Definition at line 237 of file domFx_surface_init_common.h.

static DLLSPEC daeMetaElement* domFx_surface_init_common::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.

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

Member Data Documentation

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

Used to store information needed for some content model objects.

Definition at line 175 of file domFx_surface_init_common.h.

daeElementRefArray domFx_surface_init_common::_contents [protected]

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

Definition at line 166 of file domFx_surface_init_common.h.

daeUIntArray domFx_surface_init_common::_contentsOrder [protected]

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

Definition at line 170 of file domFx_surface_init_common.h.

domInit_as_nullRef domFx_surface_init_common::elemInit_as_null [protected]

This surface is intended to be initialized later externally by a "setparam" element. If it is used before being initialized there is profile and platform specific behavior. Most elements on the surface element containing this will be ignored including mip_levels, mipmap_generate, size, viewport_ratio, and format.

See also:: domInit_as_null

Definition at line 135 of file domFx_surface_init_common.h.

domInit_as_targetRef domFx_surface_init_common::elemInit_as_target [protected]

Init as a target for depth, stencil, or color. It does not need image data. Surface should not have mipmap_generate when using this.

See also:: domInit_as_target

Definition at line 140 of file domFx_surface_init_common.h.

domFx_surface_init_cube_commonRef domFx_surface_init_common::elemInit_cube [protected]

Init a CUBE from a compound image such as DDS

See also:: domInit_cube

Definition at line 144 of file domFx_surface_init_common.h.

domFx_surface_init_from_common_Array domFx_surface_init_common::elemInit_from_array [protected]

Initialize the surface one sub-surface at a time by specifying combinations of mip, face, and slice which make sense for a particular surface type. Each sub-surface is initialized by a common 2D image, not a complex compound image such as DDS. If not all subsurfaces are initialized, it is invalid and will result in profile and platform specific behavior unless mipmap_generate is responsible for initializing the remainder of the sub-surfaces