Detailed Description
Class for Container Template files.
Definition at line 56 of file kfbxcontainertemplate.h.
#include <kfbxcontainertemplate.h>
Public Member Functions |
|
| void | ParseTemplateFile (const char *pTemplateFilePath, KArrayTemplate< KString * > &pExtendTemplateNames) |
| Parse template file to get extend templates.
|
|
| void | AddExtendTemplatePath (const char *pExtendTemplatePath) |
| Add extend template path. |
|
| char * | GetExtendTemplatePathAt (kUInt pIndex) const |
| Get the (pIndex)th extend template path.
|
|
| kUInt | GetExtendTemplateCount () const |
| Get the count of extend template path.
|
|
| void | ClearExtendTemplatePath () |
| Clear the extend template path. |
|
Public Attributes |
|
| KFbxTypedProperty< fbxString > | ContainerTemplateName |
| This property contains the template name.
|
|
| KFbxTypedProperty< fbxString > | ContainerTemplatePath |
| This property contains the template path.
|
|
| KFbxTypedProperty< fbxString > | ContainerTemplatePackageName |
| This property contains the template module
name. |
|
| KFbxTypedProperty< fbxString > | ContainerTemplateVersion |
| This property contains the template version
information of the container. |
|
Protected Member Functions |
|
| KFbxContainerTemplate (KFbxSdkManager &pManager, char const *pName) | |
| virtual bool | ConstructProperties (bool pForceSet) |
| virtual void | Destruct (bool pRecursive, bool pDependents) |
Friends |
|
| class | KFbxContainer |
Constructor & Destructor Documentation
| KFbxContainerTemplate | ( | KFbxSdkManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
Member Function Documentation
| void ParseTemplateFile | ( | const char * | pTemplateFilePath, |
| KArrayTemplate< KString * > & | pExtendTemplateNames | ||
| ) |
Parse template file to get extend templates.
- Parameters:
-
pTemplateFilePath The template file to be parsed. pExtendTemplateNames Fill extend templates' names to this array.
- Remarks:
- Call this function to get extend templates' names.
| void AddExtendTemplatePath | ( | const char * | pExtendTemplatePath | ) |
Add extend template path.
- Parameters:
-
pExtendTemplatePath The template file path to be added.
| char* GetExtendTemplatePathAt | ( | kUInt | pIndex | ) | const |
Get the (pIndex)th extend template path.
- Parameters:
-
pIndex Index of the queried item.
- Returns:
- The (pIndex)th extend template path.
| kUInt GetExtendTemplateCount | ( | ) | const |
Get the count of extend template path.
- Returns:
- The count of extend template path.
| void ClearExtendTemplatePath | ( | ) |
Clear the extend template path.
| virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxObject.
| virtual void Destruct | ( | bool | pRecursive, |
| bool | pDependents | ||
| ) | [protected, virtual] |
Reimplemented from KFbxObject.
Friends And Related Function Documentation
friend class KFbxContainer
[friend] |
Definition at line 157 of file kfbxcontainertemplate.h.
Member Data Documentation
This property contains the template name.
To access this property do: TemplateName.Get(). To set this property do: TemplateName.Set(fbxString).
Default value is "".
Definition at line 96 of file kfbxcontainertemplate.h.
This property contains the template path.
To access this property do: TemplatePath.Get(). To set this property do: TemplatePath.Set(fbxString).
Default value is "".
Definition at line 105 of file kfbxcontainertemplate.h.
This property contains the template module name.
To access this property do: TemplatePackageName.Get(). To set this property do: TemplatePackageName.Set(fbxString).
Default value is "".
Definition at line 114 of file kfbxcontainertemplate.h.
This property contains the template version information of the container.
To access this property do: TemplateVersion.Get(). To set this property do: TemplateVersion.Set(fbxString).
Default value is "".
Definition at line 123 of file kfbxcontainertemplate.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxplugins/kfbxcontainertemplate.h
