VehicleGraphics3DBPlaneTemplate#

class ansys.stk.core.stkobjects.VehicleGraphics3DBPlaneTemplate#

An element of VehicleGraphics3DBPlaneTemplatesCollection.

Overview#

name

Get or set the name of the template.

description

Get or set the description of the template.

central_body

Get or set the template’s central body.

available_central_bodies

Get a list of available central bodies.

reference_vector

Get or set the template’s reference vector.

available_vectors

Get a list of available vectors.

show_cartesian_grid

Whether the Cartesian grid is displayed with the template.

show_polar_grid

Whether the Polar grid is displayed with the template.

grid_spacing

Get or set the distance between grid lines. Uses Distance Dimension.

display_elements

Return the 3D BPlane template display collection.

Import detail#

from ansys.stk.core.stkobjects import VehicleGraphics3DBPlaneTemplate

Property detail#

property VehicleGraphics3DBPlaneTemplate.name: str#

Get or set the name of the template.

property VehicleGraphics3DBPlaneTemplate.description: str#

Get or set the description of the template.

property VehicleGraphics3DBPlaneTemplate.central_body: str#

Get or set the template’s central body.

property VehicleGraphics3DBPlaneTemplate.available_central_bodies: list#

Get a list of available central bodies.

property VehicleGraphics3DBPlaneTemplate.reference_vector: str#

Get or set the template’s reference vector.

property VehicleGraphics3DBPlaneTemplate.available_vectors: list#

Get a list of available vectors.

property VehicleGraphics3DBPlaneTemplate.show_cartesian_grid: bool#

Whether the Cartesian grid is displayed with the template.

property VehicleGraphics3DBPlaneTemplate.show_polar_grid: bool#

Whether the Polar grid is displayed with the template.

property VehicleGraphics3DBPlaneTemplate.grid_spacing: float#

Get or set the distance between grid lines. Uses Distance Dimension.

property VehicleGraphics3DBPlaneTemplate.display_elements: VehicleGraphics3DBPlaneTemplateDisplayCollection#

Return the 3D BPlane template display collection.