nimphs.panels

Packages

• nimphs.panels.openfoam
• nimphs.panels.shared
• nimphs.panels.telemac

Modules

nimphs.panels.installer

class NIMPHS_InstallerAddonPreferences

Bases: AddonPreferences

UI panel to manage dependencies installation of the add-on.

bl_idname: Union[str, Any] = 'nimphs'

typing.Union[str, typing.Any]

Type

type

draw(context: Context) → None

UI layout of this panel.

Parameters

context (Context) -- context

is_custom_base_cls = False

register_cls = False

settings: None

nimphs.panels.preferences

class NIMPHS_Preferences

Bases: AddonPreferences

UI panel to manage add-on's preferences.

bl_idname: Union[str, Any] = 'nimphs'

typing.Union[str, typing.Any]

Type

type

draw(context: Context) → None

UI layout of this panel.

Parameters

context (Context) -- context

is_custom_base_cls = False

register_cls = True

settings: None

nimphs.panels.utils

draw_point_data(layout: UILayout, point_data: NIMPHS_PointDataSettings, show_remap: bool = True, show_range: bool = True, edit: bool = True, src: str = 'OBJECT') → None

Draw point data settings.

Parameters

• layout (UILayout) -- layout

• point_data (NIMPHS_PointDataSettings) -- point data settings

• src (str) -- which source is calling this function. Enum in ['OBJECT', 'OPERATOR'].

• show_remap (bool, optional) -- show remap method option. Defaults to True.

• show_range (bool, optional) -- show value ranges of selected point data. Defaults to True.

• edit (bool, optional) -- show edit buttons. Defaults to True.

get_selected_object(context: Context) → Optional[Object]

Return the selected object. If a child of the main module object is selected, return its parent.

Parameters

context (Context) -- context

Returns

selected object

Return type

Union[Object, None]