AGI STK Graphics 11 Send comments on this topic.
SetWithOptionalParametersAndRenderPassHint Method (IAgStkGraphicsMarkerBatchPrimitive)
See Also  Example
Positions
An array containing the new positions (in the order x, y, z) for markers 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.
RenderPassHint
An optimization hint indicating the Render Pass implied by per-marker colors defined in optionalParameters.





Description

Defines the positions and optional per-marker parameters of markers in a marker batch. The markers are rendered in the primitive's Reference Frame. renderPassHint is provided for efficiency.

Syntax

[Visual Basic .NET]
Public Sub SetWithOptionalParametersAndRenderPassHint( _
   ByRef Positions As System.Array, _
   ByVal OptionalParameters As IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
) 

[C#]
public void SetWithOptionalParametersAndRenderPassHint(
ref System.Array Positions,
IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters OptionalParameters,
AgEStkGraphicsRenderPassHint RenderPassHint
);

[Managed C++]
public: void SetWithOptionalParametersAndRenderPassHint(
System::Array ^^ Positions,
IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters ^ OptionalParameters,
AgEStkGraphicsRenderPassHint RenderPassHint
);

[Unmanaged C++]
public: HRESULT SetWithOptionalParametersAndRenderPassHint(
SAFEARRAY ** Positions,
IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters * OptionalParameters,
AgEStkGraphicsRenderPassHint RenderPassHint
);

Parameters

Positions
An array containing the new positions (in the order x, y, z) for markers 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.
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

Calling this method with a renderPassHint of Unknown is equivalent to calling Set with just positions 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 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.744067.77
    1115.48, -4847.093979.36
    -24.12, -5529.313168.45
    -2683.42, -4307.743850.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