GeomObjectPlot#

class ansys.geometry.core.plotting.plotting_types.GeomObjectPlot(actor: pyvista.Actor, object: beartype.typing.Any, edges: beartype.typing.List[EdgePlot] = None, add_body_edges: bool = True)#

Mapper class to relate PyAnsys Geometry objects with its PyVista actor.

Parameters:
actorpv.Actor

PyVista actor that represents the pyansys-geometry object.

objectAny

PyAnsys Geometry object that is represented.

edgesList[EdgePlot], optional

List of edges of the PyAnsys Geometry object, by default None.

add_body_edges: bool, optional

Flag to specify if you want to be able to add edges.

Overview#

actor

Return the PyVista actor of the PyAnsys Geometry object.

object

Return the PyAnsys Geometry object.

edges

Return the list of edges associated to this PyAnsys Geometry object.

name

Return the name of this object.

add_body_edges

Return whether you want to be able to add edges.

Import detail#

from ansys.geometry.core.plotting.plotting_types import GeomObjectPlot

Property detail#

property GeomObjectPlot.actor: pyvista.Actor#

Return the PyVista actor of the PyAnsys Geometry object.

Returns:
Actor

Actor of the PyAnsys Geometry object.

property GeomObjectPlot.object: beartype.typing.Any#

Return the PyAnsys Geometry object.

Returns:
Any

PyAnsys Geometry object.

property GeomObjectPlot.edges: beartype.typing.List[EdgePlot]#

Return the list of edges associated to this PyAnsys Geometry object.

Returns:
List[EdgePlot]

List of the edges of this object.

property GeomObjectPlot.name: str#

Return the name of this object.

Returns:
str

Name of the object.

property GeomObjectPlot.add_body_edges: bool#

Return whether you want to be able to add edges.

Returns:
bool

Flag to add edges.