renoir::IFileManipulator
Object capable of enumerating directories and opening files.
#include <CoherentRenderingLibrary.h>
Inherited by cohtml::IFileSystemReader
Public Functions
| Name | |
|---|---|
| virtual | ~IFileManipulator() |
| IFileManipulator() | |
| virtual bool | EnumerateFolder(const char * path) =0 Prepares the given folder for enumeration. |
| virtual const char * | NextFile() =0 Returns the name of the i-th file in the current folder. |
| virtual IStreamReader * | OpenFile(const char * path) =0 Opens the given file for reading. |
Public Functions Documentation
function ~IFileManipulator
virtual ~IFileManipulator()
function IFileManipulator
IFileManipulator()
function EnumerateFolder
virtual bool EnumerateFolder(
const char * path
) =0
Prepares the given folder for enumeration.
Parameters:
- path the path to the folder
Return: whether the folder is ready for enumeration
function NextFile
virtual const char * NextFile() =0
Returns the name of the i-th file in the current folder.
Return: the name of the file (only the name, not its path)
function OpenFile
virtual IStreamReader * OpenFile(
const char * path
) =0
Opens the given file for reading.
Parameters:
- path path to the file
Return: a stream reader for the given file or nullptr if the path does not exist