daeDocument Class Reference

#include <daeDocument.h>

Public Member Functions
void	changeElementID (daeElementRef element, daeString newID)
void	changeElementSID (daeElementRef element, daeString newSID)
	daeDocument (DAE &dae, bool zaeRootDocument=false, const std::string &extractedFileURI="")
DAE *	getDAE ()
daeDatabase *	getDatabase ()
const daeURI *	getDocumentURI () const
daeURI *	getDocumentURI ()
daeElement *	getDomRoot () const
const daeURI &	getExtractedFileURI ()
void	insertElement (daeElementRef element)
bool	isZAERootDocument ()
void	removeElement (daeElementRef element)
void	setDomRoot (daeElement *domRoot)
	~daeDocument ()
Private Attributes
DAE *	dae
daeElementRef	dom
daeURI	mExtractedFileURI
bool	mZAERootDocument
daeURI	uri

Detailed Description

The daeDocument class implements a COLLADA runtime database entry.

Definition at line 23 of file daeDocument.h.

Constructor & Destructor Documentation

daeDocument::daeDocument	(	DAE &	dae,
		bool	zaeRootDocument = `false`,
		const std::string &	extractedFileURI = `""`
	)

Constructor

Parameters:

	dae	The dae that owns this document.
	zaeRootDocument	Indicates if the new document is the root document of a ZAE archive.
	extractedFileURI	URI to extracted dae file.

daeDocument::~daeDocument ( )

Destructor

Member Function Documentation

void daeDocument::changeElementID	(	daeElementRef	element,
		daeString	newID
	)

This function is used to track how a document gets modified. It gets called internally.

Parameters:

	element	The element whose ID is about to be changed.
	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 daeDocument::changeElementSID	(	daeElementRef	element,
		daeString	newSID
	)

This function is just like changeElementID, except it keeps track of sids instead of IDs.

Parameters:

	element	The element whose sid is about to be changed.
	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.

DAE* daeDocument::getDAE ( )

Accessor to get the DAE that owns this document.

Returns:: Returns the DAE that owns this document.

daeDatabase* daeDocument::getDatabase ( )

Accessor to get the database associated with this document.

Returns:: Returns the database associated with this document.

const daeURI* daeDocument::getDocumentURI ( ) const [inline]

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 insertCollection().

Returns:: Returns a pointer to the URI for this collection.

Note:: This is the full URI of the document and not the document base URI.

Definition at line 68 of file daeDocument.h.

daeURI* daeDocument::getDocumentURI ( ) [inline]

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 insertDocument().

Returns:: Returns a pointer to the URI for this document.

Note:: This is the full URI of the document and not the document base URI.

Definition at line 59 of file daeDocument.h.

daeElement* daeDocument::getDomRoot ( ) const [inline]

Accessor to get the domCollada associated with this document.

Returns:: A daeElementRef for the domCollada that is the root of this document.

Note:: This function should really return a domColladaRef, but we're trying to avoid having dae classes depend on generated dom classes.

Definition at line 45 of file daeDocument.h.

const daeURI& daeDocument::getExtractedFileURI ( ) [inline]

If this document is the root of a ZAE archive, this method can be used to get the extracted file. Return value is only valid if isZAERootDocument() returns true.

Note:: This function is called internally and not meant to be called by the client application.

Definition at line 127 of file daeDocument.h.

void daeDocument::insertElement ( daeElementRef element )

This function is used to track how a document gets modified. It gets called internally.

Parameters:

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.

bool daeDocument::isZAERootDocument ( ) [inline]

Returns true if this document is the root of a ZAE archive. In that case getExtractedFileURI() can be used to parse this document and for URI resolving.

Note:: This function is called internally and not meant to be called by the client application.

Definition at line 119 of file daeDocument.h.

void daeDocument::removeElement ( daeElementRef element )

This function is used to track how a document gets modified. It gets called internally.

Parameters:

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 daeDocument::setDomRoot ( daeElement * domRoot ) [inline]

Accessor to set the domCollada associated with this document

Parameters:

domRoot

the domCollada that is the root of this document