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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показана 121 промежуточная версия этого же участника)
Строка 1: Строка 1:
−
* [[ FGX.Assets.BitmapSet | Вверх к родителю: FGX.Assets.BitmapSet ]]
+
* [[ FGX.Assets.TfgAsset | Вверх к родителю: TfgAsset ]]
−
* [[ FGX.Assets.BitmapSet.TfgAssetBitmapSet_Methods | Методы ]]
+
* [[ FGX.Assets.BitmapSet | К модулю: FGX.Assets.BitmapSet ]]
−
* [[ FGX.Assets.BitmapSet.TfgAssetBitmapSet_Properties | Свойства ]]
 
  
 
Delphi
 
Delphi
  
−
<code>TfgAssetBitmapSet = class (TfgAsset)</code>
+
<syntaxhighlight lang="Delphi">TfgAssetBitmapSet = class (TfgAsset)</syntaxhighlight>
  
−
== Конструкторы ==
+
<p class="class-inheritance"><span class="type-border">[[System.TObject|TObject]]</span> -> <span class="type-border">[[FGX.Assets.TfgAsset|TfgAsset]]</span> -> <span class="type-border">[[FGX.Assets.BitmapSet.TfgAssetBitmapSet|TfgAssetBitmapSet]]</span></p>
 +
 
 +
== Описание ==
 +
 
 +
<p>Ресурс "набор изображений". Хранит в себе несколько вариантов одного и того же изображения под разные скейлы экрана.</p>
 +
