COLLADA 1.4 DOM: daeIntegrationObject Class Reference

COLLADA

previous page next page
Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages

daeIntegrationObject Class Reference

#include <daeIntegrationObject.h>

Inheritance diagram for daeIntegrationObject:

Inheritance graph
[legend]
Collaboration diagram for daeIntegrationObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

The daeIntegrationObject class provides methods to translate COLLADA objects to and from application objects.

Public Member Functions

 daeIntegrationObject ()
 Constructor.
virtual ~daeIntegrationObject ()
 Destructor.
void setElement (daeElementRef element)
 Sets the element associated with this integration object.
daeElementRef getElement ()
 Gets the element associated with this integration object.
void setObject (void *object)
 Sets the user object associated with this integration object.
void * getObject ()
 Gets the user object associated with this integration object.
virtual daeElementRef lookupElement (daeString s)
virtual daeIntegrationObjectRef lookup (daeString s)
void createFromChecked (daeElementRef element)
 Defines the code to create the application-specific data structure associated with the DOM class for this integration template.
void fromCOLLADAChecked ()
 Defines the code to convert the COLLADA Object Model data structure into your application-specific data structure.
void fromCOLLADAPostProcessChecked ()
 Defines any postprocessing code that must execute after the basic conversion.
void createToChecked (void *userData)
 Defines code to create the COLLADA Object Model data structure associated with the DOM class for this template.
void toCOLLADAChecked ()
 Defines the code to convert your application's data structures back into COLLADA Object Model data structures.
void toCOLLADAPostProcessChecked ()
 Defines any postprocessing code that must execute after the basic conversion.

Public Attributes

daeElementRef _element
 A smartRef to the element associated with this integration object.
void * _object
 A pointer at which to store the user object associated with this element.
IntegrationState _from_state
 An enum describing the state of the conversion from COLLADA.
IntegrationState _to_state
 An enum describing the state of the conversion to COLLADA.

Protected Member Functions

virtual void createFrom (daeElementRef element)=0
 Defines the code to create the application-specific data structure associated with the DOM class for this integration template.
virtual void fromCOLLADA ()=0
 Defines the code to convert the COLLADA Object Model data structure into your application-specific data structure.
virtual void fromCOLLADAPostProcess ()=0
 Defines any postprocessing code that must execute after the basic conversion.
virtual void createTo (void *userData)=0
 Defines code to create the COLLADA Object Model data structure associated with the DOM class for this template.
virtual void toCOLLADA ()=0
 Defines the code to convert your application's data structures back into COLLADA Object Model data structures.
virtual void toCOLLADAPostProcess ()=0
 Defines any postprocessing code that must execute after the basic conversion.

Member Function Documentation

virtual void daeIntegrationObject::createFrom (  daeElementRef  element  )  [protected, pure virtual]
 

Defines the code to create the application-specific data structure associated with the DOM class for this integration template.

This method sets up the integration object for the DOM class.

Parameters:
element A daeSmartRef to the element to convert into the user's structure.

void daeIntegrationObject::createFromChecked (  daeElementRef  element  )  [inline]
 

Defines the code to create the application-specific data structure associated with the DOM class for this integration template.

This method sets up the integration object for the DOM class. This method checks and updates the conversion state stored in _from_state and converts only if necessary.

Parameters:
element A daeSmartRef to the element to convert into the user's structure.

virtual void daeIntegrationObject::createTo (  void *  userData  )  [protected, pure virtual]
 

Defines code to create the COLLADA Object Model data structure associated with the DOM class for this template.

Parameters:
userData A pointer to the application-specific data structure to convert to the DOM structure.

void daeIntegrationObject::createToChecked (  void *  userData  )  [inline]
 

Defines code to create the COLLADA Object Model data structure associated with the DOM class for this template.

This method checks and updates the conversion state stored in _to_state and converts only if necessary.

Parameters:
userData A pointer to the application-specific data structure to convert to the DOM structure.

void daeIntegrationObject::fromCOLLADAChecked (   )  [inline]
 

Defines the code to convert the COLLADA Object Model data structure into your application-specific data structure.

This method checks and updates the conversion state stored in _from_state and converts only if necessary.

void daeIntegrationObject::fromCOLLADAPostProcessChecked (   )  [inline]
 

Defines any postprocessing code that must execute after the basic conversion.

This method checks and updates the conversion state stored in _from_state and converts only if necessary.

daeElementRef daeIntegrationObject::getElement (   )  [inline]
 

Gets the element associated with this integration object.

Returns:
The element associated with this integration object.

void* daeIntegrationObject::getObject (   )  [inline]
 

Gets the user object associated with this integration object.

Returns:
The user object associated with this integration object.

void daeIntegrationObject::setElement (  daeElementRef  element  )  [inline]
 

Sets the element associated with this integration object.

Parameters:
element A daeSmartRef to the element for this integration object.

void daeIntegrationObject::setObject (  void *  object  )  [inline]
 

Sets the user object associated with this integration object.

Parameters:
object A void * to the user object to be associated with this integration object.

void daeIntegrationObject::toCOLLADAChecked (   )  [inline]
 

Defines the code to convert your application's data structures back into COLLADA Object Model data structures.

This method checks and updates the conversion state stored in _to_state and converts only if necessary.

void daeIntegrationObject::toCOLLADAPostProcessChecked (   )  [inline]
 

Defines any postprocessing code that must execute after the basic conversion.

This method checks and updates the conversion state stored in _to_state and converts only if necessary.

The documentation for this class was generated from the following file:
  • C:/SVN_wf/COLLADA_DOM/include/dae/daeIntegrationObject.h
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:47:00 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page