STK Graphics PrimitivesSend comments on this topic.
SetCartographicWithColorsAndHint 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.
RenderPassHint
Windows





Windows & Linux

Description

For convenience. Defines the positions and colors of a polyline using Cartographic positions. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to Cartesian and calling Set.

Syntax

[Visual Basic .NET]
Public Sub SetCartographicWithColorsAndHint( _
    ByVal CentralBody As String, _
    ByVal Positions As System.Array, _
    ByVal Colors As System.Array, _
    ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)
[C#]
public void SetCartographicWithColorsAndHint(
    string CentralBody,
    System.Array Positions,
    System.Array Colors,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Managed C++]
public: void SetCartographicWithColorsAndHint(
    String __gc ^ CentralBody,
    System::Array ^ Positions,
    System::Array ^ Colors,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Unmanaged C++]
public: HRESULT SetCartographicWithColorsAndHint(
    BSTR CentralBody,
    SAFEARRAY * * Positions,
    SAFEARRAY * * Colors,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Java]
public void setCartographicWithColorsAndHint(
    String CentralBody,
    AgSafeArray Positions,
    AgSafeArray Colors,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Python - STK API ]
def SetCartographicWithColorsAndHint(self, CentralBody:str, Positions:list, Colors:list, RenderPassHint:"AgEStkGraphicsRenderPassHint") -> 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.
RenderPassHint

Remarks

See Set for a full discussion.

See Also

Example

Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive with cartographic positions.
[C#]
Array positions = new object[]
{
    39.88, -75.25, 0,
    38.85, -77.04, 0,   
    29.98, -90.25, 0,
    37.37, -121.92, 0
};

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.SetPartialCartographicWithColorsIndicesOrderAndRenderPass(
    "Earth", 
    ref positions, 
    ref colors, 
    ref indices,
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending,
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque);
Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive with cartographic positions.
[Visual Basic .NET]
Dim positions As Array = New Object() {39.88, -75.25, 0, 38.85, -77.04, 0, _
	29.98, -90.25, 0, 37.37, -121.92, 0}

Dim colors As Array = New Object() {Color.Red.ToArgb(), Color.Green.ToArgb(), Color.Blue.ToArgb(), Color.White.ToArgb()}

Dim indices As Array = New Object() {0, 1, 2, 3}

polyline.SetPartialCartographicWithColorsIndicesOrderAndRenderPass("Earth", positions, colors, indices, AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque)
© 2024 Analytical Graphics, Inc. All Rights Reserved.