Skip to content

HandleParameterData

Implementation of the data class for the handle parameter data.

HandleParameterData dataclass

Canonical path: HandleParameterData.HandleParameterData

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 ( , default: True ) –

    Add an input field for the value input

  • show_negative_value ( , default: False ) –

    Show a negative value in the input field

  • check_box_state ( , default: True ) –

    State of the checkbox

  • in_decrement_value ( , default: 1 ) –

    Value for the increment or decrement button, can be int, float, Point3D, ...

  • list_index ( , default: None ) –

    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]

  • distance_factor ( , default: None ) –

    Factor for the distance

  • dir_vector ( , default: None ) –

    direction vector in case of VECTOR_DISTANCE

  • show_input_field_always (bool, default: False ) –

    show the input field always

  • input_field_above ( , default: True ) –

    input field above the dimension line

Placeholder