STK Graphics PrimitivesSend comments on this topic.
SetWithOptionalParametersAndRenderPass Method (IAgStkGraphicsTextBatchPrimitive)
See Also
Positions
An array containing the new positions (in the order x, y, z) for each string in the text batch.
Text
The text for strings in the text batch. Each element in this collection corresponds to a set of x, y, and z 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

Defines the positions, text, and optional parameters of strings in a text batch. The strings are rendered in the primitive's Reference Frame. renderPassHint is provided for efficiency.

Syntax

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

Parameters

Positions
An array containing the new positions (in the order x, y, z) for each string in the text batch.
Text
The text for strings in the text batch. Each element in this collection corresponds to a set of x, y, and z 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.

Remarks

Calling this method with a renderPassHint of Unknown is equivalent to calling Set with just positions, text, and optionalParameters. When a more specific renderPassHint is used, this method can be more efficient.

See Set for a full discussion.

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)
© 2024 Analytical Graphics, Inc. All Rights Reserved.