VehicleGraphics2DTimeComponentsEventCollectionElement

class ansys.stk.core.stkobjects.VehicleGraphics2DTimeComponentsEventCollectionElement

Bases: IVehicleGraphics2DTimeComponentsElement

Provide properties to configure the vehicle’s appearance in 2D and 3D views. The interface is used with event interval collections only.

Overview

Methods

get_time_component

Return an instance of a time component which provides the time intervals to control the appearance and visibility of the graphics path. The method may throw an exception if the component is invalid.

Properties

use_color_ramp	Whether the color ramp is used. Setting this property has no effect if the color ramp is not supported.
color_ramp_start_color	The start color of the color ramp. Setting this property has no effect if the color ramp is not supported.
color_ramp_end_color	The end color of the color ramp. Setting this property has no effect if the color ramp is not supported.
umbra	Configure the appearance of the orbit track, the marker, etc. when the vehicle isn’t in sunlight at all.
penumbra	Configure the appearance of the orbit track, the marker, etc. when the vehicle is only partially in sunlight.
sunlight	Configure the appearance of the orbit track, the marker, etc. when the vehicle is in complete sunlight.

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics2DTimeComponentsEventCollectionElement

Property detail

property VehicleGraphics2DTimeComponentsEventCollectionElement.use_color_ramp: bool

Whether the color ramp is used. Setting this property has no effect if the color ramp is not supported.

property VehicleGraphics2DTimeComponentsEventCollectionElement.color_ramp_start_color: Color

The start color of the color ramp. Setting this property has no effect if the color ramp is not supported.

property VehicleGraphics2DTimeComponentsEventCollectionElement.color_ramp_end_color: Color

The end color of the color ramp. Setting this property has no effect if the color ramp is not supported.

property VehicleGraphics2DTimeComponentsEventCollectionElement.umbra: IVehicleGraphics2DAttributesBasic

Configure the appearance of the orbit track, the marker, etc. when the vehicle isn’t in sunlight at all.

property VehicleGraphics2DTimeComponentsEventCollectionElement.penumbra: IVehicleGraphics2DAttributesBasic

Configure the appearance of the orbit track, the marker, etc. when the vehicle is only partially in sunlight.

property VehicleGraphics2DTimeComponentsEventCollectionElement.sunlight: IVehicleGraphics2DAttributesBasic

Configure the appearance of the orbit track, the marker, etc. when the vehicle is in complete sunlight.

Method detail

VehicleGraphics2DTimeComponentsEventCollectionElement.get_time_component(self) → IAnalysisWorkbenchComponent

Return an instance of a time component which provides the time intervals to control the appearance and visibility of the graphics path. The method may throw an exception if the component is invalid.

Returns:

IAnalysisWorkbenchComponent