Handle parameter data

The handle parameter data are used in the HandleProperties class to connect the PythonPart parameter property with the defined handle action.

class HandleParameterData.HandleParameterData(param_prop_name: str,
                                               param_type: HandleParameterType,
                                               has_input_field: bool = True,
                                               show_negative_value: bool = False,
                                               check_box_state: bool = True,
                                               in_decrement_value: Any = 1,
                                               list_index: Optional[Union[int, List[int]]] = None)

Bases: object

The parameter data are used to define the recalculation of the parameter property assigned to the handle. The recalculation is performed depending on the defined parameter type.

Parameters

• param_prop_name – Name of the parameter property

• parameter_type – Type of the parameter

• has_input_field – Add an input field for the value input

• show_negative_value – Show a negative value in the input field

• check_box_state – State of the checkbox

• in_decrement_value – Value for the increment or decrement button, can be int, float, Point3D, …

• list_index – List index assigned to the handle, necessary if the parameter property is a list. In case of an n-dimensional list the index must be defined as list like [1,2,3]

__eq__(other)

Return self==value.

__init__(param_prop_name: str,
         param_type: HandleParameterType,
         has_input_field: bool = True,
         show_negative_value: bool = False,
         check_box_state: bool = True,
         in_decrement_value: Any = 1,
         list_index: Optional[Union[int, List[int]]] = None)

Initialize self. See help(type(self)) for accurate signature.

__repr__()

Return repr(self).

__module__ = 'HandleParameterData'

check_box_state: bool = True

has_input_field: bool = True

in_decrement_value: Any = 1

list_index: Optional[Union[int, List[int]]] = None

param_prop_name: str

param_type: HandleParameterType

show_negative_value: bool = False