VehicleGraphics3DBPlaneInstance#

class ansys.stk.core.stkobjects.VehicleGraphics3DBPlaneInstance#

An element in the VehicleGraphics3DBPlanePointCollection.

Overview#

show_graphics

Whether the B-Plane will be displayed in the 3D Graphics window.

name

Get or set the name assigned to the B-Plane.

description

Get or set the description of the B-Plane instance.

definition

Get the template from which the B-Plane is derived.

event_name

Get or set the event name, which is the point in time at which the B-Plane is defined.

event

Return the 3D BPlane Event properties.

target_point

Return the 3D BPlane Target Point properties.

show_label

Whether to display all points with their appropriate labels.

point_size

Get or set the size at which to display all points on the B-Plane. Dimensionless.

connect_additional_points

Whether to connect the additional points.

connect_points_color

Get or set the color of the lines connecting the additional points.

connect_point_line_width

Get or set the width of the lines connecting the additional points.

graphics_3d_window

Get or set the 3D Graphics windows in which the B-Plane will be displayed.

available_graphics_3d_windows

Return a list of available 3D Graphics windows.

additional_points

Return a collection of additional points.

Import detail#

from ansys.stk.core.stkobjects import VehicleGraphics3DBPlaneInstance

Property detail#

property VehicleGraphics3DBPlaneInstance.show_graphics: bool#

Whether the B-Plane will be displayed in the 3D Graphics window.

property VehicleGraphics3DBPlaneInstance.name: str#

Get or set the name assigned to the B-Plane.

property VehicleGraphics3DBPlaneInstance.description: str#

Get or set the description of the B-Plane instance.

property VehicleGraphics3DBPlaneInstance.definition: str#

Get the template from which the B-Plane is derived.

property VehicleGraphics3DBPlaneInstance.event_name: str#

Get or set the event name, which is the point in time at which the B-Plane is defined.

property VehicleGraphics3DBPlaneInstance.event: VehicleGraphics3DBPlaneEvent#

Return the 3D BPlane Event properties.

property VehicleGraphics3DBPlaneInstance.target_point: VehicleGraphics3DBPlaneTargetPoint#

Return the 3D BPlane Target Point properties.

property VehicleGraphics3DBPlaneInstance.show_label: bool#

Whether to display all points with their appropriate labels.

property VehicleGraphics3DBPlaneInstance.point_size: float#

Get or set the size at which to display all points on the B-Plane. Dimensionless.

property VehicleGraphics3DBPlaneInstance.connect_additional_points: bool#

Whether to connect the additional points.

property VehicleGraphics3DBPlaneInstance.connect_points_color: Color#

Get or set the color of the lines connecting the additional points.

property VehicleGraphics3DBPlaneInstance.connect_point_line_width: LineWidth#

Get or set the width of the lines connecting the additional points.

property VehicleGraphics3DBPlaneInstance.graphics_3d_window: str#

Get or set the 3D Graphics windows in which the B-Plane will be displayed.

property VehicleGraphics3DBPlaneInstance.available_graphics_3d_windows: list#

Return a list of available 3D Graphics windows.

property VehicleGraphics3DBPlaneInstance.additional_points: VehicleGraphics3DBPlanePointCollection#

Return a collection of additional points.