IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
DrawingOptions Class Reference

Public Member Functions

 DrawingOptions ()
 Constructs DrawingOptions with default values.
 
 DrawingOptions (Color color, Opacity opacity)
 Constructs DrawingOptions with specified values for color and opacity .
 
override string ToString ()
 Returns a string representation of this DrawingOptions instance.
 

Properties

Color Color = new(ColorConstant.Red) [get, set]
 Color used for drawing. Defaults to ColorConstant.Red.
 
Opacity Opacity = new(100) [get, set]
 The opacity level used for drawing. Defaults to 100 (fully opaque).
 
static IEqualityComparer< DrawingOptions > Comparer = new DrawingOptionsEqualityComparer() [get]
 Default equality comparer for comparing DrawingOptions data values.
 

Detailed Description

Represents the drawing options used by the Painter for rendering.

Includes configuration for color, opacity, and reserved options for future use.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 11 of file DrawingOptions.cs.

Constructor & Destructor Documentation

◆ DrawingOptions() [1/2]

DrawingOptions ( )
inline

Constructs DrawingOptions with default values.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 17 of file DrawingOptions.cs.

◆ DrawingOptions() [2/2]

DrawingOptions ( Color color,
Opacity opacity )
inline

Constructs DrawingOptions with specified values for color and opacity .

Parameters
colorThe color to be used for drawing. This should be a valid Color value.
opacityThe opacity to be applied. Should be an instance of Opacity representing the transparency level.
Since
IDSImaging.Peak.ICV 1.3

Definition at line 33 of file DrawingOptions.cs.

Member Function Documentation

◆ ToString()

override string ToString ( )
inline

Returns a string representation of this DrawingOptions instance.

Returns
A string that represents the current DrawingOptions.
Since
IDSImaging.Peak.ICV 1.3

Definition at line 66 of file DrawingOptions.cs.

Property Documentation

◆ Color

Color Color = new(ColorConstant.Red)
getset

Color used for drawing. Defaults to ColorConstant.Red.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 44 of file DrawingOptions.cs.

◆ Comparer

IEqualityComparer<DrawingOptions> Comparer = new DrawingOptionsEqualityComparer()
staticget

Default equality comparer for comparing DrawingOptions data values.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 57 of file DrawingOptions.cs.

◆ Opacity

Opacity Opacity = new(100)
getset

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

Since
IDSImaging.Peak.ICV 1.3

Definition at line 51 of file DrawingOptions.cs.