Opacity Class Reference

Public Member Functions
	Opacity ()
	Constructs an Opacity object with full opacity (100).
	Opacity (uint value)
	Constructs an Opacity object with the specified value.
override string	ToString ()
	Returns a string that represents the current opacity value.

Properties
static uint	Minimum = 0 [get]
	The minimum allowed opacity value.
static uint	Maximum = 100 [get]
	The maximum allowed opacity value.
uint	Value [get, set]
	The opacity value. Must be between 0 and 100.
static IEqualityComparer< Opacity >	Comparer = new OpacityEqualityComparer() [get]
	A default equality comparer for comparing Opacity data values.

Detailed Description

Holds an opacity value representing the transparency level of an object or pixel.

Opacity ranges from 0 to 100, where 0 indicates complete transparency and 100 indicates complete opacity. Intermediate values represent varying levels of transparency.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 15 of file Opacity.cs.

Constructor & Destructor Documentation

Opacity() [1/2]

Opacity ( )

inline

Constructs an Opacity object with full opacity (100).

Since

IDSImaging.Peak.ICV 1.3

Definition at line 23 of file Opacity.cs.

Opacity() [2/2]

Opacity ( uint value )

inline

Constructs an Opacity object with the specified value.

Parameters

value

Opacity value in the range [0, 100]

Since

IDSImaging.Peak.ICV 1.3

Definition at line 34 of file Opacity.cs.

Member Function Documentation

ToString()

override string ToString ( )

inline

Returns a string that represents the current opacity value.

Returns

A string representation of the opacity value.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 86 of file Opacity.cs.

Property Documentation

Comparer

IEqualityComparer<Opacity> Comparer = new OpacityEqualityComparer()

staticget

A default equality comparer for comparing Opacity data values.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 77 of file Opacity.cs.

Maximum

uint Maximum = 100

staticget

The maximum allowed opacity value.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 49 of file Opacity.cs.

Minimum

uint Minimum = 0

staticget

The minimum allowed opacity value.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 43 of file Opacity.cs.

Value

uint Value

getset

The opacity value. Must be between 0 and 100.

Exceptions

IcvOutOfRangeException

The value is out of range.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 58 of file Opacity.cs.