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 SetCartographicWithOptionalParameters( _ ByVal CentralBody As String, _ ByRef Positions As System.Array, _ ByRef Text As System.Array, _ ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters _ )

[Visual Basic .NET]

Public Sub SetCartographicWithOptionalParameters( _
   ByVal CentralBody As String, _
   ByRef Positions As System.Array, _
   ByRef Text As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters _
)

[C#]
public void SetCartographicWithOptionalParameters( string CentralBody, ref System.Array Positions, ref System.Array Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters );

[C#]

public void SetCartographicWithOptionalParameters(
   string CentralBody, 
   ref System.Array Positions, 
   ref System.Array Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters
);

[Managed C++]
public: void SetCartographicWithOptionalParameters( String __gc ^ 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
);

[Java]
public setCartographicWithOptionalParameters( String CentralBody, Object[] Positions, Object[] Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters );

[Java]

public  setCartographicWithOptionalParameters(
   String CentralBody, 
   Object[] Positions, 
   Object[] Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters
);

[Unmanaged C++]
public: HRESULT SetCartographicWithOptionalParameters( BSTR CentralBody, SAFEARRAY ** Positions, SAFEARRAY ** Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters );

[Unmanaged C++]

public: HRESULT SetCartographicWithOptionalParameters(
   BSTR CentralBody, 
   SAFEARRAY ** Positions, 
   SAFEARRAY ** Text, 
   IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters
);

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.

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);