Description

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

Syntax

[Visual Basic .NET]
Public Sub SetPartialWithOptionalParametersIndicesOrderAndRenderPass( _ ByRef Positions As System.Array, _ ByRef Text As System.Array, _ ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _ ByRef Indices As System.Array, _ ByVal IndicesOrderHint As AgEStkGraphicsIndicesOrderHint, _ ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _ )

[Visual Basic .NET]

Public Sub SetPartialWithOptionalParametersIndicesOrderAndRenderPass( _
   ByRef Positions As System.Array, _
   ByRef Text As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _
   ByRef Indices As System.Array, _
   ByVal IndicesOrderHint As AgEStkGraphicsIndicesOrderHint, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)

[C#]
public void SetPartialWithOptionalParametersIndicesOrderAndRenderPass( ref System.Array Positions, ref System.Array Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, ref System.Array Indices, AgEStkGraphicsIndicesOrderHint IndicesOrderHint, AgEStkGraphicsRenderPassHint RenderPassHint );

[C#]

public void SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   ref System.Array Positions, 

   ref System.Array Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 

   ref System.Array Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);

[Managed C++]
public: void SetPartialWithOptionalParametersIndicesOrderAndRenderPass( System::Array ^^ Positions, System::Array ^^ Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters ^ OptionalParameters, System::Array ^^ Indices, AgEStkGraphicsIndicesOrderHint IndicesOrderHint, AgEStkGraphicsRenderPassHint RenderPassHint );

[Managed C++]

public: void SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   System::Array ^^ Positions, 

   System::Array ^^ Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters ^ OptionalParameters, 

   System::Array ^^ Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);

[Java]
public setPartialWithOptionalParametersIndicesOrderAndRenderPass( Object[] Positions, Object[] Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, Object[] Indices, AgEStkGraphicsIndicesOrderHint IndicesOrderHint, AgEStkGraphicsRenderPassHint RenderPassHint );

[Java]

public  setPartialWithOptionalParametersIndicesOrderAndRenderPass(

   Object[] Positions, 

   Object[] Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 

   Object[] Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);

[Unmanaged C++]
public: HRESULT SetPartialWithOptionalParametersIndicesOrderAndRenderPass( SAFEARRAY ** Positions, SAFEARRAY ** Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters, SAFEARRAY ** Indices, AgEStkGraphicsIndicesOrderHint IndicesOrderHint, AgEStkGraphicsRenderPassHint RenderPassHint );

[Unmanaged C++]

public: HRESULT SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   SAFEARRAY ** Positions, 

   SAFEARRAY ** Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters, 

   SAFEARRAY ** Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);

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.

IndicesOrderHint

Member	Value	Description
eStkGraphicsIndicesOrderHintNotSorted	0	The `indices` passed to `SetPartial` are not sorted. Therefore, the primitive may sort them to improve performance of writing its geometry to video memory.
eStkGraphicsIndicesOrderHintSortedAscending	1	The `indices` passed to `SetPartial` are sorted in ascending order. Therefore, the primitive does not need to sort them. It is recommended to only use `SortedAscending` if it is easy and efficient for you to provide the `indices` in ascending order. For example, do not use a standard sorting algorithm to sort your indices so you can use `SortedAscending`. Instead use `NotSorted` and let the primitive decide what is most efficient.

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-marker colors defined in optionalParameters.

Remarks

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