Public Member Functions
None	__init__ (self, int value=MAXIMUM)
	Creates an Opacity object with a default value of 100.

int	value (self)
	Retrieve the current opacity.

bool	__eq__ (self, object other)
	Check if the Opacity object is equal to a given value.

Static Public Attributes
int	MINIMUM = 0

int	MAXIMUM = 100

Protected Attributes
int	_value = value

Detailed Description

Class representing opacity for painting operations.

Opacity indicates how much the underlying layer is hidden.

A value of 100 means that the underlying layer is completely hidden. On the other hand, 0 means that the layer is completely visible.

Since: ids_peak_icv 1.1

Definition at line 6 of file opacity.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		int	value = MAXIMUM )

Creates an Opacity object with a default value of 100.

Parameters

value (int, optional) Value of the Opacity. Defaults to maximum.

Exceptions

OutOfRangeException If the opacity value is not within the valid range.

Since: ids_peak_icv 1.1

Definition at line 20 of file opacity.py.

Member Function Documentation

◆ eq()

bool __eq__	(		self,
		object	other )

Check if the Opacity object is equal to a given value.

Parameters

other Value to compare with.

Returns: True if equal, False otherwise.

Since: ids_peak_icv 1.1

Definition at line 47 of file opacity.py.

◆ value()

int value ( self )

Retrieve the current opacity.

Returns: The current opacity value.

Since: ids_peak_icv 1.1

Definition at line 36 of file opacity.py.

Field Documentation

◆ _value

int _value = value

protected

Definition at line 33 of file opacity.py.

◆ MAXIMUM

int MAXIMUM = 100

static

Definition at line 18 of file opacity.py.

◆ MINIMUM

int MINIMUM = 0

static

Definition at line 17 of file opacity.py.

Public Member Functions

Static Public Attributes

Protected Attributes