Main Page Modules Class Hierarchy Alphabetical List Compound List Compound Members
CdotXSITemplate Class Reference
Class representing the base class for all template types in XSI.
More...
#include <dotXSITemplate.h>
Inheritance diagram for CdotXSITemplate::
List of all members.Public Methods
- CdotXSITemplate ()
- THIS CODE IS PUBLISHED AS A SAMPLE ONLY AND IS PROVIDED "AS IS". IN NO EVENT SHALL SOFTIMAGE, AVID TECHNOLOGY, INC. AND/OR THEIR RESPECTIVE SUPPLIERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE . COPYRIGHT NOTICE. Copyright © 1999 Avid Technology Inc. . All rights reserved. SOFTIMAGE is a registered trademark of Avid Technology Inc. or its subsidiaries or divisions. Windows NT is a registered trademark of Microsoft Corp. All other trademarks contained herein are the property of their respective owners. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////. More...
- 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 ()
- SI_Void SetInstanceName (CSIBCString i_sInstanceName)
- CSIBCString & InstanceName ()
- SI_Void SetUserDataType (CSIBCString i_sUserDataType)
- CSIBCString & UserDataType ()
- CdotXSITemplates & Children ()
- SI_Void SetParent (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 ()
- SI_Void InitializeFromName (SI_Char *i_pChar, CXSIParser *in_pParser)
- SI_Void GetVersionInfo (SI_Int *out_iMajor, SI_Int *out_iMinor)
- CdotXSITemplates * ChildrenOfType (CSIBCString in_type)
- CdotXSITemplate * ChildrenOfTypeNamed (CSIBCString in_type, CSIBCString in_name)
Public Attributes
-
DOTXSIREADCALLBACK m_ReadCallback
- Callback function for reading the template.
-
DOTXSIWRITECALLBACK m_WriteCallback
- Callback function for writing the template.
Detailed Description
Class representing the base class for all template types in XSI.
All scene information in XSI (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 XSI.
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 XSI 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::CdotXSITemplate |
( |
|
) |
|
|
|
THIS CODE IS PUBLISHED AS A SAMPLE ONLY AND IS PROVIDED "AS IS". IN NO EVENT SHALL SOFTIMAGE, AVID TECHNOLOGY, INC. AND/OR THEIR RESPECTIVE SUPPLIERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE . COPYRIGHT NOTICE. Copyright © 1999 Avid Technology Inc. . All rights reserved. SOFTIMAGE is a registered trademark of Avid Technology Inc. or its subsidiaries or divisions. Windows NT is a registered trademark of Microsoft Corp. All other trademarks contained herein are the property of their respective owners. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////.
Default constructor. Sets the default version information, and the default read and write callbacks for the template. -
Returns:
-
an instance of CdotXSITemplate
|
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::CdotXSITemplate |
( |
CSIBCString |
i_sName, |
|
|
DOTXSIREADCALLBACK |
i_ReadCallback, |
|
|
DOTXSIWRITECALLBACK |
i_WriteCallback, |
|
|
SI_Int |
i_lVersionMajor, |
|
|
SI_Int |
i_lVersionMinor, |
|
|
SI_Int |
i_nNbParams, |
|
|
CdotXSIParam * |
i_pParam1, |
|
|
... |
|
|
) |
|
|
|
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::CdotXSITemplate |
( |
CSIBCString |
i_sName, |
|
|
DOTXSIREADCALLBACK |
i_ReadCallback, |
|
|
DOTXSIWRITECALLBACK |
i_WriteCallback, |
|
|
SI_Int |
i_nNbParams, |
|
|
CdotXSIParam * |
i_pParam1, |
|
|
... |
|
|
) |
|
|
|
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
|
CdotXSITemplate::~CdotXSITemplate |
( |
|
) |
[virtual] |
|
Member Function Documentation
|
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.
|
|
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. |
SI_Void CdotXSITemplate::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 CdotXSITemplate::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. |
|
SI_Void CdotXSITemplate::GetVersionInfo |
( |
SI_Int * |
out_iMajor, |
|
|
SI_Int * |
out_iMinor |
|
) |
|
|
|
Returns the version information of this template. If either parameter is NULL, no information is returned. -
Parameters:
-
out_iMajor |
Pointer to an SI_Int which takes the value of the major version. |
out_iMinor |
Pointer to an SI_Int which takes the value of the minor version. |
-
Returns:
-
SI_Void
|
SI_Void CdotXSITemplate::InitializeFromName |
( |
SI_Char * |
i_pChar, |
|
|
CXSIParser * |
in_pParser |
|
) |
|
|
|
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
|
CSIBCString& CdotXSITemplate::InstanceName |
( |
|
) |
[inline] |
|
|
Returns the instance name of this template. -
Returns:
-
CSIBCString& Reference to the instance name of this template.
|
CdotXSITemplate* CdotXSITemplate::Parent |
( |
|
) |
[inline] |
|
|
Gets the parent template of this template. -
Returns:
-
CdotXSITemplate* Pointer to the parent template of this template.
|
SI_Void CdotXSITemplate::SetInstanceName |
( |
CSIBCString |
i_sInstanceName |
) |
|
|
|
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
|
SI_Void CdotXSITemplate::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 CdotXSITemplate::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 CdotXSITemplate::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
|
SI_Void CdotXSITemplate::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
|
CSIBCString& CdotXSITemplate::UserDataType |
( |
|
) |
[inline] |
|
|
Gets the string representing the user data type name. -
Returns:
-
CSIBCString& Reference to the user data type name.
|
The documentation for this class was generated from the following files:
- dotXSITemplate.h
- dotXSITemplate.cpp
© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.
© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.