AGI STK Graphics 11 Send comments on this topic.
SetPartialWithOptionalParametersIndicesOrderAndRenderPass Method (IAgStkGraphicsMarkerBatchPrimitive)
See Also  Example
Positions
An array containing positions (in the order x, y, z) used to update a subset of positions in the marker batch.
OptionalParameters
Optional per-marker parameters corresponding to positions. Each per-marker 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
RenderPassHint
An optimization hint indicating the Render Pass implied by per-marker colors defined in optionalParameters.





Description

Updates a subset of marker positions and/or per-marker parameters in a marker batch.

Syntax

[Visual Basic .NET] 
Public Sub SetPartialWithOptionalParametersIndicesOrderAndRenderPass( _
   ByRef Positions As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters, _
   ByRef Indices As System.Array, _
   ByVal IndicesOrderHint As AgEStkGraphicsIndicesOrderHint, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)
[C#] 
public void SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   ref System.Array Positions, 

   IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters OptionalParameters, 

   ref System.Array Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);
[Managed C++] 
public: void SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   System::Array ^^ Positions, 

   IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters ^ OptionalParameters, 

   System::Array ^^ Indices, 

   AgEStkGraphicsIndicesOrderHint IndicesOrderHint, 

   AgEStkGraphicsRenderPassHint RenderPassHint

);
[Unmanaged C++] 
public: HRESULT SetPartialWithOptionalParametersIndicesOrderAndRenderPass(

   SAFEARRAY ** Positions, 

   IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters * 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 marker batch.
OptionalParameters
Optional per-marker parameters corresponding to positions. Each per-marker 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 Colors, Positions and Indices parameters when updating a marker batch primitive.
[C#] Copy Code
Array colors = new object[] 
{ 
    Color.Red.ToArgb(), 
    Color.Green.ToArgb(), 
    Color.Blue.ToArgb(), 
    Color.White.ToArgb() 
}; 
 
IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters parameters = sceneManager.Initializers.MarkerBatchPrimitiveOptionalParameters.Initialize(); 
parameters.SetColors(ref colors); 
 
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 
}; 
 
markerBatch.SetPartialWithOptionalParametersIndicesOrderAndRenderPass( 
    ref positions, 
    parameters, 
    ref indices, 
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, 
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque); 
 
Shows the format of the Colors, Positions and Indices parameters when updating a marker batch primitive.
[Visual Basic .NET] Copy Code
Dim colors As Array = New Object() {Color.Red.ToArgb(), Color.Green.ToArgb(), Color.Blue.ToArgb(), Color.White.ToArgb()}

Dim parameters As IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters = sceneManager.Initializers.MarkerBatchPrimitiveOptionalParameters.Initialize()
parameters.SetColors(colors)

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}

markerBatch.SetPartialWithOptionalParametersIndicesOrderAndRenderPass(positions, parameters, indices, AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque)

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1