PackageFileSystem¶

Checks if an item (file or folder) exists on the file system.

virtual bool Amplitude::PackageFileSystem::Exists (
    const AmOsString & path
) override const

Parameters:

• path The path to the item.

Returns:

true if the file exists, false otherwise.

Implements SparkyStudios::Audio::Amplitude::FileSystem::Exists

Returns the base path of the file system.

virtual const AmOsString & Amplitude::PackageFileSystem::GetBasePath () override const

Returns:

The base path for resolving relative paths from which the engine will load resources.

Implements SparkyStudios::Audio::Amplitude::FileSystem::GetBasePath

Checks if an item (file or folder) is a directory.

virtual bool Amplitude::PackageFileSystem::IsDirectory (
    const AmOsString & path
) override const

Parameters:

• path The path to the item.

Returns:

true if the file is a directory, false otherwise.

Implements SparkyStudios::Audio::Amplitude::FileSystem::IsDirectory

Returns if the package file is valid and loaded.

bool Amplitude::PackageFileSystem::IsValid () const

Returns:

true if the package file is valid and loaded, false otherwise.

Merge the given parts of the path into a single path by joining them with the file system's path separator.

virtual AmOsString Amplitude::PackageFileSystem::Join (
    const std::vector< AmOsString > & parts
) override const

Parameters:

• parts The parts of the path.

Returns:

A path concatenated with the given parts and the file system path separator.

Implements SparkyStudios::Audio::Amplitude::FileSystem::Join

Opens the file at the given path.

virtual std::shared_ptr< File > Amplitude::PackageFileSystem::OpenFile (
    const AmOsString & path,
    eFileOpenMode mode=eFileOpenMode_Read
) override const

Parameters:

• path The path to the file to open.
• mode The file open mode.

Returns:

The opened file. The returned File implementation depends on the FileSystem implementation.

Implements SparkyStudios::Audio::Amplitude::FileSystem::OpenFile

Constructs a new PackageFileSystem instance.

Amplitude::PackageFileSystem::PackageFileSystem () 

Resolves a relative path from the file system base path.

virtual AmOsString Amplitude::PackageFileSystem::ResolvePath (
    const AmOsString & path
) override const

Returns:

The resolved path.

Implements SparkyStudios::Audio::Amplitude::FileSystem::ResolvePath

Changes the file system base path.

virtual void Amplitude::PackageFileSystem::SetBasePath (
    const AmOsString & basePath
) override

That path is interpreted by the implementation and doesn't necessarily have to be a real path on disk. It's just used as the base path for resolving relative paths from which the engine will load resources.

Parameters:

• basePath The file system base path.

Implements SparkyStudios::Audio::Amplitude::FileSystem::SetBasePath

Sets the platform file system to use for opening and reading the package file.

template<class TFileSystem, class... Args>
inline void Amplitude::PackageFileSystem::SetPlatformFileSystem (
    Args &&... args
) 

Parameters:

• args The parameters to pass to the file system constructor.

Sets the platform file system to use for opening and reading the package file.

void Amplitude::PackageFileSystem::SetPlatformFileSystem (
    std::shared_ptr< FileSystem > fileSystem
) 

Parameters:

• fileSystem The file system to use.

Stops the FileSystem .

virtual void Amplitude::PackageFileSystem::StartCloseFileSystem () override

This function MUST be called when the FileSystem is no longer needed. It is used to stop the file system (e.g.: unmounting an archive).

Note:

• For implementations, it is recommended to process the stopping in a separate thread.
• The implementation is free to ignore this if not needed.

Implements SparkyStudios::Audio::Amplitude::FileSystem::StartCloseFileSystem

Opens the FileSystem .

virtual void Amplitude::PackageFileSystem::StartOpenFileSystem () override

This function MUST be called before any other actions in the file system. It is used to initialize the file system (e.g.: mounting an archive).

Note:

• For implementations, It is recommended to process the initialization in a separate thread. *
• The implementation is free to ignore this if not needed.

Implements SparkyStudios::Audio::Amplitude::FileSystem::StartOpenFileSystem

Checks if the FileSystem is stopped.

virtual bool Amplitude::PackageFileSystem::TryFinalizeCloseFileSystem () override

Since the StartCloseFileSystem() function is designed to be asynchronous, this function is used to check if the FileSystem has been successfully stopped.

Returns:

true if the FileSystem has been fully stopped, false otherwise.

Implements SparkyStudios::Audio::Amplitude::FileSystem::TryFinalizeCloseFileSystem

Checks if the FileSystem is loaded.

virtual bool Amplitude::PackageFileSystem::TryFinalizeOpenFileSystem () override

Since the StartOpenFileSystem() function is designed to be asynchronous, this function is used to check if the FileSystem has been successfully initialized.

Returns:

true if the FileSystem has been fully loaded, false otherwise.

Implements SparkyStudios::Audio::Amplitude::FileSystem::TryFinalizeOpenFileSystem

Destroys the PackageFileSystem instance.

Amplitude::PackageFileSystem::~PackageFileSystem () override