nimphs.properties.shared

Modules

nimphs.properties.shared.file_data

class FileData

Bases: object

Base class to manage file data for all modules.

file: Union[Serafin, POpenFOAMReader] = None

File reader

Type: Union[Serafin, POpenFOAMReader]

get_point_data(_id: Union[str, int]) → ndarray

Get point data from the given id. Overridden id derived classes.

Parameters: _id (Union[str, int]) -- identifier of the variable from which to get data

module: str = ''

Name of the module

Type: str

nb_time_points: int = 0

Number of readable time points

Type: int

update_var_range(name: str, scope: str = 'LOCAL', data: Optional[Union[ndarray, tuple]] = None) → None

Update point data information (value ranges).

Parameters

name (str) -- name of the variable to update
scope (str, optional) -- indicate which information to update. Enum in ['LOCAL', 'GLOBAL']. Defaults to 'LOCAL'.
data (Union[np.ndarray, tuple, None], optional) -- data corresponding to the given variable or min / max values. Defaults to None.

vars: PointDataManager = None

Information on variables

Type: PointDataManager

nimphs.properties.shared.module_streaming_sequence_settings

class NIMPHS_ModuleStreamingSequenceSettings

Bases: PropertyGroup

Module 'streaming sequence' properties.

This data structure holds common data used in all modules.

is_custom_base_cls = True

length: None

Length of the animation.

Type: bpy.props.IntProperty

max: None

Maximum length of the sequence (available time steps).

Type: bpy.props.IntProperty

register_cls = True

shade_smooth: None

Indicate whether to use smooth shading or flat shading

Type: bpy.props.BoolProperty

start: None

Starting frame of the sequence.

Type: bpy.props.IntProperty

update: None

Update this sequence whenever the frame changes.

Type: bpy.props.BoolProperty

nimphs.properties.shared.nimphs_object

class NIMPHS_Object

Bases: PropertyGroup

Main property of the add-on for objects. This holds all Object data for the add-on.

is_custom_base_cls = False

is_mesh_sequence: None

Indicate whether this object is a mesh sequence or not.

Type: bpy.props.BoolProperty

is_streaming_sequence: None

Indicate if this object is a sequence which updates when the frame changes.

Type: bpy.props.BoolProperty

module: None

Module name

Type: bpy.props.StringProperty

register_cls = True

settings: None

Holds object settings for all modules.

Type: NIMPHS_ObjectSettings

uid: None

Unique identifier for each object of the add-on to access file_data.

Type: bpy.props.StringProperty

nimphs.properties.shared.nimphs_object_settings

class NIMPHS_ObjectSettings

Bases: PropertyGroup

Data structure which holds object related settings for all modules.

file_path: None

File to read to access data.

Type: bpy.props.StringProperty

is_custom_base_cls = False

openfoam: None

OpenFOAM object properties

Type: NIMPHS_OpenfoamObjectSettings

point_data: None

Point data settings.

Type: NIMPHS_PointDataSettings

preview_point_data: None

Name of point data to preview.

Type: bpy.props.EnumProperty

preview_time_point: None

Time step to preview.

Type: bpy.props.EnumProperty

register_cls = True

telemac: None

TELEMAC object properties

Type: NIMPHS_TelemacObjectSettings

nimphs.properties.shared.nimphs_scene

class NIMPHS_Scene

Bases: PropertyGroup

Data structure which holds all Scene data for the add-on.

file_data: dict = {'ops': None}

is_custom_base_cls = False

m_op_label: None

Label displayed on the progress bar

Type: bpy.props.StringProperty

m_op_running: None

Indicate if a modal operator is running.

Type: bpy.props.BoolProperty

m_op_value: None

Value used by the progress bar when modal operators are running

Type: bpy.props.FloatProperty

op_target: None

Target object on which extract point data.

Type: bpy.props.PointerPropery

op_vars: PointDataManager = <nimphs.properties.utils.point_data.PointDataManager object>

Place to store temporary point data information for operators.

Type: PointDataManager

register_cls = True

view_3d_ht_tool_header_draw(c)

view_3d_ht_tool_header_draw_saved: bool = False

Indicate if the draw method of VIEW_3D_HT_tool_header has already been saved.

Type: bool

update_progress_bar(_self, context: Context) → None

Update function for the custom progress bar. Tag all info areas for redraw.

Parameters: context (Context) -- context

nimphs.properties.shared.point_data_settings

class NIMPHS_PointDataSettings

Bases: PropertyGroup

Holds data for point data management in all modules.

import_data: None

Import point data as vertex color.

Type: bpy.props.BoolProperty

is_custom_base_cls = False

list: None

List of point data to import as vertex color.

Type: bpy.props.StringProperty

register_cls = True

remap_method: None

Indicate whether point data should be remapped using local or global value ranges.

Type: bpy.props.EnumProperty

save: None

Save of variables information.

Type: bpy.props.StringProperty