FGX.Assets.TfgAssetsManager: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 23: Строка 23:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">CheckAssetNameOrRaise(const AName: [[TfgAssetName|TfgAssetName]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">CheckAssetNameOrRaise(const AName: [[TfgAssetName|TfgAssetName]])</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Add(const AAsset: [[FGX.Assets.TfgAsset|TfgAsset]])</code>
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Add(const AAsset: [[FGX.Assets.TfgAsset|TfgAsset]])</code>
 
<p>Добавляет ресурс в хранилище. Если в хранилище уже есть ресурс с таким же уникальным идентификатором, то бросит исключение.</p>
 
<p>Добавляет ресурс в хранилище. Если в хранилище уже есть ресурс с таким же уникальным идентификатором, то бросит исключение.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Remove(const AAsset: [[FGX.Assets.TfgAsset|TfgAsset]])</code>
 +
<p>Удаляет указанный ресурс.</p>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Remove(const AName: [[TfgAssetName|TfgAssetName]])</code>
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Remove(const AName: [[TfgAssetName|TfgAssetName]])</code>
Строка 38: Строка 41:
  
 
<p>Удаляет все ресурсы, отфильтрованные анонимной функцией.</p><div class="info">Если предикат не указан, то метода не будет выполнен.</div>
 
<p>Удаляет все ресурсы, отфильтрованные анонимной функцией.</p><div class="info">Если предикат не указан, то метода не будет выполнен.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">Rename(const AOldName: [[TfgAssetName|TfgAssetName]]; const ANewName: [[TfgAssetName|TfgAssetName]]): [[Boolean]]</code>
 +
 +
<p>Переименовывает все ресурсы со старым именем <i>AOldName</i> , задавая им новое <i>ANewName</i> .</p><div class="info">Если хотя бы один ресурс был переименован, вернет <i>True</i> .</div>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Clear()</code>
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Clear()</code>
Строка 53: Строка 60:
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">Contains(const AName: [[TfgAssetName|TfgAssetName]]; const APlatform: [[FGX.Assets.Types.TfgPlatform|TfgPlatform]]; const ADeviceClass: [[FGX.Assets.Types.TfgDeviceClass|TfgDeviceClass]]): [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">Contains(const AName: [[TfgAssetName|TfgAssetName]]; const APlatform: [[FGX.Assets.Types.TfgPlatform|TfgPlatform]]; const ADeviceClass: [[FGX.Assets.Types.TfgDeviceClass|TfgDeviceClass]]): [[Boolean]]</code>
 
<p>Определяет, есть ли ресурс с указанным именем для указанной платформы и класса устройства в хранилище или нет.</p>
 
<p>Определяет, есть ли ресурс с указанным именем для указанной платформы и класса устройства в хранилище или нет.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsEmpty(const AName: [[TfgAssetName|TfgAssetName]]): [[Boolean]]</code>
 +
 +
<p>Определяет, есть ли содержимое в ресурсе с именем <i>AName</i> или нет?</p><div class="info">Если ресурса нет, то он по умолчанию считается пустым.</div>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAssetsNames(): [[TArray<FGX.Assets.TfgAssetName>]]</code>
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAssetsNames(): [[TArray<FGX.Assets.TfgAssetName>]]</code>
Строка 60: Строка 71:
  
 
<p>Возвращает названия всех доступных ресурсов, отфильтрованных анонимной функцией.</p><div class="info">Если предикат не указан, то вернет все названия доступных ресурсов.</div>
 
<p>Возвращает названия всех доступных ресурсов, отфильтрованных анонимной функцией.</p><div class="info">Если предикат не указан, то вернет все названия доступных ресурсов.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAssets(const APredicate: [[TfgAssetNamePredicate|TfgAssetNamePredicate]]): [[TArray<FGX.Assets.TfgAsset>]]</code>
 +
 +
<p>Возвращает все доступные ресурсы, отфильтрованных анонимной функцией.</p><div class="info">Если предикат не указан, то вернет все ресурсы.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAssets(const APredicate: [[TfgAssetPredicate|TfgAssetPredicate]]): [[TArray<FGX.Assets.TfgAsset>]]</code>
 +
 +
<p>Возвращает все доступные ресурсы, отфильтрованных анонимной функцией.</p><div class="info">Если предикат не указан, то вернет все ресурсы.</div>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAllAssets(): [[TArray<FGX.Assets.TfgAsset>]]</code>
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetAllAssets(): [[TArray<FGX.Assets.TfgAsset>]]</code>
Строка 113: Строка 132:
  
 
<p>Возвращает текущий менеджер по работе с ресурсами.</p><div class="info">В мобильном приложении он всегда один.</div>
 
