PolylinePrimitiveFactory

class ansys.stk.core.graphics.PolylinePrimitiveFactory

Render a polyline in the 3D scene. Each line segment may have a different color. A polyline can be constructed with a position interpolator to render great arcs or rhumb lines.

Overview

Methods

initialize	Initialize a default polyline primitive. This is equivalent to constructing a polyline with a set hint of Frequent and a polyline type of LineStrip.
initialize_with_interpolator_and_set_hint	Initialize a polyline primitive with the specified interpolator and setHint.
initialize_with_type_and_hint	Initialize a new instance of a polyline primitive with the specified polylineType and setHint.
initialize_with_interpolator	Initialize a polyline primitive with the specified interpolator. This is equivalent to constructing a polyline with the specified interpolator and a set hint of Frequent.
initialize_with_hint	Initialize a new instance of a polyline primitive with the specified set hint. This is equivalent to constructing a polyline with a polyline type of LineStrip and the specified set hint.
initialize_with_type	Initialize a polyline primitive with the specified polylineType. This is equivalent to constructing a polyline with the specified polylineType and a set hint of Frequent.

Properties

minimum_width_supported	Get the minimum width, in pixels, supported by the video card.
maximum_width_supported	Get the maximum width, in pixels, supported by the video card.

Import detail

from ansys.stk.core.graphics import PolylinePrimitiveFactory

Property detail

property PolylinePrimitiveFactory.minimum_width_supported: float

Get the minimum width, in pixels, supported by the video card.

property PolylinePrimitiveFactory.maximum_width_supported: float

Get the maximum width, in pixels, supported by the video card.

Method detail

PolylinePrimitiveFactory.initialize(self) → PolylinePrimitive

Initialize a default polyline primitive. This is equivalent to constructing a polyline with a set hint of Frequent and a polyline type of LineStrip.

Returns:

PolylinePrimitive

PolylinePrimitiveFactory.initialize_with_interpolator_and_set_hint(self, interpolator: IPositionInterpolator, set_hint: SetHint) → PolylinePrimitive

Initialize a polyline primitive with the specified interpolator and setHint.

Parameters:

interpolator : IPositionInterpolator

set_hint : SetHint

Returns:

PolylinePrimitive

PolylinePrimitiveFactory.initialize_with_type_and_hint(self, polyline_type: PolylineType, set_hint: SetHint) → PolylinePrimitive

Initialize a new instance of a polyline primitive with the specified polylineType and setHint.

Parameters:

polyline_type : PolylineType

set_hint : SetHint

Returns:

PolylinePrimitive

PolylinePrimitiveFactory.initialize_with_interpolator(self, interpolator: IPositionInterpolator) → PolylinePrimitive

Initialize a polyline primitive with the specified interpolator. This is equivalent to constructing a polyline with the specified interpolator and a set hint of Frequent.

Parameters:

interpolator : IPositionInterpolator

Returns:

PolylinePrimitive

PolylinePrimitiveFactory.initialize_with_hint(self, set_hint: SetHint) → PolylinePrimitive

Initialize a new instance of a polyline primitive with the specified set hint. This is equivalent to constructing a polyline with a polyline type of LineStrip and the specified set hint.

Parameters:

set_hint : SetHint

Returns:

PolylinePrimitive

PolylinePrimitiveFactory.initialize_with_type(self, polyline_type: PolylineType) → PolylinePrimitive

Initialize a polyline primitive with the specified polylineType. This is equivalent to constructing a polyline with the specified polylineType and a set hint of Frequent.

Parameters:

polyline_type : PolylineType

Returns:

PolylinePrimitive