Engine directory for ticket #1

Engine/lib/collada/include/dae/daeDocument.h

@@ -0,0 +1,153 @@
+/*
+ * 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 __DAE_DOCUMENT__
+#define __DAE_DOCUMENT__
+
+#include <dae/daeTypes.h>
+#include <dae/daeElement.h>
+#include <dae/daeURI.h>
+#include <dae/daeStringRef.h>
+
+class DAE;
+class daeDatabase;
+
+/**
+ * The @c daeDocument class implements a COLLADA runtime database entry.
+ */
+class DLLSPEC daeDocument
+{
+public:
+	/**
+	 * Constructor
+	 * @param dae The dae that owns this document. 
+	 */
+	daeDocument(DAE& dae);
+
+	/**
+	 * Destructor
+	 */
+	~daeDocument();
+
+	/**
+	* Accessor to get the @c domCollada associated with this document.
+	* @return A @c daeElementRef for the @c domCollada that is the root of this document.
+	* @note This function should really return a domColladaRef,
+	* but we're trying to avoid having @c dae classes depend on generated dom classes.
+	*/
+	daeElement* getDomRoot() const {return(dom);}
+	/**
+	* Accessor to set the domCollada associated with this document
+	* @param domRoot the domCollada that is the root of this document
+	* @remarks Should really require a domColladaRef but we're trying to avoid having dae classes depend on generated dom classes.
+	*/
+	void setDomRoot(daeElement* domRoot) {dom = domRoot; domRoot->setDocument(this); }
+	/**
+	* Accessor to get the URI associated with the document in this document; 
+	* this is currently set to the URI from which the document was loaded, but
+	* is blank if the document was created with @c insertDocument().
+	* @return Returns a pointer to the URI for this document.
+	* @note This is the full URI of the document and not the document base URI.
+	*/
+	daeURI* getDocumentURI() {return (&uri);}
+
+	/**
+	* Const accessor to get the URI associated with the document in this collection; 
+	* this is currently set to the URI from which the collection was loaded, but
+	* is blank if the collection was created with @c insertCollection().
+	* @return Returns a pointer to the URI for this collection.
+	* @note This is the full URI of the document and not the document base URI.
+	*/
+	const daeURI* getDocumentURI() const {return (&uri);}
+
+	/**
+	 * Accessor to get the DAE that owns this document.
+	 * @return Returns the DAE that owns this document.
+	 */
+	DAE* getDAE();
+
+	/**
+	 * Accessor to get the database associated with this document.
+	 * @return Returns the database associated with this document.
+	 */
+	daeDatabase* getDatabase();
+
+	/**
+	 * This function is used to track how a document gets modified. It gets called internally.
+	 * @param element The element that was added to this document.
+	 * @note This function is called internally and not meant to be called by the client application.
+	 * Calling this function from the client application may result in unexpected behavior.
+	 */
+	void insertElement( daeElementRef element );
+	/**
+	 * This function is used to track how a document gets modified. It gets called internally.
+	 * @param element The element that was removed from this document.
+	 * @note This function is called internally and not meant to be called by the client application.
+	 * Calling this function from the client application may result in unexpected behavior.
+	 */
+	void removeElement( daeElementRef element );
+	/**
+	 * This function is used to track how a document gets modified. It gets called internally.
+	 * @param element The element whose ID is about to be changed.
+	 * @param newID The ID that is going to be assigned to the element.
+	 * @note This function is called internally and not meant to be called by the client application.
+	 * Calling this function from the client application may result in unexpected behavior.
+	 */
+	void changeElementID( daeElementRef element, daeString newID );
+	/**
+	 * This function is just like changeElementID, except it keeps track of sids instead of IDs.
+	 * @param element The element whose sid is about to be changed.
+	 * @param newSID The sid that is going to be assigned to the element.
+	 * @note This function is called internally and not meant to be called by the client application.
+	 * Calling this function from the client application may result in unexpected behavior.
+	 */
+	void changeElementSID( daeElementRef element, daeString newSID );
+	/**
+	 * Adds a URI to the list of external references in this document.
+	 * @param uri The URI that is the external reference.
+	 * @note This function gets called internally from daeURI upon trying to resolve an element.
+	 * Calling this function in your client code my result in unexpected behavior.
+	 */
+	void addExternalReference( daeURI &uri );
+   /**
+	 * Gets a list of all the documents that are referenced from URI contained within this document.
+	 * @return Returns a list of URI strings, each being a URI which is referenced from within this document.
+	 */
+	const daeStringRefArray &getReferencedDocuments() const { return referencedDocuments; }
+
+private:
+	/**
+	 * The DAE that owns this document. The DAE's database is notified by the document when
+	 * elements are inserted, removed, or have their ID changed.
+	 */
+	DAE* dae;
+
+	/**
+	 * Top Level element for of the document, always a domCollada
+	 * @remarks This member will eventually be taken private, use getDomRoot() to access it.
+	 */
+	daeElementRef dom;
+	
+	/** 
+	 * The URI of the document, may be blank if the document wasn't loaded from a URI
+	 * @remarks This member will eventually be taken private, use getDocumentURI() to access it.
+	 */
+	daeURI uri;
+
+   daeStringRefArray referencedDocuments;
+};
+
+typedef daeDocument daeCollection;
+
+#endif
+