<p>Возвращает текущий менеджер по работе с ресурсами.</p><div class="info">В мобильном приложении он всегда один.</div>
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Debug: [[Boolean]]</code>
 
<p>Отвечает за вывод отладочной информации в лог устройства.</p>
 
 
|}
 
|}
  
Строка 122: Строка 138:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnShouldReleaseFromMemoryEvent: [[TfgShouldReleaseFromMemoryEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnShouldReleaseFromMemoryEvent: [[TfgShouldReleaseFromMemoryEvent|TfgShouldReleaseFromMemoryEvent]]</code>
 
<p>Вызывается перед тем, как ресурс будет выгружен из памяти, чтобы окончательно определить нужно ли выгружать ресурс из памяти или нет.</p>
 
<p>Вызывается перед тем, как ресурс будет выгружен из памяти, чтобы окончательно определить нужно ли выгружать ресурс из памяти или нет.</p>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetAssetManagerInstance: [[TfgGetAssetManagerInstanceEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetAssetManagerInstance: [[TfgGetAssetManagerInstanceEvent|TfgGetAssetManagerInstanceEvent]]</code>
  
 
<p>Событие для переопределения экземпляра, возвращаемого в <i>TfgAssetsManager.Current</i> .</p><div class="info">FGX Native разработана так, что она работает только с одним экземпляром менеджера ресурсов. Однако, в дизайнере может быть открыто более одного FGX Native проекта. В этом случае, для каждого проекта должен существовать отдельный экземпляр менеджера. Именно это событие позволяет повесить хук средой на получение своего менеджера в зависимости от контекста IDE.</div>
 
<p>Событие для переопределения экземпляра, возвращаемого в <i>TfgAssetsManager.Current</i> .</p><div class="info">FGX Native разработана так, что она работает только с одним экземпляром менеджера ресурсов. Однако, в дизайнере может быть открыто более одного FGX Native проекта. В этом случае, для каждого проекта должен существовать отдельный экземпляр менеджера. Именно это событие позволяет повесить хук средой на получение своего менеджера в зависимости от контекста IDE.</div>
 
|}
 
|}

Текущая версия на 17:12, 23 декабря 2022

Delphi

TfgAssetsManager = class (TObject)

TObject -> TfgAssetsManager

Описание

Менеджер управления всеми ресурсами в приложении.

Конструкторы

constructor
Create()

Описание отсутствует.

Методы

procedure
CheckAssetNameOrRaise(const AName: TfgAssetName)

Описание отсутствует.

procedure
Add(const AAsset: TfgAsset)

Добавляет ресурс в хранилище. Если в хранилище уже есть ресурс с таким же уникальным идентификатором, то бросит исключение.

procedure
Remove(const AAsset: TfgAsset)

Удаляет указанный ресурс.

procedure
Remove(const AName: TfgAssetName)

Удаляет ресурсы с указанным именем для всех платформ и классов устройств.

procedure
Remove(const AName: TfgAssetName; const APlatform: TfgPlatform; const ADeviceClass: TfgDeviceClass)

Удаляет ресурс с указанным именем для конкретной платформы и класса устройств.

procedure
Remove(const APredicate: TfgAssetNamePredicate)

Удаляет все ресурсы, отфильтрованные анонимной функцией.

Если предикат не указан, то метода не будет выполнен.
function
Rename(const AOldName: TfgAssetName; const ANewName: TfgAssetName): Boolean

Переименовывает все ресурсы со старым именем AOldName , задавая им новое ANewName .

Если хотя бы один ресурс был переименован, вернет True .
procedure
Clear()

Удаляет все ресурсы.

function
Contains(const AAsset: TfgAsset): Boolean

Определяет, есть ли ресурс с уникальным ID в хранилище или нет.

function
Contains(const AName: TfgAssetName): Boolean

Определяет, есть ли ресурс с указанным именем в хранилище или нет.

function
Contains(const AName: TfgAssetName; const AAssetClass: TfgAssetClass): Boolean

Определяет, есть ли ресурс с указанным именем и типом в хранилище или нет.

function
Contains(const AName: TfgAssetName; const APlatform: TfgPlatform; const ADeviceClass: TfgDeviceClass): Boolean

Определяет, есть ли ресурс с указанным именем для указанной платформы и класса устройства в хранилище или нет.

function
IsEmpty(const AName: TfgAssetName): Boolean

Определяет, есть ли содержимое в ресурсе с именем AName или нет?

Если ресурса нет, то он по умолчанию считается пустым.
function
GetAssetsNames(): [[TArray<FGX.Assets.TfgAssetName>]]

Возвращает названия всех доступных ресурсов.

function
GetAssetsNames(const APredicate: TfgAssetNamePredicate): [[TArray<FGX.Assets.TfgAssetName>]]

Возвращает названия всех доступных ресурсов, отфильтрованных анонимной функцией.

Если предикат не указан, то вернет все названия доступных ресурсов.
function
GetAssets(const APredicate: TfgAssetNamePredicate): [[TArray<FGX.Assets.TfgAsset>]]

Возвращает все доступные ресурсы, отфильтрованных анонимной функцией.

Если предикат не указан, то вернет все ресурсы.
function
GetAssets(const APredicate: TfgAssetPredicate): [[TArray<FGX.Assets.TfgAsset>]]

Возвращает все доступные ресурсы, отфильтрованных анонимной функцией.

Если предикат не указан, то вернет все ресурсы.
function
GetAllAssets(): [[TArray<FGX.Assets.TfgAsset>]]

Возвращает список всех ресурсов.

function
GetGroupedAssets(): [[TArray<FGX.Assets.TfgAssetGroup>]]

Возвращает список ресурсов сгруппированных по имени TfgAsset.Name .

Удаление списка лежит на плечах клиента. Сами эксземпляры ресурсов удалять не нужно!
function
Find(const AName: TfgAssetName; const APlatform: TfgPlatform; const ADeviceClass: TfgDeviceClass; out AAsset: T): Boolean

Поиск ресурса указанного класса по имени для текущей платформы и класса устройства. Если ресурс найден, то вернет True и AAsset .

function
Find(const AName: TfgAssetName; const APlatform: TfgPlatform; const ADeviceClass: TfgDeviceClass; out AAsset: TfgAsset): Boolean

Описание отсутствует.

function
Find(const AName: TfgAssetName; out AAsset: T): Boolean

Поиск ресурса указанного класса по имени. Если ресурс найден, то вернет True и AAsset .

Приоритеты в поиске: <Текущая платформа> - <Текущий класс устройства>, <Текущая платформа> - <Универсальный класс устройств>, <Универсальная платформа> - <Текущий класс устройства>, <Универсальная платформа> - <Универсальный класс устройств>.
function
Find(const AName: TfgAssetName; out AAsset: TfgAsset): Boolean

Описание отсутствует.

procedure
NotifyLinks()

Уведомление всех клиентов о том, что ресурсы обновились.

Для внутреннего использования!
procedure
NotifyLinks(const AAssetName: TfgAssetName)

Уведомление всех клиентов ресурса AAssetName о том, что ресурс обновился.

Для внутреннего использования!
function
NeedReleaseFromMemory(const AAsset: TfgAsset): Boolean

Нужно ли выгружать указанные ресурс AAsset из памяти или нет?

Использует настройки управления ресурсами Options и событие OnShouldReleaseFromMemoryEvent . Используется только для автоматической выгрузки ресурса из памяти на основании методов TfgAsset.Acquire и TfgAsset.Release .
class function
HasCurrent(): Boolean

Описание отсутствует.

class function
CurrentDeviceClass(): TfgDeviceClass

Текущая класс устройства, на которой запущено приложение.

class function
CurrentPlatform(): TfgPlatform

Текущая платформа, на которой запущено приложение.

Свойства

property
AutoreleaseOptions: TfgAssetAutoreleaseOptions

Настройки управления выгрузкой "тяжелых" данных, связанных c ресурсами.

property
Current: TfgAssetsManager

Возвращает текущий менеджер по работе с ресурсами.

В мобильном приложении он всегда один.

События

event
OnShouldReleaseFromMemoryEvent: TfgShouldReleaseFromMemoryEvent

Вызывается перед тем, как ресурс будет выгружен из памяти, чтобы окончательно определить нужно ли выгружать ресурс из памяти или нет.

event
OnGetAssetManagerInstance: TfgGetAssetManagerInstanceEvent

Событие для переопределения экземпляра, возвращаемого в TfgAssetsManager.Current .

FGX Native разработана так, что она работает только с одним экземпляром менеджера ресурсов. Однако, в дизайнере может быть открыто более одного FGX Native проекта. В этом случае, для каждого проекта должен существовать отдельный экземпляр менеджера. Именно это событие позволяет повесить хук средой на получение своего менеджера в зависимости от контекста IDE.