STK Graphics PrimitivesSend comments on this topic.
SetCartographicWithColorsAndOptionalParameters Method (IAgStkGraphicsPolylinePrimitive)
See Also
CentralBody
The central body the positions are defined on.
Positions
An array containing new positions for the polyline, provided in the order latitude, longitude, altitude.
Colors
An array containing the numeric representation of colors for the polyline. There must be one color for each position in positions. The first color is ignored, each additional color defines the color of the line segment ending at that position. In .NET a Color should be translated to a number by calling its ToArgb method and casting the result as an unsigned integer.
OptionalParameters
Optional parameters corresponding to positions. Each optional property must have the same number of elements as positions.
Windows





Windows & Linux

Description

For convenience. Defines the positions, colors, and/or optional point properties of a polyline using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set.

Syntax

[Visual Basic .NET]
Public Sub SetCartographicWithColorsAndOptionalParameters( _
    ByVal CentralBody As String, _
    ByVal Positions As System.Array, _
    ByVal Colors As System.Array, _
    ByVal OptionalParameters As IAgStkGraphicsPolylinePrimitiveOptionalParameters _
)
[C#]
public void SetCartographicWithColorsAndOptionalParameters(
    string CentralBody,
    System.Array Positions,
    System.Array Colors,
    IAgStkGraphicsPolylinePrimitiveOptionalParameters OptionalParameters
);
[Managed C++]
public: void SetCartographicWithColorsAndOptionalParameters(
    String __gc ^ CentralBody,
    System::Array ^ Positions,
    System::Array ^ Colors,
    IAgStkGraphicsPolylinePrimitiveOptionalParameters ^ OptionalParameters
);
[Unmanaged C++]
public: HRESULT SetCartographicWithColorsAndOptionalParameters(
    BSTR CentralBody,
    SAFEARRAY * * Positions,
    SAFEARRAY * * Colors,
    IAgStkGraphicsPolylinePrimitiveOptionalParameters * OptionalParameters
);
[Java]
public void setCartographicWithColorsAndOptionalParameters(
    String CentralBody,
    AgSafeArray Positions,
    AgSafeArray Colors,
    IAgStkGraphicsPolylinePrimitiveOptionalParameters OptionalParameters
);
[Python - STK API ]
def SetCartographicWithColorsAndOptionalParameters(self, CentralBody:str, Positions:list, Colors:list, OptionalParameters:"IAgStkGraphicsPolylinePrimitiveOptionalParameters") -> None:

Parameters

CentralBody
The central body the positions are defined on.
Positions
An array containing new positions for the polyline, provided in the order latitude, longitude, altitude.
Colors
An array containing the numeric representation of colors for the polyline. There must be one color for each position in positions. The first color is ignored, each additional color defines the color of the line segment ending at that position. In .NET a Color should be translated to a number by calling its ToArgb method and casting the result as an unsigned integer.
OptionalParameters
Optional parameters corresponding to positions. Each optional property must have the same number of elements as positions.

Remarks

See Set for a full discussion.

See Also

© 2025 Analytical Graphics, Inc. All Rights Reserved.