MeshObjectPlot

class ansys.tools.visualization_interface.types.mesh_object_plot.MeshObjectPlot(custom_object: beartype.typing.Any, mesh: beartype.typing.Union[pyvista.PolyData, pyvista.MultiBlock], actor: pyvista.Actor = None, edges: beartype.typing.List[ansys.tools.visualization_interface.types.edge_plot.EdgePlot] = None)

Relates a custom object with a mesh, provided by the consumer library.

Overview

Properties

mesh	Mesh of the object in PyVista format.
custom_object	Custom object.
actor	PyVista actor of the object in the plotter.
edges	Edges of the object.
name	Name of the object.

Import detail

from ansys.tools.visualization_interface.types.mesh_object_plot import MeshObjectPlot

Property detail

property MeshObjectPlot.mesh: beartype.typing.Union[pyvista.PolyData, pyvista.MultiBlock]

Mesh of the object in PyVista format.

Returns:

Union[pv.PolyData, pv.MultiBlock]

Mesh of the object.

property MeshObjectPlot.custom_object: beartype.typing.Any

Custom object.

Returns:

Any

Custom object.

property MeshObjectPlot.actor: pyvista.Actor

PyVista actor of the object in the plotter.

Returns:

pv.Actor

PyVista actor of the object.

property MeshObjectPlot.edges: beartype.typing.List[ansys.tools.visualization_interface.types.edge_plot.EdgePlot]

Edges of the object.

Returns:

List[EdgePlot]

Edges of the object.

property MeshObjectPlot.name: str

Name of the object.

Returns:

str

Name of the object.