INSANEMODE/OpenAssetTools
1
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-06-14 08:47:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

ObjLoading: Add documentation for IObjLoader, ObjLoading and IWD

Browse Source
This commit is contained in:
Jan
2020-02-04 23:48:11 +01:00
parent b8de90a675
commit b67b4ee316
3 changed files with 53 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/ObjLoading/IObjLoader.h
View File

@ -8,10 +8,30 @@ class IObjLoader
public:
virtual ~IObjLoader() = default;
/**
* \brief Checks whether this ObjLoader supports a specified zone.
* \param zone The zone to check.
* \return \c true if the specified zone is supported.
*/
virtual bool SupportsZone(Zone* zone) = 0;
/**
* \brief Loads all containers that are referenced by a specified zone.
* \param searchPath The search path object to use to find the referenced containers.
* \param zone The zone to check for referenced containers.
*/
virtual void LoadReferencedContainersForZone(ISearchPath* searchPath, Zone* zone) = 0;
/**
* \brief Unloads all containers of a specified zone. If a container is also loaded by another zone it will only be unloaded when all referencing zones are unloaded.
* \param zone The zone to unload all containers for.
*/
virtual void UnloadContainersOfZone(Zone* zone) = 0;
/**
* \brief Loads the obj data for all assets of a specified zone.
* \param searchPath The search path object to use to find obj files.
* \param zone The zone of the assets to load the obj data for.
*/
virtual void LoadObjDataForZone(ISearchPath* searchPath, Zone* zone) = 0;
};