This class is used to manage parameters of mount points, such as access, path, filters. Mount points are used to extend the Engine's file system. Mount point is a sort of a symlink enabling you to extend the virtual file system of your project by adding any external folders and packages to the 'data' directory.
More...
Inherits APIInterface.
|
void | setAccess (MountPointParameters::ACCESS access) |
| Sets access mode for the mount point. More...
|
|
MountPointParameters::ACCESS | getAccess () const |
| Sets access mode for the mount point. More...
|
|
void | setAbsolutePath (const char *path) |
| Sets the absolute path to the mounted folder/package. More...
|
|
const char * | getAbsolutePath () const |
| Returns the absolute path to the mounted folder/package. More...
|
|
void | addExclusiveFilter (const char *exclusive_filter) |
| Adds a new item to the list of exclusive filters (whitelist) to be used for files as a list of wildcards (e.g., '*.jpg', 'some_folder_*'). This list is used to selectively add files of certain types or contents of folders with certain names. More...
|
|
Unigine::Vector< Unigine::String > | getExclusiveFilters () const |
| Returns the whole list of currently used exclusive filters (as a list of wildcards). This whitelist is used to selectively add files of certain types or contents of folders with certain names. More...
|
|
void | getExclusiveFilters (Unigine::Vector< Unigine::String > &exclusive_filters) const |
| Saves to the vector specified as the argument the whole list of currently used exclusive filters (as a list of wildcards). This whitelist is used to selectively add files of certain types or contents of folders with certain names. More...
|
|
void | addIgnoreFilter (const char *ignore_filter) |
| Adds a new item to the list of ignore filters (blacklist) to be used for files as a list of wildcards (e.g., '*.jpg', 'some_folder_*'). This list is used to selectively ignore files of certain types or contents of folders with certain names. More...
|
|
Unigine::Vector< Unigine::String > | getIgnoreFilters () const |
| Returns the whole list of currently used ignore filters (as a list of wildcards). This blacklist is used to selectively ignore files of certain types or contents of folders with certain names. More...
|
|
void | getIgnoreFilters (Unigine::Vector< Unigine::String > &ignore_filters) const |
| Saves to the vector specified as the whole list of currently used ignore filters (as a list of wildcards). This blacklist is used to selectively ignore files of certain types or contents of folders with certain names. More...
|
|
This class is used to manage parameters of mount points, such as access, path, filters. Mount points are used to extend the Engine's file system. Mount point is a sort of a symlink enabling you to extend the virtual file system of your project by adding any external folders and packages to the 'data' directory.
◆ ACCESS
Access mode.
Enumerator |
---|
ACCESS_READONLY | Read-only mode. The mount point is read-only, files contained in the mounted folder/package cannot be modified.
|
ACCESS_READWRITE | Read-write mode. The mount point access mode is read-write, files contained in the mounted folder/package can be modified.
|
◆ addExclusiveFilter()
void UnigineEditor::MountPointParameters::addExclusiveFilter |
( |
const char * |
exclusive_filter | ) |
|
Adds a new item to the list of exclusive filters (whitelist) to be used for files as a list of wildcards (e.g., '*.jpg', 'some_folder_*'). This list is used to selectively add files of certain types or contents of folders with certain names.
- Parameters
-
exclusive_filter | New exclusive filter item to be added (as a list of wildcards). |
◆ addIgnoreFilter()
void UnigineEditor::MountPointParameters::addIgnoreFilter |
( |
const char * |
ignore_filter | ) |
|
Adds a new item to the list of ignore filters (blacklist) to be used for files as a list of wildcards (e.g., '*.jpg', 'some_folder_*'). This list is used to selectively ignore files of certain types or contents of folders with certain names.
- Parameters
-
ignore_filter | New ignore filter item to be added (as a list of wildcards). |
◆ create()
Creates a new instance of the class.
◆ getAbsolutePath()
const char* UnigineEditor::MountPointParameters::getAbsolutePath |
( |
| ) |
const |
Returns the absolute path to the mounted folder/package.
◆ getAccess()
Sets access mode for the mount point.
◆ getExclusiveFilters() [1/2]
Unigine::Vector<Unigine::String> UnigineEditor::MountPointParameters::getExclusiveFilters |
( |
| ) |
const |
Returns the whole list of currently used exclusive filters (as a list of wildcards). This whitelist is used to selectively add files of certain types or contents of folders with certain names.
- Returns
- The whole list of currently used exclusive filters (as a list of wildcards).
◆ getExclusiveFilters() [2/2]
void UnigineEditor::MountPointParameters::getExclusiveFilters |
( |
Unigine::Vector< Unigine::String > & |
exclusive_filters | ) |
const |
Saves to the vector specified as the argument the whole list of currently used exclusive filters (as a list of wildcards). This whitelist is used to selectively add files of certain types or contents of folders with certain names.
- Parameters
-
exclusive_filters | The whole list of currently used exclusive filters (as a list of wildcards). |
◆ getIgnoreFilters() [1/2]
Unigine::Vector<Unigine::String> UnigineEditor::MountPointParameters::getIgnoreFilters |
( |
| ) |
const |
Returns the whole list of currently used ignore filters (as a list of wildcards). This blacklist is used to selectively ignore files of certain types or contents of folders with certain names.
- Returns
- The whole list of currently used ignore filters (as a list of wildcards).
◆ getIgnoreFilters() [2/2]
void UnigineEditor::MountPointParameters::getIgnoreFilters |
( |
Unigine::Vector< Unigine::String > & |
ignore_filters | ) |
const |
Saves to the vector specified as the whole list of currently used ignore filters (as a list of wildcards). This blacklist is used to selectively ignore files of certain types or contents of folders with certain names.
- Parameters
-
ignore_filters | The whole list of currently used ignore filters (as a list of wildcards). |
◆ setAbsolutePath()
void UnigineEditor::MountPointParameters::setAbsolutePath |
( |
const char * |
path | ) |
|
Sets the absolute path to the mounted folder/package.
- Parameters
-
path | New absolute path to be set. |
◆ setAccess()
Sets access mode for the mount point.
- Parameters
-
access | New access mode to be set (see ACCESS). |