TextBatchPrimitiveSetCartographic Method (CentralBody, IEnumerableCartographic, IEnumerableString, TextBatchPrimitiveOptionalParameters, RenderPassHint)

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(IEnumerableCartesian, IEnumerableString).

Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 25.2.423.0 (25.2.423.0)

Syntax

C++

Copy

public void SetCartographic(
	CentralBody centralBody,
	IEnumerable<Cartographic> positions,
	IEnumerable<string> text,
	TextBatchPrimitiveOptionalParameters optionalParameters,
	RenderPassHint renderPassHint
)

Public Sub SetCartographic ( 
	centralBody As CentralBody,
	positions As IEnumerable(Of Cartographic),
	text As IEnumerable(Of String),
	optionalParameters As TextBatchPrimitiveOptionalParameters,
	renderPassHint As RenderPassHint
)

public:
void SetCartographic(
	CentralBody^ centralBody, 
	IEnumerable<Cartographic>^ positions, 
	IEnumerable<String^>^ text, 
	TextBatchPrimitiveOptionalParameters^ optionalParameters, 
	RenderPassHint renderPassHint
)

member SetCartographic : 
        centralBody : CentralBody * 
        positions : IEnumerable<Cartographic> * 
        text : IEnumerable<string> * 
        optionalParameters : TextBatchPrimitiveOptionalParameters * 
        renderPassHint : RenderPassHint -> unit

Parameters

centralBody: Type: AGI.Foundation.CelestialCentralBody
The central body the positions are defined on.
positions: Type: System.Collections.GenericIEnumerableCartographic
The new positions for strings in the text batch.
text: Type: System.Collections.GenericIEnumerableString
The text for strings in the text batch. Each element in this collection corresponds to an element in positions.
optionalParameters: Type: AGI.Foundation.GraphicsTextBatchPrimitiveOptionalParameters
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: Type: AGI.Foundation.Graphics.AdvancedRenderPassHint
An optimization hint indicating the RenderPass implied by per-strings colors defined in optionalParameters.

Exceptions

Exception	Condition
ArgumentNullException	centralBody is .
InvalidOperationException	The primitive's ReferenceFrame is not equal to centralBody fixed frame.

Remarks

centralBody is used to convert positions to Cartesian. The primitive's ReferenceFrame must be equal to the centralBody fixed frame. If the primitive's ReferenceFrame is changed after calling this method, the Cartesian positions stored by the primitive are not modified and are unlikely to represent the original Cartographic positions provided to this method.

See Set(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, RenderPassHint) for a full discussion.

Reference

TextBatchPrimitive Class

SetCartographic Overload

AGI.Foundation.Graphics Namespace

TextBatchPrimitiveSet(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, RenderPassHint)