== Методы ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
| <code>constructor</code> || <code>Create()</code>
+
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsEmpty(): [[Boolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Add(const ABitmapInfo: [[TfgBitmapInfo|TfgBitmapInfo]])</code>
 +
<p>Добавляет в набор информацию об изображении.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">AddBitmap(const ABitmap: [[FGX.Canvas.TfgBitmap|TfgBitmap]]; const AScale: [[Single]])</code>
 +
<p>Добавляет в набор битмап <i>ABitmap</i> для экрана со скейлом <i>AScale</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">Contains(const AScale: [[Single]]): [[Boolean]]</code>
 +
<p>Проверяет содержит ли набор изображения для экрана со скейлом <i>AScale</i> или нет?</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Remove(const AScale: [[Single]])</code>
 +
<p>Удаляет из набора изображения для экрана со скейлом <i>AScale</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Clear()</code>
 +
<p>Полностью очищает набор от всех изображений.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetBitmap(): [[FGX.Canvas.TfgBitmap|TfgBitmap]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetBitmap(const AScale: [[Single]]): [[FGX.Canvas.TfgBitmap|TfgBitmap]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetBitmapInfo(): [[TfgBitmapInfo|TfgBitmapInfo]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetBitmapInfo(const AScale: [[Single]]): [[TfgBitmapInfo|TfgBitmapInfo]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindBitmap(out ABitmap: [[FGX.Canvas.TfgBitmap|TfgBitmap]]): [[Boolean]]</code>
 +
<p>Выполняет поиск наиболее подходящего под текущий скейл экрана изображение. Если изображение найдено, то оно возвращается в параметре <i>ABitmap</i> и в результате будет <i>True</i> , иначе вернется nil и <i>False</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindBitmap(const AScale: [[Single]]; out ABitmap: [[FGX.Canvas.TfgBitmap|TfgBitmap]]): [[Boolean]]</code>
 +
<p>Выполняет поиск изображение для экрана со скейлом <i>AScale</i> . Если изображение найдено, то оно возвращается в параметре <i>ABitmap</i> и в результате будет <i>True</i> , иначе вернется nil и <i>False</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindBitmapInfo(out ABitmapInfo: [[TfgBitmapInfo|TfgBitmapInfo]]): [[Boolean]]</code>
 +
<p>Выполняет поиск информации наиболее подходящего под текущий скейл экрана изображения. Если изображение найдено, то информация о нем возвращается в параметре <i>ABitmapInfo</i> и в результате будет <i>True</i> , иначе вернется nil и <i>False</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindBitmapInfo(const AScale: [[Single]]; out ABitmapInfo: [[TfgBitmapInfo|TfgBitmapInfo]]): [[Boolean]]</code>
 +
<p>Выполняет поиск информации изображения для экрана со скейлом <i>AScale</i> . Если изображение найдено, то оно возвращается в параметре <i>ABitmap</i> и в результате будет <i>True</i> , иначе вернется nil и <i>False</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">BeginUpdate()</code>
 +
<p>Запускает процесс пакетного обновления данных ресурса. В процессе обновления, не будет вызываться событие <i>Changed</i> . Если в процессе обновления данные действительно были изменены, то по окончании будет вызван метод <i>Changed</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">EndUpdate()</code>
 +
<p>Заканчивает процесс пакетного обновления данных ресурса. Если в процессе обновления данные действительно были изменены, то по окончании будет вызван метод <i>Changed</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsUpdating(): [[Boolean]]</code>
 +
<p>Находится ли ресурс в процессе обновления?</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ReleaseFromMemory()</code>
 +
 
 +
<p>Выгружает из памяти изображения данного ресурса.</p><div class="info"><p>Данный вид ресурса загружает изображения отложенно. <i>Bitmap</i> загружается в память при первом обращении к экземлпяру изображения. Это позволяет сэкономить время на старте приложения и загружать изображения по мере их необходимости. Однако, при не всегда все изображения нужно хранить в памяти, так как память - это ограниченный ресурс. Именно для выгрузки изображения из памяти и служит данный метод.</p><p>Если данный ресурс используется в компоненте, то вызов метода может закончиться повторной загрузкой изображения в память.</p></div>
 +
|}
 +
 
 +
== Свойства ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BitmapInfos: [[TArray<FGX.Assets.BitmapSet.TfgBitmapInfo>]]</code>
 +
<p>Возвращает массив хранимых в ресурсе изображений.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Bitmaps[const AScale]: [[FGX.Canvas.TfgBitmap|TfgBitmap]]</code>
  
 +
<p>Доступ к изображения для указанного скейла.</p><div class="info">Если изображения для указанного скейла <i>AScale</i> нету, то бросит исключение <i>EfgAssetException</i> .</div>
 +
|}
 +
 +
== Константы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>AssetType: [[string]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}

Текущая версия на 03:12, 6 декабря 2021

Delphi 

TfgAssetBitmapSet = class (TfgAsset)

TObject -> TfgAsset -> TfgAssetBitmapSet

Описание

Ресурс "набор изображений". Хранит в себе несколько вариантов одного и того же изображения под разные скейлы экрана.

Методы

function
IsEmpty(): Boolean

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

procedure
Add(const ABitmapInfo: TfgBitmapInfo)

Добавляет в набор информацию об изображении.

procedure
AddBitmap(const ABitmap: TfgBitmap; const AScale: Single)

Добавляет в набор битмап ABitmap для экрана со скейлом AScale .

function
Contains(const AScale: Single): Boolean

Проверяет содержит ли набор изображения для экрана со скейлом AScale или нет?

procedure
Remove(const AScale: Single)

Удаляет из набора изображения для экрана со скейлом AScale .

procedure
Clear()

Полностью очищает набор от всех изображений.

function
GetBitmap(): TfgBitmap

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

function
GetBitmap(const AScale: Single): TfgBitmap

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

function
GetBitmapInfo(): TfgBitmapInfo

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

function
GetBitmapInfo(const AScale: Single): TfgBitmapInfo

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

function
FindBitmap(out ABitmap: TfgBitmap): Boolean

Выполняет поиск наиболее подходящего под текущий скейл экрана изображение. Если изображение найдено, то оно возвращается в параметре ABitmap и в результате будет True , иначе вернется nil и False .

function
FindBitmap(const AScale: Single; out ABitmap: TfgBitmap): Boolean

Выполняет поиск изображение для экрана со скейлом AScale . Если изображение найдено, то оно возвращается в параметре ABitmap и в результате будет True , иначе вернется nil и False .

function
FindBitmapInfo(out ABitmapInfo: TfgBitmapInfo): Boolean

Выполняет поиск информации наиболее подходящего под текущий скейл экрана изображения. Если изображение найдено, то информация о нем возвращается в параметре ABitmapInfo и в результате будет True , иначе вернется nil и False .

function
FindBitmapInfo(const AScale: Single; out ABitmapInfo: TfgBitmapInfo): Boolean

Выполняет поиск информации изображения для экрана со скейлом AScale . Если изображение найдено, то оно возвращается в параметре ABitmap и в результате будет True , иначе вернется nil и False .

procedure
BeginUpdate()

Запускает процесс пакетного обновления данных ресурса. В процессе обновления, не будет вызываться событие Changed . Если в процессе обновления данные действительно были изменены, то по окончании будет вызван метод Changed .

procedure
EndUpdate()

Заканчивает процесс пакетного обновления данных ресурса. Если в процессе обновления данные действительно были изменены, то по окончании будет вызван метод Changed .

function
IsUpdating(): Boolean

Находится ли ресурс в процессе обновления?

procedure
ReleaseFromMemory()

Выгружает из памяти изображения данного ресурса.

Данный вид ресурса загружает изображения отложенно. Bitmap загружается в память при первом обращении к экземлпяру изображения. Это позволяет сэкономить время на старте приложения и загружать изображения по мере их необходимости. Однако, при не всегда все изображения нужно хранить в памяти, так как память - это ограниченный ресурс. Именно для выгрузки изображения из памяти и служит данный метод.

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

Свойства

property
BitmapInfos: [[TArray<FGX.Assets.BitmapSet.TfgBitmapInfo>]]

Возвращает массив хранимых в ресурсе изображений.

property
Bitmaps[const AScale]: TfgBitmap

Доступ к изображения для указанного скейла.

Если изображения для указанного скейла AScale нету, то бросит исключение EfgAssetException .

Константы

const
AssetType: string

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

Источник — http://docs.fgx-native.com/index.php?title=FGX.Assets.BitmapSet.TfgAssetBitmapSet&oldid=27467