CCOLLADATemplate Class Reference

This class represents a COLLADA template. More...

#include <COLLADATemplate.h>

Inheritance diagram for CCOLLADATemplate:

CdotXSITemplate CSIBCNode CSLCOLLADALibrary List of all members.

Public Member Functions
  CCOLLADATemplate ()
  CCOLLADATemplate (CSIBCString *i_sName)
virtual  ~CCOLLADATemplate ()
CdotXSIParams &  Attributes ()
CdotXSIParam *  AddAttribute (const SI_Char *in_szName, const SI_Char *in_szValue)
CdotXSIParam *  AddParam (const SI_Char *in_szName, int in_iType, const SI_Char *in_pStringValue=NULL)
CdotXSIParam *  AddParam (const SI_Char *in_szName, int in_iType, SI_Float in_fValue)
CdotXSIParam *  AddParam (const SI_Char *in_szName, int in_iType, SI_Int in_lValue)
CdotXSIParam *  AddParam (const SI_Char *in_szName, int in_iType, SI_Short in_sValue)
CdotXSIParam *  AddParam (const SI_Char *in_szName, int in_iType, SI_Bool in_sValue)
CCOLLADATemplate *  AddExtra (const SI_Char *in_szName)
SI_Void  AttachExtra (CdotXSITemplate *in_pExtra)
SI_Void  AttachExtraForeignProfile (CdotXSITemplate *in_pExtra)
CCOLLADATemplate *  GetExtra (const SI_Char *in_szExtraName)
CCOLLADATemplate *  CreateChildTemplate (const SI_Char *in_szName)
SI_Void  InitializeFromName (SI_Char *i_pChar, CXSIParser *in_pParser)
virtual SI_Void  SetInstanceName (CSIBCString i_sInstanceName)
SI_Void  SetCanCarryExtra (bool in_bValue)
bool  GetCanCarryExtra ()
CCOLLADATemplate *  ResolveSource ()

Detailed Description

This class represents a COLLADA template.

Constructor & Destructor Documentation

CCOLLADATemplate (  ) 

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

Returns:
an instance of CCOLLADATemplate

CCOLLADATemplate ( 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 CCOLLADATemplate

virtual ~CCOLLADATemplate (  )  [virtual]

Destructor

Member Function Documentation

CdotXSIParams& Attributes (  )  [inline]

Returns the attributes.

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

CdotXSIParam* AddAttribute ( const SI_Char *  in_szName,
const SI_Char *  in_szValue  
)

Adds a new attribute

Parameters:
[in]  in_szName  name of the attribute
[in]  in_szValue  value of the attribute

CdotXSIParam* AddParam ( const SI_Char *  in_szName,
int  in_iType,
const SI_Char *  in_pStringValue = NULL  
)

Adds a new string parameter

Parameters:
[in]  in_szName  name of the new parameter
[in]  in_iType  type of the new parameter (corresponds to the ColladaSimpleType enum)
[in]  in_pStringValue  value to use for the new parameter

CdotXSIParam* AddParam ( const SI_Char *  in_szName,
int  in_iType,
SI_Float  in_fValue  
)

Adds a new float parameter

Parameters:
[in]  in_szName  name of the new parameter
[in]  in_iType  type of the new parameter (corresponds to the ColladaSimpleType enum)
[in]  in_fValue  value to use for the new parameter

CdotXSIParam* AddParam ( const SI_Char *  in_szName,
int  in_iType,
SI_Int  in_lValue  
)

Adds a new long parameter

Parameters:
[in]  in_szName  name of the new parameter
[in]  in_iType  type of the new parameter (corresponds to the ColladaSimpleType enum)
[in]  in_lValue  value to use for the new parameter

CdotXSIParam* AddParam ( const SI_Char *  in_szName,
int  in_iType,
SI_Short  in_sValue  
)

Adds a new short parameter

Parameters:
[in]  in_szName  name of the new parameter
[in]  in_iType  type of the new parameter (corresponds to the ColladaSimpleType enum)
[in]  in_sValue  value to use for the new parameter

CdotXSIParam* AddParam ( const SI_Char *  in_szName,
int  in_iType,
SI_Bool  in_sValue  
)

Adds a new boolean parameter

Parameters:
[in]  in_szName  name of the new parameter
[in]  in_iType  type of the new parameter (corresponds to the ColladaSimpleType enum)
[in]  in_sValue  value to use for the new parameter

CCOLLADATemplate* AddExtra ( const SI_Char *  in_szName  ) 

Adds a template to the extra of this template

Parameters:
[in]  in_szName  node name of the new extra
Returns:
The extra template

SI_Void AttachExtra ( CdotXSITemplate *  in_pExtra  ) 

Attaches an existing template as an extra

Parameters:
[in]  in_pExtra  pointer to the the extra to attach

SI_Void AttachExtraForeignProfile ( CdotXSITemplate *  in_pExtra  ) 

Attaches an existing template as an extra in a foreign profile

Parameters:
[in]  in_pExtra  pointer to the the extra to attach

CCOLLADATemplate* GetExtra ( const SI_Char *  in_szExtraName  ) 

Retrieves an extra template

Parameters:
[in]  in_szExtraName  node name of the extra to retrieve
Returns:
The extra template

CCOLLADATemplate* CreateChildTemplate ( const SI_Char *  in_szName  ) 

Creates a named child template of this template

Parameters:
[in]  in_szName  node name of the new child template
Returns:
The child template

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

Initializes the template from its name

Parameters:
[in]  i_pChar  name from which the template will be initialized
[in]  in_pParser  pointer to the parser

Reimplemented from CdotXSITemplate.

virtual SI_Void SetInstanceName ( CSIBCString  i_sInstanceName  )  [virtual]

Sets the instance name of the template

Parameters:
[in]  i_sInstanceName  new instance name to set

Reimplemented from CdotXSITemplate.

SI_Void SetCanCarryExtra ( bool  in_bValue  )  [inline]

Sets whether this template can carry COLLADA extras

Parameters:
[in]  in_bValue  true to allow extras

bool GetCanCarryExtra (  )  [inline]

Returns whether this template can carry COLLADA extras

Return values:
true  if extras are allowed
false  if extras are not allowed

CCOLLADATemplate* ResolveSource (  ) 

Returns the template associated with the source attribute

Returns:
The template associated with the source

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