CdotXSITemplate Class Reference

Class representing the base class for all template types in Softimage. More...

#include <dotXSITemplate.h>

Inheritance diagram for CdotXSITemplate:

CSIBCNode List of all members.

Public Member Functions
  CdotXSITemplate ()
  CdotXSITemplate (CSIBCString *i_sName)
  CdotXSITemplate (CSIBCString i_sName, DOTXSIREADCALLBACK i_ReadCallback, DOTXSIWRITECALLBACK i_WriteCallback, SI_Int i_lVersionMajor, SI_Int i_lVersionMinor, SI_Int i_nNbParams, CdotXSIParam *i_Param1,...)
  CdotXSITemplate (CSIBCString i_sName, DOTXSIREADCALLBACK i_ReadCallback, DOTXSIWRITECALLBACK i_WriteCallback, SI_Int i_nNbParams, CdotXSIParam *i_Param1,...)
virtual  ~CdotXSITemplate ()
virtual SI_Void  SetInstanceName (CSIBCString i_sInstanceName)
CSIBCString &  InstanceName ()
SI_Void  SetUserDataType (CSIBCString i_sUserDataType)
CSIBCString &  UserDataType ()
CdotXSITemplates &  Children ()
SI_Void  SetParent (CdotXSITemplate *i_Parent)
SI_Void  Reparent (CdotXSITemplate *i_Parent)
CdotXSITemplate *  Parent ()
SI_Void  SetSystemFlags (SI_Int i_nSystemFlags)
SI_Void  GetSystemFlags (SI_Int *o_nSystemFlags)
SI_Void  SetUserFlags (SI_Int i_nUserFlags)
SI_Void  GetUserFlags (SI_Int *o_nUserFlags)
CdotXSIParams &  Params ()
virtual SI_Void  InitializeFromName (SI_Char *i_pChar, CXSIParser *in_pParser)
CdotXSITemplates *  ChildrenOfType (CSIBCString in_type)
CdotXSITemplate *  ChildrenOfTypeNamed (CSIBCString in_type, CSIBCString in_name)
eCOLLADATemplateType  GetTemplateType ()
SI_Void  SetTemplateType (eCOLLADATemplateType in_etype)

Public Attributes
DOTXSIREADCALLBACK  m_ReadCallback
  Callback function for reading the template.
DOTXSIWRITECALLBACK  m_WriteCallback
  Callback function for writing the template.
DOTXSIWRITECALLBACK  m_WritePostCallback
  Callback function for writing the end of the template (not used by dotXSI).

Detailed Description

Class representing the base class for all template types in Softimage.

All scene information in Softimage (excluding sources, such as image or audio files) is stored within templates. These templates contain parameters that define what type the template is, and given the type, what object/property the template represents in terms of the scene. This is the base class representing all templates used in Softimage.

This class is distinct from the CSLTemplate class. That class, as its name indicates, is the template representation used in the Semantic Layer library, whereas this class represents the native Softimage template.

Also unlike the CSLTemplate class, this class is concrete, meaning that it can be instantiated. This is not generally done however. Generally, CdotXSITemplate objects are only allocated within methods of the Semantic Layer.

Constructor & Destructor Documentation

CdotXSITemplate (  ) 

Default constructor. Sets the default version information, and the default read and write callbacks for the template.

Returns:
an instance of CdotXSITemplate

CdotXSITemplate ( CSIBCString *  i_sName  ) 

Constructor. Sets the type name of the template to the name give by i_sName.

Parameters:
i_sName  Type name of the new template.
Returns:
an instance of CdotXSITemplate

CdotXSITemplate ( CSIBCString  i_sName,
DOTXSIREADCALLBACK  i_ReadCallback,
DOTXSIWRITECALLBACK  i_WriteCallback,
SI_Int  i_lVersionMajor,
SI_Int  i_lVersionMinor,
SI_Int  i_nNbParams,
CdotXSIParam *  i_Param1,
  ...  
)

Constructor. Sets the type name, read and write callbacks, version information, as well as a variable number of CdotXSIParam parameter definitions to add to the new template.

Parameters:
i_sName  Type name of the new template.
i_ReadCallback  Pointer to the read callback function used to read this template.
i_WriteCallback  Pointer to the write callback function used to write this template.
i_lVersionMajor  Major version number used for this template.
i_lVersionMinor  Minor version number used for this template.
i_nNbParams  Number of variable CdotXSIParam arguments to follow.
i_Param1  First parameter definition (if i_nNbParams > 0) to add to this template.
...  More parameter definitions (of CdotXSIParam * type) to add to this template.
Returns:
an instance of CdotXSITemplate

CdotXSITemplate ( CSIBCString  i_sName,
DOTXSIREADCALLBACK  i_ReadCallback,
DOTXSIWRITECALLBACK  i_WriteCallback,
SI_Int  i_nNbParams,
CdotXSIParam *  i_Param1,
  ...  
)

Constructor. Sets the type name, read and write callbacks, as well as a variable number of CdotXSIParam parameter definitions to add to the new template. Note that it does not contain an entry for version information, which is set the the default.

