IDS peak ICV v1.6.0
Loading...
Searching...
No Matches
Painter Class Reference

Public Member Functions

 Painter (Image image)
 Constructs a Painter with the target image.
 
void Draw (IDrawable drawable)
 Draws the specified drawable object onto the image.
 

Properties

Color Color = new(ColorConstant.Red) [get, set]
 The color used for painting. Defaults to ColorConstant.Red.
 
Opacity Opacity = new(100) [get, set]
 The opacity used for painting. Defaults to 100 (fully opaque).
 

Detailed Description

Provides functionality for painting drawable objects on images.

The Painter enables rendering of objects derived from IDrawable onto images. Supported image formats are RGB8, BGR8, RGBa8, and BGRa8.

You can configure drawing properties such as color and opacity using Color and Opacity. If not explicitly configured, default values from DrawingOptions are applied.

var painter = new Painter(image);
painter.Color = new Color(ColorConstant.BLUE);
painter.Opacity = new Opacity(50);
painter.Draw(region);
Color Color
The color used for painting. Defaults to ColorConstant.Red.
Definition Painter.cs:53
Opacity Opacity
The opacity used for painting. Defaults to 100 (fully opaque).
Definition Painter.cs:60
Painter(Image image)
Constructs a Painter with the target image.
Definition Painter.cs:43
ColorConstant
Enum class for color constants.
Definition ColorConstant.cs:9
Since
IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ Painter()

Painter ( Image image)
inline

Constructs a Painter with the target image.

Parameters
imageThe image all painting operations are performed on.
Since
IDSImaging.Peak.ICV 1.3

Member Function Documentation

◆ Draw()

void Draw ( IDrawable drawable)
inline

Draws the specified drawable object onto the image.

The following objects can be drawn:

  • Region

Refer to the documentation of the specific drawable for more details.

Parameters
drawableThe object to be drawn.
Since
IDSImaging.Peak.ICV 1.3

Property Documentation

◆ Color

Color Color = new(ColorConstant.Red)
getset

The color used for painting. Defaults to ColorConstant.Red.

Since
IDSImaging.Peak.ICV 1.3

◆ Opacity

Opacity Opacity = new(100)
getset

The opacity used for painting. Defaults to 100 (fully opaque).

Since
IDSImaging.Peak.ICV 1.3