CdotXSITemplate Class Reference

Represents the base class for all template types in Softimage. More...

#include <dotXSITemplate.h>

Inheritance diagram for CdotXSITemplate:

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

Represents 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:

[in] 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:

`[in]`	i_sName	Type name of the new template.
`[in]`	i_ReadCallback	Pointer to the read callback function used to read this template.
`[in]`	i_WriteCallback	Pointer to the write callback function used to write this template.
`[in]`	i_lVersionMajor	Major version number used for this template.
`[in]`	i_lVersionMinor	Minor version number used for this template.
`[in]`	i_nNbParams	Number of variable CdotXSIParam arguments to follow.
`[in]`	i_Param1	First parameter definition (if `i_nNbParams` > 0) to add to this template.
`[in]`	...	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:

`[in]`	i_sName	Type name of the new template.
`[in]`	i_ReadCallback	Pointer to the read callback function used to read this template.
`[in]`	i_WriteCallback	Pointer to the write callback function used to write this template.
`[in]`	i_nNbParams	Number of variable CdotXSIParam arguments to follow.
`[in]`	i_Param1	First parameter definition (if `i_nNbParams` > 0) to add to this template.
`[in]`	...	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 specified by i_sInstanceName

Parameters:

[in] i_sInstanceName The new instance name of this template.

Reimplemented in CCOLLADATemplate.

CSIBCString& InstanceName ( ) [inline]

Returns the instance name of this template.

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

SI_Void SetUserDataType ( CSIBCString i_sUserDataType )

Sets the user data type for this template.

Parameters:

[in] i_sUserDataType String representing the type of user data contained in this template.

CSIBCString& UserDataType ( ) [inline]

Returns the string representing the user data type name.

Returns:: Reference to the user data type name.

CdotXSITemplates& Children ( ) [inline]

Returns the CdotXSITemplates children container instance.

Returns:: Reference to the CdotXSITemplates children container instance.

SI_Void SetParent ( CdotXSITemplate * i_Parent )

Sets the parent template of this template to the specified template.

Parameters:

[in] i_Parent The new parent template

SI_Void Reparent ( CdotXSITemplate * i_Parent )

Changes the parent template of this template to the specified template.

Parameters:

[in] i_Parent The new parent template of this template.

CdotXSITemplate* Parent ( ) [inline]

Returns the parent template of this template.

Returns:: 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 Crosswalk SDK 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:

[in] i_nSystemFlags Bit-wise system flags to set for this template.

SI_Void GetSystemFlags ( SI_Int * o_nSystemFlags )

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

Parameters:

[out] o_nSystemFlags Pointer to an SI_Int where system flags will be set for this template.

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 Crosswalk SDK 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:

[in] i_nUserFlags Bit-wise user flags to set for this template.

SI_Void GetUserFlags ( SI_Int * o_nUserFlags )

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

Parameters:

[out] o_nUserFlags Pointer to an SI_Int where user flags will be set for this template.

CdotXSIParams& Params ( ) [inline]

Returns the container of CdotXSIParam entries for this template.

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

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

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

Parameters:

`[in]`	i_pChar	String representing the type name of the template to initialize.
`[in]`	in_pParser	Pointer to the parser object.

Reimplemented in CCOLLADATemplate.

CdotXSITemplates* ChildrenOfType ( CSIBCString in_type )

Creates a new CdotXSITemplates container, containing all child templates of this template matching the specified type name. If there are no matches, the new container is empty (but still valid).

Parameters:

[in] in_type The type name to match to the child type name.

Returns:: Pointer to the newly created container.

CdotXSITemplate* ChildrenOfTypeNamed	(	CSIBCString	in_type,
		CSIBCString	in_name
	)

Returns the first child template that has the specified type name instance name.

Parameters:

`[in]`	in_type	The type name to match to a child template.
`[in]`	in_name	The instance name to match to a child template.

Returns:: The first child of the template that matches both the type name and instance name (or NULL if no children match the given parameters).

eCOLLADATemplateType GetTemplateType ( ) [inline]

Returns the template type as one of the eCOLLADATemplateType values

Returns:: The template type

SI_Void SetTemplateType ( eCOLLADATemplateType in_etype ) [inline]

Sets the template type

Parameters:

[in] in_etype One of the eCOLLADATemplateType values

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

dotXSITemplate.h

CdotXSITemplate Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation