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( _ ByRef Positions() As Variant, _ ByRef Text() As Variant, _ ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _ ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _ )

[Visual Basic .NET]

Public Sub SetWithOptionalParametersAndRenderPass( _
   ByRef Positions() As Variant, _
   ByRef Text() As Variant, _
   ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)

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

Member	Value	Description
eStkGraphicsRenderPassHintOpaque	0	The collection of Color contains only opaque colors. This implies that each color's alpha component is 255.
eStkGraphicsRenderPassHintTranslucent	1	The collection of Color contains translucent colors. This implies that at least one color has an alpha component that is not 255.
eStkGraphicsRenderPassHintUnknown	2	It 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

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.

Example

Shows the format of the Text, Positions, Colors and Indices parameters when updating a text batch primitive.

[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[] 

{ 

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