Parameters:
i_sName  Type name of the new template.
i_ReadCallback  Pointer to the read callback function used to read this template.
i_WriteCallback  Pointer to the write callback function used to write this template.
i_lVersionMajor  Major version number used for this template.
i_lVersionMinor  Minor version number used for this template.
i_nNbParams  Number of variable CdotXSIParam arguments to follow.
i_Param1  First parameter definition (if i_nNbParams > 0) to add to this template.
...  More parameter definitions (of CdotXSIParam * type) to add to this template.
Returns:
an instance of CdotXSITemplate

virtual ~CdotXSITemplate (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Void SetInstanceName ( CSIBCString  i_sInstanceName  )  [virtual]

Changes the instance name of this template to the one given by i_sInstanceName

Parameters:
i_sInstanceName  The new instance name of this template.
Returns:
SI_Void

CSIBCString& InstanceName (  )  [inline]

Returns the instance name of this template.

Returns:
CSIBCString& Reference to the instance name of this template.

SI_Void SetUserDataType ( CSIBCString  i_sUserDataType  ) 

Set the user data type for this template.

Parameters:
i_sUserDataType  String representing the type of user data contained in this template.
Returns:
SI_Void

CSIBCString& UserDataType (  )  [inline]

Gets the string representing the user data type name.

Returns:
CSIBCString& Reference to the user data type name.

CdotXSITemplates& Children (  )  [inline]

Gets the CdotXSITemplates children container instance.

Returns:
CdotXSITemplates& Returns the reference to the CdotXSITemplates children container instance.

SI_Void SetParent ( CdotXSITemplate *  i_Parent  ) 

Sets the parent template of this template to i_Parent

Parameters:
i_Parent  The new parent template of this template.
Returns:
SI_Void

SI_Void Reparent ( CdotXSITemplate *  i_Parent  ) 

Sets the parent template of this template to i_Parent

Parameters:
i_Parent  The new parent template of this template.
Returns:
SI_Void

CdotXSITemplate* Parent (  )  [inline]

Gets the parent template of this template.

Returns:
CdotXSITemplate* Pointer to the parent template of this template.

SI_Void SetSystemFlags ( SI_Int  i_nSystemFlags  ) 

Sets the system flags for this template. System flags have no specific meaning within the template. Applications using the FTK may set/query system flags as a convenient way to set application defined flags, per template. Note: This function does not remove any flags previously set.

Parameters:
i_nSystemFlags  Bit-wise system flags to set for this template.
Returns:
SI_Void

SI_Void GetSystemFlags ( SI_Int *  o_nSystemFlags  ) 

Gets the system flags for this template. System flags have no specific meaning within the template. Applications using the FTK may set/query system flags as a convenient way to set application defined flags, per template.

Parameters:
o_nSystemFlags  Pointer to an SI_Int to recieve system flags set for this template.
Returns:
SI_Void

SI_Void SetUserFlags ( SI_Int  i_nUserFlags  ) 

Sets the user flags for this template. User flags have no specific meaning within the template. Applications using the FTK may set/query user flags as a convenient way to set application defined flags, per template. Note: This function does not remove any flags previously set.

Parameters:
i_nUserFlags  Bit-wise user flags to set for this template.
Returns:
SI_Void

SI_Void GetUserFlags ( SI_Int *  o_nUserFlags  ) 

Gets the user flags for this template. User flags have no specific meaning within the template. Applications using the FTK may set/query user flags as a convenient way to set application defined flags, per template.

Parameters:
o_nUserFlags  Pointer to an SI_Int to recieve system flags set for this template.

CdotXSIParams& Params (  )  [inline]

Gets the CdotXSIParams params container instance.

Returns:
CdotXSIParams& Reference to the CdotXSIParams container holding the CdotXSIParam entries for this template.

virtual SI_Void InitializeFromName ( SI_Char *  i_pChar,
CXSIParser *  in_pParser  
) [virtual]

Initialize the template from a name in the native templates collection.

Parameters:
i_pChar  String representing the type name of the template to initialize.
in_pParser  Pointer to the parser object.
Returns:
SI_Void

CdotXSITemplates* ChildrenOfType ( CSIBCString  in_type  ) 

Creates a new CdotXSITemplates container, containing all child templates of this template, that match the type name given by in_type. If there are no matches, the created container is empty (but is still valid).

Parameters:
in_type  The type name to match to the child type name.
Returns:
CdotXSITemplates* Pointer to the created container.

CdotXSITemplate* ChildrenOfTypeNamed ( CSIBCString  in_type,
CSIBCString  in_name  
)

Returns the first child template that has type name in_type and instance name in_name.

Parameters:
in_type  The type name to match to a child template.
in_name  The instance name to match to a child template.
Returns:
CdotXSITemplate* The first child of the template that matches both the type name given by in_type and instance name in_name. NULL if no children match the given parameters.

eCOLLADATemplateType GetTemplateType (  )  [inline]

Returns the template type

Returns:
eCOLLADATemplateType The template type

SI_Void SetTemplateType ( eCOLLADATemplateType  in_etype  )  [inline]

Sets the template type

The documentation for this class was generated from the following file: