Gorilla.AssetsManager

Fields

• protected FDialogueSystem : TObject
  

Properties

• public DialogueSystem : TObject
  read GetDialogueSystem
  

Fields

• protected FInventory : TObject
  

Properties

• public Inventory : TObject
  read GetInventory
  

Fields

• protected FDescr : string
  
• protected FAssetClass : TGorillaAssetClass
  
• protected FAssets : TGorillaAssetsMap
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;

  Default constructor

• public constructor CreateForAsset  ( ACollection :  TCollection; const  AAssetClass :  TGorillaAssetClass ) ;

  Constructor with asset class type assignment.

• public destructor Destroy  ( ) ;
• protected function GetPackage  ( )  : TGorillaAssetsPackage ;  virtual;
• protected function GetGroupIndex  ( )  : Integer ;  virtual;
• protected procedure DoOnAssetsValueNotify  ( ASender :  TObject; const  AItem :  TGorillaAsset; AAction :  TCollectionNotification ) ;  virtual;
• protected function GetArchivePath  ( )  : string ;  virtual;
• protected function GetArchiveFilePath  ( const  APath :  string )  : string ;  class virtual;
• protected procedure SaveToArchive  ( AArchive :  TZipFile ) ;  virtual;
• protected function LoadFromArchive  ( ACollection :  TCollection; AArchive :  TZipFile; APath :  string )  : TGorillaAssetsGroup ;  class virtual;
• protected function GetDisplayName  ( )  : string ;  override;
• protected procedure SetDisplayName  ( const  AValue :  string ) ;  override;
• public procedure Initialize  ( AAssetClass :  TGorillaAssetClass ) ;

  Initializes the asset group instance. Creating the assets hashmap and applying the assets class type.

• public function FindAssetByFilename  ( const  AFilename :  string )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename.

• public function GetAssetFromId  ( const  AId :  TGUID )  : TGorillaAsset ;

  Returns an asset by a supplied unique identifier (GUID). If not asset with this GUID could be found, the method returns nil.

• public function GetAssetFromFile  ( const  AFilename :  string )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename. If no asset could be found, the routine imports the asset from supplied file.

• public function GetAssetFromStream  ( const  AFilename :  string; const  AStream :  TStream )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename. If no asset could be found, the routine imports the asset from supplied stream and supplied filename.

• public procedure Clear  ( ) ;

  Removes all assets from the specific asset group.

• public procedure AddAsset  ( const  AAsset :  TGorillaAsset ) ;  virtual;

  Adds an existing asset instance to the specific asset group.

• public function AddEmptyAsset  ( const  AFileName :  string )  : TGorillaAsset ;  overload;

  Creates and adds an empty asset object to the specific group.

• public function AddEmptyAsset  ( const  AId :  TGUID )  : TGorillaAsset ;  overload;

  Creates and adds an empty asset object to the specific group.

• public function GetSize  ( )  : Int64 ;  virtual;

  Returns the size in bytes. The size contains the the number of bytes used by the asset group itself and all its contained assets.

• public function ToJSON  ( )  : TJSONObject ;  virtual;

  Serializes an asset group to json format.

• public procedure FromJSON  ( const  AValue :  TJSONObject ) ;  virtual;

  Applies field values of an asset group from supplied json format.

Properties

• public Package : TGorillaAssetsPackage

  Returns the owner package instance.

  read GetPackage
  
• public GroupIndex : Integer

  Returns the group index inside of the parent collection.

  read GetGroupIndex
  
• public Assets : TDictionary<System.TGUID,Gorilla.AssetsManager.TGorillaAsset>

  Returns the hashmap of contained assets identified by their GUID.

  read FAssets
  
• published DisplayName : string

  Get or set a group description for identifying a specific group.

  read GetDisplayName
  write SetDisplayName
  
• published AssetClass : TGorillaAssetClass

  Returns the linked asset class type that is allowed to used within the specific asset group.

  read FAssetClass
  write FAssetClass
  

Properties

• public Package : TGorillaAssetsPackage

  Get the owner assets package. This property is needed to store all data in the zip package file.

  read GetPackage
  

Fields

• protected FArchive : TZipFile
  
• protected FStream : TStream
  
• protected FGUID : TGUID
  
• protected FDescr : string
  
• protected FGroups : TGorillaAssetsGroupCollection
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;
• public destructor Destroy  ( ) ;
• protected function GetManager  ( )  : TGorillaAssetsManager ;
• protected function GetArchive  ( )  : TZipFile ;
• protected function GetDisplayName  ( )  : string ;  override;
• protected procedure SetDisplayName  ( const  AValue :  string ) ;  override;
• public procedure Initialize  ( ) ;

  Initializes the assets package component by generating a guid and creating all default asset groups: GORILLA_ASSETS_MODEL, GORILLA_ASSETS_TEXTURE, GORILLA_ASSETS_AUDIO, GORILLA_ASSETS_VIDEO, GORILLA_ASSETS_MISC, GORILLA_ASSETS_DIALOGUE, GORILLA_ASSETS_INVENTORY

• public function AddGroup  ( const  AClass :  TGorillaAssetClass )  : TGorillaAssetsGroup ;

  Adds a new asset group to the package depending on the supplied asset class type.

• public procedure RemoveGroup  ( const  AIdx :  Integer ) ;  overload;

  Removes a specific asset group from package by the supplied asset group id. If the group do not exist, the routine will leave.

• public procedure RemoveGroup  ( const  ADescr :  string ) ;  overload;

  Removes a specific asset group from package by the supplied asset group descriptin. If the group do not exist, the routine will leave.

