STK Graphics PrimitivesSend comments on this topic.
SetPartialWithOptionalParameters Method (IAgStkGraphicsTextBatchPrimitive)
See Also
Positions
An array containing positions (in the order x, y, z) used to update a subset of positions in the text batch.
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 x, y, and z elements is considered a single index.
Windows





Windows & Linux

Description

Updates a subset of positions, text, and/or optional per-string parameters in a text batch.

Syntax

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

Parameters

Positions
An array containing positions (in the order x, y, z) used to update a subset of positions in the text batch.
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 x, y, and z elements is considered a single index.

Remarks

See Also

Example

Shows the format of the Text, Positions, Colors and Indices parameters when updating a text batch primitive.
[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[]
{
    1247.87, -4739.74, 4067.77,
    1115.48, -4847.09, 3979.36,   
    -24.12, -5529.31, 3168.45,
    -2683.42, -4307.74, 3850.11
};

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

textBatch.SetPartialWithOptionalParametersIndicesOrderAndRenderPass(
    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.
[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"}

Dim positions As Array = New Object() {1247.87, -4739.74, 4067.77, 1115.48, -4847.09, 3979.36, _
	-24.12, -5529.31, 3168.45, -2683.42, -4307.74, 3850.11}

Dim indices As Array = New Object() {0, 1, 2, 3}

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