Skip to content

Scene

Module: xfea.viewers.scene.scene

Legend(title: str, min_value: float, max_value: float, cmap: str)

Legend(title: str, min_value: float, max_value: float, cmap: str)

LineObject(
    name: str | None = None,
    props: VisualProps = <factory>,
    segments: list[tuple[tuple[float, float, float], tuple[float, float, float]]] = <factory>,
)

LineObject(name: Optional[str] = None, props: xfea.viewers.scene.props.VisualProps = <factory>, segments: List[Tuple[Tuple[float, float, float], Tuple[float, float, float]]] = <factory>)

MeshObject(
    name: str | None = None,
    props: VisualProps = <factory>,
    vertices: list[tuple[float, float, float]] = <factory>,
    faces: list[list[int]] = <factory>,
    vertex_colors: list[tuple[float, float, float]] | None = None,
    show_lines: bool | None = None,
    feature_edges: bool | None = None,
)

MeshObject(name: Optional[str] = None, props: xfea.viewers.scene.props.VisualProps = <factory>, vertices: List[Tuple[float, float, float]] = <factory>, faces: List[List[int]] = <factory>, vertex_colors: Optional[List[Tuple[float, float, float]]] = None, show_lines: Optional[bool] = None, feature_edges: Optional[bool] = None)

PointCloud(
    name: str | None = None,
    props: VisualProps = <factory>,
    points: list[tuple[float, float, float]] = <factory>,
)

PointCloud(name: Optional[str] = None, props: xfea.viewers.scene.props.VisualProps = <factory>, points: List[Tuple[float, float, float]] = <factory>)

Scene(
    objects: list[SceneObject] = <factory>,
    legends: list[Legend] = <factory>,
    metadata: dict = <factory>,
)

Scene(objects: List[xfea.viewers.scene.scene.SceneObject] = <factory>, legends: List[xfea.viewers.scene.scene.Legend] = <factory>, metadata: dict = <factory>)

Methods
add(obj)
add(obj: SceneObject)

No docstring available.

SceneObject(name: str | None = None, props: VisualProps = <factory>)

SceneObject(name: Optional[str] = None, props: xfea.viewers.scene.props.VisualProps = <factory>)

TextLabel(
    name: str | None = None,
    props: VisualProps = <factory>,
    text: str = '',
    position: tuple[float, float, float] = (0.0, 0.0, 0.0),
)

TextLabel(name: Optional[str] = None, props: xfea.viewers.scene.props.VisualProps = <factory>, text: str = ‘’, position: Tuple[float, float, float] = (0.0, 0.0, 0.0))

Module: xfea.viewers.scene.settings

ViewerSettings(
    scale: float = 1.0,
    show_nodes: bool = False,
    show_result_vectors: bool = True,
    show_result_contours: bool = True,
    results_map_mode: str = 'node',
    use_boundary_mesh: bool = True,
    adaptive_simplification: bool = True,
    geometry_cache_enabled: bool = True,
    results_cache_enabled: bool = True,
    large_scene_vertex_threshold: int = 50000,
    large_scene_object_threshold: int = 1000,
    prefer_boundary_mesh_for_large_scenes: bool = True,
    log_timings: bool = False,
    debug_timings: bool = False,
    results_notation: str | None = None,
    results_decimals: int | None = None,
    show_deformed: bool = False,
    model: VisualProps = <factory>,
    nodes: VisualProps = <factory>,
    bcs: VisualProps = <factory>,
    loads: VisualProps = <factory>,
    springs: VisualProps = <factory>,
    rigid: VisualProps = <factory>,
    results: VisualProps = <factory>,
)

ViewerSettings(scale: float = 1.0, show_nodes: bool = False, show_result_vectors: bool = True, show_result_contours: bool = True, results_map_mode: str = ‘node’, use_boundary_mesh: bool = True, adaptive_simplification: bool = True, geometry_cache_enabled: bool = True, results_cache_enabled: bool = True, large_scene_vertex_threshold: int = 50000, large_scene_object_threshold: int = 1000, prefer_boundary_mesh_for_large_scenes: bool = True, log_timings: bool = False, debug_timings: bool = False, results_notation: str | None = None, results_decimals: int | None = None, show_deformed: bool = False, model: xfea.viewers.scene.props.VisualProps = <factory>, nodes: xfea.viewers.scene.props.VisualProps = <factory>, bcs: xfea.viewers.scene.props.VisualProps = <factory>, loads: xfea.viewers.scene.props.VisualProps = <factory>, springs: xfea.viewers.scene.props.VisualProps = <factory>, rigid: xfea.viewers.scene.props.VisualProps = <factory>, results: xfea.viewers.scene.props.VisualProps = <factory>)

Module: xfea.viewers.scene.props

VisualProps(
    color: tuple[float, float, float] | None = None,
    opacity: float | None = None,
    line_width: float | None = None,
    point_size: float | None = None,
    cmap: str | None = None,
    value_range: tuple[float, float] | None = None,
    out_of_range_color: tuple[float, float, float] | None = None,
    under_range_color: tuple[float, float, float] | None = None,
    over_range_color: tuple[float, float, float] | None = None,
)

VisualProps(color: Optional[Tuple[float, float, float]] = None, opacity: Optional[float] = None, line_width: Optional[float] = None, point_size: Optional[float] = None, cmap: Optional[str] = None, value_range: Optional[Tuple[float, float]] = None, out_of_range_color: Optional[Tuple[float, float, float]] = None, under_range_color: Optional[Tuple[float, float, float]] = None, over_range_color: Optional[Tuple[float, float, float]] = None)

Module: xfea.viewers.scene.deform

Deformer(*args, **kwargs)

Apply displacement vectors to point data.

Methods
apply(points, vectors, scale)→list[tuple[float, float, float]]
apply(
    points: Iterable[tuple[float, float, float]],
    vectors: Iterable[tuple[float, float, float]],
    scale: float,
) -> list[tuple[float, float, float]]

No docstring available.

© 2026 Francesco Ranaudo · Text and pictures CC BY 4.0 · Code Elastic License 2.0 · how to reuse them