/*
* Copyright 2006 Sony Computer Entertainment Inc.
*
* Licensed under the MIT Open Source License, for details please see license.txt or the website
* http://www.opensource.org/licenses/mit-license.php
*
*/
#ifndef __domFx_surface_init_cube_common_h__
#define __domFx_surface_init_cube_common_h__
#include <dae/daeDocument.h>
#include <dom/domTypes.h>
#include <dom/domElements.h>
class DAE;
class domFx_surface_init_cube_common_complexType
{
public:
class domAll;
typedef daeSmartRef<domAll> domAllRef;
typedef daeTArray<domAllRef> domAll_Array;
/**
* Init the entire surface with one compound image such as DDS
*/
class domAll : public daeElement
{
public:
virtual COLLADA_TYPE::TypeEnum getElementType() const { return COLLADA_TYPE::ALL; }
static daeInt ID() { return 16; }
virtual daeInt typeID() const { return ID(); }
protected: // Attribute
xsIDREF attrRef;
public: //Accessors and Mutators
/**
* Gets the ref attribute.
* @return Returns a xsIDREF reference of the ref attribute.
*/
xsIDREF &getRef() { return attrRef; }
/**
* Gets the ref attribute.
* @return Returns a constant xsIDREF reference of the ref attribute.
*/
const xsIDREF &getRef() const{ return attrRef; }
/**
* Sets the ref attribute.
* @param atRef The new value for the ref attribute.
*/
void setRef( const xsIDREF &atRef ) { attrRef = atRef; _validAttributeArray[0] = true; }
protected:
/**
* Constructor
*/
domAll(DAE& dae) : daeElement(dae), attrRef(*this) {}
/**
* Destructor
*/
virtual ~domAll() {}
/**
* Overloaded assignment operator
*/
virtual domAll &operator=( const domAll &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @return a daeElementRef referencing an instance of this object.
*/
static DLLSPEC daeElementRef create(DAE& dae);
/**
* 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.
* @return A daeMetaElement describing this COLLADA element.
*/
static DLLSPEC daeMetaElement* registerElement(DAE& dae);
};
class domPrimary;
typedef daeSmartRef<domPrimary> domPrimaryRef;
typedef daeTArray<domPrimaryRef> domPrimary_Array;
/**
* Init all primary mip level 0 subsurfaces with one compound image such as
* DDS. Use of this element expects that the surface has element mip_levels=0
* or mipmap_generate.
*/
class domPrimary : public daeElement
{
public:
virtual COLLADA_TYPE::TypeEnum getElementType() const { return COLLADA_TYPE::PRIMARY; }
static daeInt ID() { return 17; }
virtual daeInt typeID() const { return ID(); }
public:
class domOrder;
typedef daeSmartRef<domOrder> domOrderRef;
typedef daeTArray<domOrderRef> domOrder_Array;
/**
* If the image dues not natively describe the face ordering then this series
* of order elements will describe which face the index belongs too
*/
class domOrder : public daeElement
{
public:
virtual COLLADA_TYPE::TypeEnum getElementType() const { return COLLADA_TYPE::ORDER; }
static daeInt ID() { return 18; }
virtual daeInt typeID() const { return ID(); }
protected: // Value
/**
* The domFx_surface_face_enum value of the text data of this element.
*/
domFx_surface_face_enum _value;
public: //Accessors and Mutators
/**
* Gets the value of this element.
* @return a domFx_surface_face_enum of the value.
*/
domFx_surface_face_enum getValue() const { return _value; }
/**
* Sets the _value of this element.
* @param val The new value for this element.
*/
void setValue( domFx_surface_face_enum val ) { _value = val; }
protected:
/**
* Constructor
*/
domOrder(DAE& dae) : daeElement(dae), _value() {}
/**
* Destructor
*/
virtual ~domOrder() {}
/**
* Overloaded assignment operator
*/
virtual domOrder &operator=( const domOrder &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @return a daeElementRef referencing an instance of this object.
*/
static DLLSPEC daeElementRef create(DAE& dae);
/**
* 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.
* @return A daeMetaElement describing this COLLADA element.
*/
static DLLSPEC daeMetaElement* registerElement(DAE& dae);
};
protected: // Attribute
xsIDREF attrRef;
protected: // Element
/**
* If the image dues not natively describe the face ordering then this series
* of order elements will describe which face the index belongs too @see domOrder
*/
domOrder_Array elemOrder_array;
public: //Accessors and Mutators
/**
* Gets the ref attribute.
* @return Returns a xsIDREF reference of the ref attribute.
*/
xsIDREF &getRef() { return attrRef; }
/**
* Gets the ref attribute.
* @return Returns a constant xsIDREF reference of the ref attribute.
*/
const xsIDREF &getRef() const{ return attrRef; }
/**
* Sets the ref attribute.
* @param atRef The new value for the ref attribute.
*/
void setRef( const xsIDREF &atRef ) { attrRef = atRef; _validAttributeArray[0] = true; }
/**
* Gets the order element array.
* @return Returns a reference to the array of order elements.
*/
domOrder_Array &getOrder_array() { return elemOrder_array; }
/**
* Gets the order element array.
* @return Returns a constant reference to the array of order elements.
*/
const domOrder_Array &getOrder_array() const { return elemOrder_array; }
protected:
/**
* Constructor
*/
domPrimary(DAE& dae) : daeElement(dae), attrRef(*this), elemOrder_array() {}
/**
* Destructor
*/
virtual ~domPrimary() {}
/**
* Overloaded assignment operator
*/
virtual domPrimary &operator=( const domPrimary &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @return a daeElementRef referencing an instance of this object.
*/
static DLLSPEC daeElementRef create(DAE& dae);
/**
* 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.
* @return A daeMetaElement describing this COLLADA element.
*/
static DLLSPEC daeMetaElement* registerElement(DAE& dae);
};
class domFace;
typedef daeSmartRef<domFace> domFaceRef;
typedef daeTArray<domFaceRef> domFace_Array;
/**
* Init each face mipchain with one compound image such as DDS
*/
class domFace : public daeElement
{
public:
virtual COLLADA_TYPE::TypeEnum getElementType() const { return COLLADA_TYPE::FACE; }
static daeInt ID() { return 19; }
virtual daeInt typeID() const { return ID(); }
protected: // Attribute
xsIDREF attrRef;
public: //Accessors and Mutators
/**
* Gets the ref attribute.
* @return Returns a xsIDREF reference of the ref attribute.
*/
xsIDREF &getRef() { return attrRef; }
/**
* Gets the ref attribute.
* @return Returns a constant xsIDREF reference of the ref attribute.
*/
const xsIDREF &getRef() const{ return attrRef; }
/**
* Sets the ref attribute.
* @param atRef The new value for the ref attribute.
*/
void setRef( const xsIDREF &atRef ) { attrRef = atRef; _validAttributeArray[0] = true; }
protected:
/**
* Constructor
*/
domFace(DAE& dae) : daeElement(dae), attrRef(*this) {}
/**
* Destructor
*/
virtual ~domFace() {}
/**
* Overloaded assignment operator
*/
virtual domFace &operator=( const domFace &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @return a daeElementRef referencing an instance of this object.
*/
static DLLSPEC daeElementRef create(DAE& dae);
/**
* 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.
* @return A daeMetaElement describing this COLLADA element.
*/
static DLLSPEC daeMetaElement* registerElement(DAE& dae);
};
protected: // Elements
/**
* Init the entire surface with one compound image such as DDS @see domAll
*/
domAllRef elemAll;
/**
* Init all primary mip level 0 subsurfaces with one compound image such as
* DDS. Use of this element expects that the surface has element mip_levels=0
* or mipmap_generate. @see domPrimary
*/
domPrimaryRef elemPrimary;
/**
* Init each face mipchain with one compound image such as DDS @see domFace
*/
domFace_Array elemFace_array;
/**
* Used to preserve order in elements that do not specify strict sequencing of sub-elements.
*/
daeElementRefArray _contents;
/**
* Used to preserve order in elements that have a complex content model.
*/
daeUIntArray _contentsOrder;
/**
* Used to store information needed for some content model objects.
*/
daeTArray< daeCharArray * > _CMData;
public: //Accessors and Mutators
/**
* Gets the all element.
* @return a daeSmartRef to the all element.
*/
const domAllRef getAll() const { return elemAll; }
/**
* Gets the primary element.
* @return a daeSmartRef to the primary element.
*/
const domPrimaryRef getPrimary() const { return elemPrimary; }
/**
* Gets the face element array.
* @return Returns a reference to the array of face elements.
*/
domFace_Array &getFace_array() { return elemFace_array; }
/**
* Gets the face element array.
* @return Returns a constant reference to the array of face elements.
*/
const domFace_Array &getFace_array() const { return elemFace_array; }
/**
* Gets the _contents array.
* @return Returns a reference to the _contents element array.
*/
daeElementRefArray &getContents() { return _contents; }
/**
* Gets the _contents array.
* @return Returns a constant reference to the _contents element array.
*/
const daeElementRefArray &getContents() const { return _contents; }
protected:
/**
* Constructor
*/
domFx_surface_init_cube_common_complexType(DAE& dae, daeElement* elt) : elemAll(), elemPrimary(), elemFace_array() {}
/**
* Destructor
*/
virtual ~domFx_surface_init_cube_common_complexType() { daeElement::deleteCMDataArray(_CMData); }
/**
* Overloaded assignment operator
*/
virtual domFx_surface_init_cube_common_complexType &operator=( const domFx_surface_init_cube_common_complexType &cpy ) { (void)cpy; return *this; }
};
/**
* An element of type domFx_surface_init_cube_common_complexType.
*/
class domFx_surface_init_cube_common : public daeElement, public domFx_surface_init_cube_common_complexType
{
public:
virtual COLLADA_TYPE::TypeEnum getElementType() const { return COLLADA_TYPE::FX_SURFACE_INIT_CUBE_COMMON; }
static daeInt ID() { return 20; }
virtual daeInt typeID() const { return ID(); }
protected:
/**
* Constructor
*/
domFx_surface_init_cube_common(DAE& dae) : daeElement(dae), domFx_surface_init_cube_common_complexType(dae, this) {}
/**
* Destructor
*/
virtual ~domFx_surface_init_cube_common() {}
/**
* Overloaded assignment operator
*/
virtual domFx_surface_init_cube_common &operator=( const domFx_surface_init_cube_common &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @return a daeElementRef referencing an instance of this object.
*/
static DLLSPEC daeElementRef create(DAE& dae);
/**
* 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.
* @return A daeMetaElement describing this COLLADA element.
*/
static DLLSPEC daeMetaElement* registerElement(DAE& dae);
};
#endif