Description

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

Syntax

[Visual Basic .NET]
Public Sub SetPartialWithOptionalParameters( _ ByRef Positions As System.Array, _ ByRef Text As System.Array, _ ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _ ByRef Indices As System.Array _ )

[Visual Basic .NET]

Public Sub SetPartialWithOptionalParameters( _
   ByRef Positions As System.Array, _
   ByRef Text As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsTextBatchPrimitiveOptionalParameters, _
   ByRef Indices As System.Array _
)

[C#]
public void SetPartialWithOptionalParameters( ref System.Array Positions, ref System.Array Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, ref System.Array Indices );

[C#]

public void SetPartialWithOptionalParameters(

   ref System.Array Positions, 

   ref System.Array Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 

   ref System.Array Indices

);

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

);

[Java]
public setPartialWithOptionalParameters( Object[] Positions, Object[] Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, Object[] Indices );

[Java]

public  setPartialWithOptionalParameters(

   Object[] Positions, 

   Object[] Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters OptionalParameters, 

   Object[] Indices

);

[Unmanaged C++]
public: HRESULT SetPartialWithOptionalParameters( SAFEARRAY ** Positions, SAFEARRAY ** Text, IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters, SAFEARRAY ** Indices );

[Unmanaged C++]

public: HRESULT SetPartialWithOptionalParameters(

   SAFEARRAY ** Positions, 

   SAFEARRAY ** Text, 

   IAgStkGraphicsTextBatchPrimitiveOptionalParameters * OptionalParameters, 

   SAFEARRAY ** Indices

);

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

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