nimphs.panels.telemac
Modules
nimphs.panels.telemac.telemac_main_panel
- class NIMPHS_PT_TelemacMainPanel
Bases:
NIMPHS_ModulePanelMain panel of the TELEMAC module.
- bl_category: Union[str, Any] = 'TELEMAC'
The category (tab) in which the panel will be displayed, when applicable
- Type
Union[str, Any]
- bl_idname: Union[str, Any] = 'NIMPHS_PT_TelemacMainPanel'
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] = 'TELEMAC'
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_CLOSEDDefault Closed -- Defines if the panel has to be open or collapsed at the time of its creation. *HIDE_HEADERHide 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). *INSTANCEDInstanced 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_EXPANDExpand 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.telemac.telemac_mesh_sequence
- class NIMPHS_PT_TelemacMeshSequence
Bases:
PanelUI panel for TELEMAC 'mesh 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_TelemacMeshSequence'
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] = 'TELEMAC Mesh 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.telemac.telemac_streaming_sequence
- class NIMPHS_PT_TelemacStreamingSequence
Bases:
NIMPHS_StreamingSequenceSettingsPanelMain panel of the TELEMAC '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_TelemacStreamingSequence'
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] = 'TELEMAC 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