AGI STK Graphics 11Send comments on this topic.
SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass Method (IAgStkGraphicsTextBatchPrimitive)
See Also
CentralBody
The central body the positions are defined on.
Positions
An array containing new positions used to update a subset of positions in the text batch, provided in the order latitude, longitude, altitude.
Text
A collection of new text used to update a subset of text in the text batch.
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.
Indices
An array of integers containing the indices into positions. A set of latitude, longitude, and altitude elements is considered a single index.
IndicesOrderHint
RenderPassHint
An optimization hint indicating the Render Pass implied by per-marker colors defined in optionalParameters.
Windows






Windows & Linux

Description

For convenience. Updates a subset of positions, text, and/or per-string parameters in a text batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling Set Partial.

Syntax

[Visual Basic .NET]
Public Sub SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass( _
    ByVal CentralBody As String, _
    ByVal Positions As System.Array, _
    ByVal Text As System.Array, _
    ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _
    ByVal Indices As System.Array, _
    ByVal IndicesOrderHint As AgEStkGraphicsIndicesOrderHint, _
    ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
) As
[C#]
public void SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass(
    string CentralBody,
    System.Array Positions,
    System.Array Text,
    IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters,
    System.Array Indices,
    AgEStkGraphicsIndicesOrderHint IndicesOrderHint,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Managed C++]
public: void SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass(
    String __gc ^ CentralBody,
    System::Array ^ Positions,
    System::Array ^ Text,
    IAgStkGraphicsTextBatchPrimitiveOptionalParameters ^ OptionalParameters,
    System::Array ^ Indices,
    AgEStkGraphicsIndicesOrderHint IndicesOrderHint,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Java]
public void setPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass(
    String CentralBody,
    VariantArray Positions,
    VariantArray Text,
    IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters,
    VariantArray Indices,
    AgEStkGraphicsIndicesOrderHint IndicesOrderHint,
    AgEStkGraphicsRenderPassHint RenderPassHint
);
[Unmanaged C++]
public: HRESULT SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass(
    BSTR CentralBody,
    SAFEARRAY * * Positions,
    SAFEARRAY * * Text,
    IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters,
    SAFEARRAY * * Indices,
    AgEStkGraphicsIndicesOrderHint IndicesOrderHint,
    AgEStkGraphicsRenderPassHint RenderPassHint
);

Parameters

CentralBody
The central body the positions are defined on.
Positions
An array containing new positions used to update a subset of positions in the text batch, provided in the order latitude, longitude, altitude.
Text
A collection of new text used to update a subset of text in the text batch.
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.
Indices
An array of integers containing the indices into positions. A set of latitude, longitude, and altitude elements is considered a single index.
IndicesOrderHint
RenderPassHint
An optimization hint indicating the Render Pass implied by per-marker colors defined in optionalParameters.

Remarks

See Set Partial 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)
© 2019 Analytical Graphics, Inc. All Rights Reserved.