STK Graphics PrimitivesSend comments on this topic.
SetCartographicWithOptionalParameters Method (IAgStkGraphicsTextBatchPrimitive)
See Also
CentralBody
The central body the positions are defined on.
Positions
An array containing the new positions for each string in the text batch, provided in the order latitude, longitude, altitude.
Text
The text for strings in the text batch. Each element in this collection corresponds to a set of latitude, longitude, and altitude elements in positions.
OptionalParameters
Optional per-batch parameters or per-string parameters corresponding to positions. Each per-string parameter must have the same number of elements as positions.
Windows





Windows & Linux

Description

For convenience. Defines the positions, text, and optional parameters of strings in a text batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set.

Syntax

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

Parameters

CentralBody
The central body the positions are defined on.
Positions
An array containing the new positions for each string in the text batch, provided in the order latitude, longitude, altitude.
Text
The text for strings in the text batch. Each element in this collection corresponds to a set of latitude, longitude, and altitude elements in positions.
OptionalParameters
Optional per-batch parameters or per-string parameters corresponding to positions. Each per-string parameter must have the same number of elements as positions.

Remarks

See Set for a full discussion.

See Also

Example

Shows the format of the Text, Positions, Colors and Indices parameters when updating a text batch primitive with cartographic positions.
[C#]
Array colors = new object[]
{
    Color.Red.ToArgb(),
    Color.Green.ToArgb(),
    Color.Blue.ToArgb(),
    Color.White.ToArgb()
};

IAgStkGraphicsTextBatchPrimitiveOptionalParameters parameters = sceneManager.Initializers.TextBatchPrimitiveOptionalParameters.Initialize();
parameters.SetColors(ref colors);

Array text = new object[]
{
    "Philadelphia",
    "Washington D.C.",
    "New Orleans",
    "San Jose"
};

Array positions = new object[]
{
    39.88, -75.25, 0,    // Philadelphia
    38.85, -77.04, 0, // Washington, D.C.   
    29.98, -90.25, 0, // New Orleans
    37.37, -121.92, 0    // San Jose
};

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

textBatch.SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass(
    "Earth", 
    ref positions, 
    ref text,
    parameters, 
    ref indices,
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending,
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque);
Shows the format of the Text, Positions, Colors and Indices parameters when updating a text batch primitive with cartographic positions.
[Visual Basic .NET]
Dim colors As Array = New Object() {Color.Red.ToArgb(), Color.Green.ToArgb(), Color.Blue.ToArgb(), Color.White.ToArgb()}

Dim parameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters = sceneManager.Initializers.TextBatchPrimitiveOptionalParameters.Initialize()
parameters.SetColors(colors)

Dim text As Array = New Object() {"Philadelphia", "Washington D.C.", "New Orleans", "San Jose"}

' Philadelphia
' Washington, D.C.   
' New Orleans
	' San Jose
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 indices As Array = New Object() {0, 1, 2, 3}

textBatch.SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass("Earth", positions, text, parameters, indices, AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, _
	AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque)
© 2025 Analytical Graphics, Inc. All Rights Reserved.