Kiwano Engine  v1.2.x
kiwano::FileSystem类 参考

文件系统,为其他模块提供文件搜索规则等 更多...

#include <FileSystem.h>

类 kiwano::FileSystem 继承关系图:
kiwano::FileSystem 的协作图:

Public 成员函数

void AddSearchPath (const String &path)
 添加文件搜索路径 更多...
 
void SetSearchPaths (const Vector< String > &paths)
 设置文件搜索路径 更多...
 
String GetFullPathForFile (const String &file) const
 在搜索列表中查找文件并获取完整路径 更多...
 
void AddFileLookupRule (const String &key, const String &file_path)
 添加文件路径查找字典规则 更多...
 
void SetFileLookupDictionary (const UnorderedMap< String, String > &dict)
 设置文件路径查找字典 更多...
 
bool IsFileExists (const String &file_path) const
 文件是否存在 更多...
 
bool IsAbsolutePath (const String &path) const
 判断路径是否是绝对路径 更多...
 
bool RemoveFile (const String &file_path) const
 删除文件 更多...
 
bool ExtractResourceToFile (const Resource &res, const String &dest_file_name) const
 释放二进制资源到临时文件目录 更多...
 

额外继承的成员函数

- Public 类型 继承自 kiwano::Singleton< FileSystem >
using object_type = FileSystem
 
- 静态 Public 成员函数 继承自 kiwano::Singleton< FileSystem >
static object_typeGetInstance ()
 
static object_typeGetInstancePtr ()
 
- Protected 成员函数 继承自 kiwano::Singleton< FileSystem >
 Singleton (const Singleton &)=delete
 
Singletonoperator= (const Singleton &)=delete
 
- 静态 Protected 属性 继承自 kiwano::Singleton< FileSystem >
static FileSystem instance_
 

详细描述

文件系统,为其他模块提供文件搜索规则等

成员函数说明

void kiwano::FileSystem::AddFileLookupRule ( const String &  key,
const String &  file_path 
)

添加文件路径查找字典规则

参数
key文件关键词
file_path文件路径
void kiwano::FileSystem::AddSearchPath ( const String &  path)

添加文件搜索路径

参数
path文件搜索路径
bool kiwano::FileSystem::ExtractResourceToFile ( const Resource res,
const String &  dest_file_name 
) const

释放二进制资源到临时文件目录

参数
res资源
dest_file_name目标文件名
返回
操作是否成功
String kiwano::FileSystem::GetFullPathForFile ( const String &  file) const

在搜索列表中查找文件并获取完整路径

参数
file文件路径
返回
完整的文件路径
bool kiwano::FileSystem::IsAbsolutePath ( const String &  path) const

判断路径是否是绝对路径

参数
path文件路径
返回
若是绝对路径,返回 true
bool kiwano::FileSystem::IsFileExists ( const String &  file_path) const

文件是否存在

参数
file_path文件路径
返回
若文件存在,返回 true
bool kiwano::FileSystem::RemoveFile ( const String &  file_path) const

删除文件

参数
file_path文件路径
返回
删除是否成功
void kiwano::FileSystem::SetFileLookupDictionary ( const UnorderedMap< String, String > &  dict)

设置文件路径查找字典

参数
dict文件路径查找字典
void kiwano::FileSystem::SetSearchPaths ( const Vector< String > &  paths)

设置文件搜索路径

参数
paths搜索路径数组