#include<kfbxref.h>
Definition at line51of filekfbxref.h.
XRef Url properties | |
bool | GetResolvedUrl(KFbxPropertyconst&pProperty, int pIndex,KString&pResolvedPath) const |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property. | |
static int | GetUrlCount(KFbxPropertyconst&pProperty) |
Get the number of Urls stored in a property. | |
static int | GetUrlCount(fbxStringconst&pUrl) |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property. | |
static bool | IsRelativeUrl(KFbxPropertyconst&pProperty, int pIndex) |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property. | |
staticKString | GetUrl(KFbxPropertyconst&pProperty, int pIndex) |
Return The nth Url stored in the property. | |
Public Member Functions | |
bool | GetFirstMatchingUrl(char const *pPrefix, char const *pOptExt, constKFbxDocument*pDoc,KString&pResolvedPath) const |
Looks for the first file matching a specified "pattern", which is built as:. | |
XRef Resolve Url and Projects | |
bool | AddXRefProject(const char *pName, const char *pUrl) |
Add XRef Projects. | |
bool | AddXRefProject(const char *pName, const char *pExtension, const char *pUrl) |
Add XRef Projects. | |
bool | AddXRefProject(KFbxDocument*) |
Add an XRef project based on a document's EmbeddedUrl property, if set, otherwise based on its current Url. | |
bool | RemoveXRefProject(const char *pName) |
Add XRef Projects. | |
bool | RemoveAllXRefProjects() |
Add XRef Projects. | |
int | GetXRefProjectCount() const |
Add XRef Projects. | |
const char * | GetXRefProjectName(int pIndex) const |
Add XRef Projects. | |
const char * | GetXRefProjectUrl(const char *pName) |
Retrieve the base Url for the given project. | |
const char * | GetXRefProjectUrl(const char *pName) const |
Add XRef Projects. | |
const char * | GetXRefProjectUrl(int pIndex) const |
Add XRef Projects. | |
bool | HasXRefProject(const char *pName) |
Check if a project with the given name is defined in this manager. | |
bool | GetResolvedUrl(char const *pUrl,KString&pResolvePath) const |
Return Try to resolve an Relative Url. | |
Static Public Attributes | |
Pre-defined Project Types | |
static const char * | sTemporaryFileProject |
This project represents a Url for storing temporary files. | |
static const char * | sConfigurationProject |
This project represents a Url for configuration files. | |
static const char * | sLocalizationProject |
This project represents a url for storing localization files (not part of the asset lib). | |
static const char * | sEmbeddedFileProject |
This project is used for creating the .fbm folders used by embedded ressources in .fbx files. |
static int GetUrlCount | ( | KFbxPropertyconst& | pProperty | ) | [static] |
Get the number of Urls stored in a property.
static int GetUrlCount | ( | fbxStringconst& | pUrl | ) | [static] |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property.
static bool IsRelativeUrl | ( | KFbxPropertyconst& | pProperty, | |
int | pIndex | |||
) | [static] |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property.
staticKStringGetUrl | ( | KFbxPropertyconst& | pProperty, | |
int | pIndex | |||
) | [static] |
Return The nth Url stored in the property.
bool GetResolvedUrl | ( | KFbxPropertyconst& | pProperty, | |
int | pIndex, | |||
KString& | pResolvedPath | |||
) | const |
Return The nth Relative Url stored in the property upon return the pXRefProject will return the name of the XRef Project closest to the Url of the property.
bool GetFirstMatchingUrl | ( | char const * | pPrefix, | |
char const * | pOptExt, | |||
constKFbxDocument* | pDoc, | |||
KString& | pResolvedPath | |||
) | const |
Looks for the first file matching a specified "pattern", which is built as:.
if pOptExt is given: prefix*.ext If pOptExt is NULL: prefix* if pOptExt is "" or ".": prefix*.
Returns the URL of the first matching pattern. Cannot be used to resolve folders, only files.
If a document is given, we start by looking at the document's fbm folder.
bool AddXRefProject | ( | const char * | pName, | |
const char * | pUrl | |||
) |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
bool AddXRefProject | ( | const char * | pName, | |
const char * | pExtension, | |||
const char * | pUrl | |||
) |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
bool AddXRefProject | ( | KFbxDocument* | ) |
Add an XRef project based on a document's EmbeddedUrl property, if set, otherwise based on its current Url.
Document | to use to name the project, and to specify the Url. |
bool RemoveXRefProject | ( | const char * | pName | ) |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
bool RemoveAllXRefProjects | ( | ) |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
int GetXRefProjectCount | ( | ) | const |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
const char* GetXRefProjectName | ( | int | pIndex | ) | const |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
const char* GetXRefProjectUrl | ( | const char * | pName | ) |
Retrieve the base Url for the given project.
pName | The name of the project |
const char* GetXRefProjectUrl | ( | const char * | pName | ) | const |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
const char* GetXRefProjectUrl | ( | int | pIndex | ) | const |
Add XRef Projects.
Note that only one Url is associated with a project. Calling this on an existing project will replace the project's existing Url.
pName | The name of the project | |
pUrl | The Url to associate with the project |
bool HasXRefProject | ( | const char * | pName | ) | [inline] |
bool GetResolvedUrl | ( | char const * | pUrl, | |
KString& | pResolvePath | |||
) | const |
Return Try to resolve an Relative Url.
const char*sTemporaryFileProject[static] |
const char*sConfigurationProject[static] |
const char*sLocalizationProject[static] |
const char*sEmbeddedFileProject[static] |
This project is used for creating the .fbm folders used by embedded ressources in .fbx files.
When not set, or if the folder is not writable, the .fbm folder is created alongside the .fbx file.
If we cannot write in that folder, we look at the sTemporaryFileProject location. If that's not set, or not writable, we use the operating system's temp folder location.