Luciad.Drawing.ImageIcon Class Reference

Helper class for loading JPEG or PNG files. More...

Classes
class	Builder
	Builder which takes images as input to create an IIcon. More...

Static Public Member Functions
static Luciad.Drawing.IIcon	Create (string filePath)
	Create an IIcon from a PNG or JPEG file. More...
static Luciad.Drawing.ImageIcon.Builder	NewBuilder ()
	Creates a Builder which allows to construct an IIcon based on 1 or more images. More...
static Luciad.Drawing.IIcon	ToIcon (Luciad.Drawing.Image image)
	Converts an Image to an Icon. More...

Detailed Description

Helper class for loading JPEG or PNG files.

Since

2020.2

Member Function Documentation

Create()

static Luciad.Drawing.IIcon Luciad.Drawing.ImageIcon.Create ( string  filePath )

inlinestatic

Create an IIcon from a PNG or JPEG file.

Will throw a RuntimeError if the file does not contain any valid data or if the file format could not be recognized.

It accepts icon files with following naming convention.

• The base icon at display scale 1 is named <name>.<ext> where <ext> is PNG or JPEG.
• The icon at display scale f is named <name>@<f>x.<ext>. f is typically a value like 2 or 4. See the article on high DPI for additional information.

Parameters

filePath

a file path

Returns

an IIcon from a PNG or JPEG file

Exceptions

System.Exception

if the file does not contain any valid data or if the file format could not be recognized.

NewBuilder()

static Luciad.Drawing.ImageIcon.Builder Luciad.Drawing.ImageIcon.NewBuilder ( )

inlinestatic

Creates a Builder which allows to construct an IIcon based on 1 or more images.

Returns

the builder.

Since

2023.1

ToIcon()

static Luciad.Drawing.IIcon Luciad.Drawing.ImageIcon.ToIcon ( Luciad.Drawing.Image  image )

inlinestatic

Converts an Image to an Icon.

The used display scale is 1. The anchor point of the icon is at the center of the image.

Parameters

image

the Image to convert.

Returns

the IIcon.

Exceptions

System.ArgumentNullException

when passing a null value.

Since

2023.1