nimphs.panels.openfoam

Modules

nimphs.panels.openfoam.openfoam_main_panel

class NIMPHS_PT_OpenfoamMainPanel

Bases: NIMPHS_ModulePanel

Main panel of the OpenFOAM module.

bl_category: Union[str, Any] = 'OpenFOAM'

The category (tab) in which the panel will be displayed, when applicable

Type

Union[str, Any]

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

If this is set, the panel gets a custom ID, otherwise it takes the name of the class used to define the panel. For example, if the class name is "OBJECT_PT_hello", and bl_idname is not set by the script, then bl_idname = "OBJECT_PT_hello"

Type

Union[str, Any]

bl_label: Union[str, Any] = 'OpenFOAM'

The panel label, shows up in the panel header at the right of the triangle used to collapse the panel

Type

Union[str, Any]

bl_options: Union[Set[str], Set[int]] = {'HEADER_LAYOUT_EXPAND'}

Options for this panel type * DEFAULT_CLOSED Default Closed -- Defines if the panel has to be open or collapsed at the time of its creation. * HIDE_HEADER Hide Header -- If set to False, the panel shows a header, which contains a clickable arrow to collapse the panel and the label (see bl_label). * INSTANCED Instanced Panel -- Multiple panels with this type can be used as part of a list depending on data external to the UI. Used to create panels for the modifiers and other stacks. * HEADER_LAYOUT_EXPAND Expand Header Layout -- Allow buttons in the header to stretch and shrink to fill the entire layout width.

Type

Union[Set[str], Set[int]]

bl_region_type: Union[str, int] = 'UI'

The region where the panel is going to be used in

Type

Union[str, int]

bl_space_type: Union[str, int] = 'VIEW_3D'

The space where the panel is going to be used in

Type

Union[str, int]

draw(context: Context) → None

Layout of the panel.

Parameters

context (Context) -- context

is_custom_base_cls = False
register_cls = True

nimphs.panels.openfoam.openfoam_streaming_sequence

class NIMPHS_PT_OpenfoamStreamingSequence

Bases: NIMPHS_StreamingSequenceSettingsPanel

Main panel of the OpenFOAM 'streaming sequence' settings.

bl_context: Union[str, Any] = 'object'

explain the possible combinations bl_context/bl_region_type/bl_space_type)

Type

Union[str, Any]

Type

The context in which the panel belongs to. (TODO

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

If this is set, the panel gets a custom ID, otherwise it takes the name of the class used to define the panel. For example, if the class name is "OBJECT_PT_hello", and bl_idname is not set by the script, then bl_idname = "OBJECT_PT_hello"

Type

Union[str, Any]

bl_label: Union[str, Any] = 'OpenFOAM Streaming sequence'

The panel label, shows up in the panel header at the right of the triangle used to collapse the panel

Type

Union[str, Any]

bl_region_type: Union[str, int] = 'WINDOW'

The region where the panel is going to be used in

Type

Union[str, int]

bl_space_type: Union[str, int] = 'PROPERTIES'

The space where the panel is going to be used in

Type

Union[str, int]

draw(context: Context) → None

Layout of the panel.

Parameters

context (Context) -- context

is_custom_base_cls = False
classmethod poll(context: Context) → bool

If false, hides the panel.

Parameters

context (Context) -- context

Returns

state

Return type

bool

register_cls = True

nimphs.panels.openfoam.utils

draw_clip_settings(layout: UILayout, clip: NIMPHS_OpenfoamClipProperty, enable: bool = True) → None

Draw OpenFOAM clip settings.

Parameters