• public function GetGroup  ( const  AIdx :  Integer )  : TGorillaAssetsGroup ;  overload;

  Tries to find a specific assets group by the supplied group id. If no group could be found, the routine returns nil.

• public function GetGroup  ( const  ADescr :  string )  : TGorillaAssetsGroup ;  overload;

  Tries to find a specific assets group by the supplied group description. If no group could be found, the routine returns nil.

• public function GetGroupIndex  ( const  ADescr :  string )  : Integer ;  overload;

  Returns the group index inside of the group collection by the supplied description. If the specific group could not be found, the routine returns -1.

• public function GetGroupIndex  ( const  AGroup :  TGorillaAssetsGroup )  : Integer ;  overload;

  Returns the group index inside of the group collection by the supplied instance. If the specific group could not be found, the routine returns -1.

• public procedure ClearGroup  ( const  AIdx :  Integer ) ;

  Removes all contained assets from a specific group. The method will lookup for the group by the supplied index. If no group could be found, the routine will leave.

• public function AddAssetFromFile  ( const  AFilename :  string )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename. The method automatically detects the asset group and searches for the asset. If no asset could be found, the routine imports the asset from supplied file.

• public function GetAssetFromId  ( const  AGroup :  Integer; const  AId :  TGUID )  : TGorillaAsset ;

  Returns an asset by a supplied unique identifier (GUID) in the supplied asset group. If not asset with this GUID could be found, the method returns nil.

• public function GetAssetFromFile  ( const  AGroup :  Integer; const  AFilename :  string )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename. The routine searches in the supplied asset group. If no asset could be found, the routine imports the asset from supplied file.

• public function GetAssetFromStream  ( const  AGroup :  Integer; const  AFilename :  string; const  AStream :  TStream )  : TGorillaAsset ;

  Tries to find a specific asset by a supplied filename. The routine searches in the supplied asset group. If no asset could be found, the routine imports the asset from supplied stream.

• public function GetSize  ( )  : Int64 ;  virtual;

  Returns the number of bytes of the package itself, all groups and all contained assets inside.

• public procedure LoadFromFile  ( const  AFilename :  string ) ;  virtual;

  Loads a package with all groups and assets from supplied file.

• public procedure LoadFromStream  ( const  AStream :  TStream ) ;  virtual;

  Loads a package with all groups and assets from supplied stream.

• public procedure SaveToFile  ( const  AFilename :  string ) ;  virtual;
• public procedure SaveToStream  ( const  AStream :  TStream ) ;  virtual;

  Stores a package with all groups and assets to a zip archive stream.

Properties

• public Manager : TGorillaAssetsManager

  Returns the owner assets manager component.

  read GetManager
  
• public GUID : TGUID

  Returns the unique identifier of the specific package. This value is automatically set while construction.

  read FGUID
  
• public Archive : TZipFile

  Returns the internally used zip file component for storing and loading assets data.

  read GetArchive
  
• public Stream : TStream

  Returns the internally used package file stream.

  read FStream
  
• published DisplayName : string

  A description for the specific asset package to better identify different packages.

  read GetDisplayName
  write SetDisplayName
  
• published Groups : TGorillaAssetsGroupCollection

  The contained collection of asset groups with all assets.

  read FGroups
  write FGroups
  

Properties

• public Manager : TGorillaAssetsManager

  Get the owner assets manager.

  read GetManager
  

Fields

• protected FLOD : TGorillaLevelOfDetail
  
• protected FPackages : TGorillaAssetsPackageCollection
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• public function GetSize  ( )  : Int64 ;  virtual;
• public function AddEmptyPackage  ( const  ADescr :  string  =  )  : TGorillaAssetsPackage ;  virtual;

  Creates a new and empty package. The package contains the default groups: MODELS, TEXTURES, AUDIO, VIDEO, ... without any assets.

• public function GetPackageIndex  ( const  AGUID :  TGUID )  : Integer ;  overload virtual;

  Returns the collection index of a specific assets package by its unique identifier.

• public function GetPackageIndex  ( const  ADescr :  string )  : Integer ;  overload virtual;

  Returns the collection index of a specific assets package by its description.

• public function GetPackage  ( const  AGUID :  TGUID )  : TGorillaAssetsPackage ;  overload virtual;

  Returns a package object by its unique identifier.

• public function GetPackage  ( const  ADescr :  string )  : TGorillaAssetsPackage ;  overload virtual;

  Returns a package object by its description.

• public procedure RemovePackage  ( const  AGUID :  TGUID ) ;  overload virtual;

  Removes a specific package by its supplied unique identifier. The method destroys all groups and assets within. If the package could not be found, the routine will leave.

• public procedure RemovePackage  ( const  ADescr :  string ) ;  overload virtual;

  Removes a specific package by its supplied description. The method destroys all groups and assets within. If the package could not be found, the routine will leave.

• public procedure ClearPackages  ( ) ;

  Destroys all contained packages with its groups and assets.

• public function LoadPackageFromFile  ( const  AFilename :  string )  : TGorillaAssetsPackage ;  virtual;

  Creates a new package and adds it to the manager. Afterwards the method will load the package from file.

Properties

• published LOD : TGorillaLevelOfDetail

  Providing a simple opportunity to set the quality level for all assets.

  read FLOD
  write FLOD
  
• published Packages : TGorillaAssetsPackageCollection

  Get or set the internal package collection component. Within this collection all created/loaded packages are available.

  read FPackages
  write FPackages