Files
bullet3/Extras/COLLADA_DOM/include/1.4/dom/domExtra.h

149 lines
4.3 KiB
C++

/*
* Copyright 2006 Sony Computer Entertainment Inc.
*
* Licensed under the SCEA Shared Source License, Version 1.0 (the "License"); you may not use this
* file except in compliance with the License. You may obtain a copy of the License at:
* http://research.scea.com/scea_shared_source_license.html
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing permissions and limitations under the
* License.
*/
#ifndef __domExtra_h__
#define __domExtra_h__
#include <dom/domTypes.h>
#include <dom/domElements.h>
#include <dom/domAsset.h>
#include <dom/domTechnique.h>
/**
* The extra element declares additional information regarding its parent
* element.
*/
class domExtra : public daeElement
{
protected: // Attributes
/**
* 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.
*/
xsID attrId;
/**
* The name attribute is the text string name of this element. Optional attribute.
*/
xsNCName attrName;
/**
* The type attribute indicates the type of the value data. This text string
* must be understood by the application. Optional attribute.
*/
xsNMTOKEN attrType;
protected: // Elements
/**
* The extra element may contain an asset element. @see domAsset
*/
domAssetRef elemAsset;
/**
* This element must contain at least one non-common profile technique.
* @see domTechnique
*/
domTechnique_Array elemTechnique_array;
public: //Accessors and Mutators
/**
* Gets the id attribute.
* @return Returns a xsID of the id attribute.
*/
xsID getId() const { return attrId; }
/**
* Sets the id attribute.
* @param atId The new value for the id attribute.
*/
void setId( xsID atId ) { *(daeStringRef*)&attrId = atId;
_validAttributeArray[0] = true; }
/**
* Gets the name attribute.
* @return Returns a xsNCName of the name attribute.
*/
xsNCName getName() const { return attrName; }
/**
* Sets the name attribute.
* @param atName The new value for the name attribute.
*/
void setName( xsNCName atName ) { *(daeStringRef*)&attrName = atName;
_validAttributeArray[1] = true; }
/**
* Gets the type attribute.
* @return Returns a xsNMTOKEN of the type attribute.
*/
xsNMTOKEN getType() const { return attrType; }
/**
* Sets the type attribute.
* @param atType The new value for the type attribute.
*/
void setType( xsNMTOKEN atType ) { *(daeStringRef*)&attrType = atType;
_validAttributeArray[2] = true; }
/**
* Gets the asset element.
* @return a daeSmartRef to the asset element.
*/
const domAssetRef getAsset() const { return elemAsset; }
/**
* Gets the technique element array.
* @return Returns a reference to the array of technique elements.
*/
domTechnique_Array &getTechnique_array() { return elemTechnique_array; }
/**
* Gets the technique element array.
* @return Returns a constant reference to the array of technique elements.
*/
const domTechnique_Array &getTechnique_array() const { return elemTechnique_array; }
protected:
/**
* Constructor
*/
domExtra() : attrId(), attrName(), attrType(), elemAsset(), elemTechnique_array() {}
/**
* Destructor
*/
virtual ~domExtra() {}
/**
* Copy Constructor
*/
domExtra( const domExtra &cpy ) : daeElement() { (void)cpy; }
/**
* Overloaded assignment operator
*/
virtual domExtra &operator=( const domExtra &cpy ) { (void)cpy; return *this; }
public: // STATIC METHODS
/**
* Creates an instance of this class and returns a daeElementRef referencing it.
* @param bytes The size allocated for this instance.
* @return a daeElementRef referencing an instance of this object.
*/
static daeElementRef create(daeInt bytes);
/**
* 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 daeMetaElement* registerElement();
public: // STATIC MEMBERS
/**
* The daeMetaElement that describes this element in the meta object reflection framework.
*/
static daeMetaElement* _Meta;
};
#endif