Graphics3DReferencePlane#

class ansys.stk.core.stkobjects.Graphics3DReferencePlane#

Bases: IGraphics3DReferenceAnalysisWorkbenchComponent, IDisplayTime

Class defining a reference plane (3D Graphics, Vector Geometry Tool).

Overview#

show_axis_labels

Displays labels for the selected axis. Only available for planes.

is_plane_transparent

If enabled, the plane is see-through; otherwise it is opaque. Only available for planes.

size

Get or set the size of the selected geometric plane or point. Dimensionless.

transparency

Use the slide control to set the transparency of the plane. Transparency can be adjusted from 0 to 100 percent, where 100 percent is completely invisible. Only available for planes. Dimensionless.

draw_at_object

Only available for geometric elements relating to objects. If selected, the geometric element is drawn at the central body or object.

show_rectangular_grid

If enabled the rectangle grid is visible.

show_circle_grid

If enabled the circle grid is visible.

plane_grid_spacing

Spacing between grid points. Uses Distance Dimension.

Import detail#

from ansys.stk.core.stkobjects import Graphics3DReferencePlane

Property detail#

property Graphics3DReferencePlane.show_axis_labels: bool#

Displays labels for the selected axis. Only available for planes.

property Graphics3DReferencePlane.is_plane_transparent: bool#

If enabled, the plane is see-through; otherwise it is opaque. Only available for planes.

property Graphics3DReferencePlane.size: float#

Get or set the size of the selected geometric plane or point. Dimensionless.

property Graphics3DReferencePlane.transparency: float#

Use the slide control to set the transparency of the plane. Transparency can be adjusted from 0 to 100 percent, where 100 percent is completely invisible. Only available for planes. Dimensionless.

property Graphics3DReferencePlane.draw_at_object: bool#

Only available for geometric elements relating to objects. If selected, the geometric element is drawn at the central body or object.

property Graphics3DReferencePlane.show_rectangular_grid: bool#

If enabled the rectangle grid is visible.

property Graphics3DReferencePlane.show_circle_grid: bool#

If enabled the circle grid is visible.

property Graphics3DReferencePlane.plane_grid_spacing: float#

Spacing between grid points. Uses Distance Dimension.