Description

Defines the positions for a polyline primitive. The polyline is rendered in its Reference Frame.

Syntax

[Visual Basic .NET]
Public Sub Set( _ ByVal Positions As System.Array _ )

[C#]
public void Set( System.Array Positions );

[Managed C++]
public: void Set( System::Array ^ Positions );

[Unmanaged C++]
public: HRESULT Set( SAFEARRAY * * Positions );

[Java]
public void set( AgSafeArray Positions );

[Python - STK API ]
def Set(self, Positions:list) -> None:

Parameters

Positions: An array containing the new positions (in the order x, y, z) for the polyline.

Remarks

This call overwrites the primitive's previous positions and per-position colors. To update a subset of positions, use SetPartial.

If the polyline's Position Interpolator is not null, positions are interpolated before they are rendered. If the polyline's Polyline Type is LineStrip, for each position after the first position, a line segment is rendered that connects the position to the previous position. Otherwise, if Lines is used, a line segment is rendered for every two positions.

Each line segment is rendered with the same color and translucency, which is defined by the primitive's Color and Translucency properties.

Example

Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive.

[C#]

Array positions = new object[]
{
    1247.87, -4739.74, 4067.77,
    1115.48, -4847.09, 3979.36,   
    -24.12, -5529.31, 3168.45,
    -2683.42, -4307.74, 3850.11
};

Array colors = new object[]
{
    Color.Red.ToArgb(),
    Color.Green.ToArgb(),
    Color.Blue.ToArgb(),
    Color.White.ToArgb()
};

Array indices = new object[]
{
    0,
    1,
    2,
    3
};

polyline.SetPartialWithColorsIndicesOrderAndRenderPassHint(
    ref positions, 
    ref colors, 
    ref indices,
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending,
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque);