AGI STK Graphics 11Send comments on this topic.
SetCartographicWithOptionalParametersAndRenderPass Method (IAgStkGraphicsTextBatchPrimitive)
See Also  Example
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.
RenderPassHint
An optimization hint indicating the Render Pass implied by per-strings colors defined in optionalParameters.
Windows






Windows & Linux

Description

For convenience. Defines the positions, text, and optional parameters of strings 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.

Syntax

[Visual Basic .NET]
Public Sub SetCartographicWithOptionalParametersAndRenderPass( _
   ByVal CentralBody As String, _
   ByRef Positions As System.Array, _
   ByRef Text As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)
[C#]
public void SetCartographicWithOptionalParametersAndRenderPass(
   string CentralBody, 
   ref System.Array Positions, 
   ref System.Array Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);
[Managed C++]
public: void SetCartographicWithOptionalParametersAndRenderPass(
   String __gc ^ CentralBody, 
   System::Array ^^ Positions, 
   System::Array ^^ Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters ^ OptionalParameters, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);
[Java]
public  setCartographicWithOptionalParametersAndRenderPass(
   String CentralBody, 
   Object[] Positions, 
   Object[] Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);
[Unmanaged C++]
public: HRESULT SetCartographicWithOptionalParametersAndRenderPass(
   BSTR CentralBody, 
   SAFEARRAY ** Positions, 
   SAFEARRAY ** Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);

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.
RenderPassHint
MemberValueDescription
eStkGraphicsRenderPassHintOpaque0The collection of Color contains only opaque colors. This implies that each color's alpha component is 255.
eStkGraphicsRenderPassHintTranslucent1The collection of Color contains translucent colors. This implies that at least one color has an alpha component that is not 255.
eStkGraphicsRenderPassHintUnknown2It is unknown if the collection of Color contains opaque or translucent colors.
An optimization hint indicating the Render Pass implied by per-strings colors defined in optionalParameters.

Remarks

See Set for a full discussion.

Example

Shows the format of the Text, Positions, Colors and Indices parameters when updating a text batch primitive with cartographic positions.
[C#]Copy Code
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]Copy Code
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)

See Also

© 2019 Analytical Graphics, Inc. All Rights Reserved.