STK Graphics PrimitivesSend comments on this topic.
SetWithOptionalParameters Method (IAgStkGraphicsMarkerBatchPrimitive)
See Also
Positions
An array containing 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.
Windows





Windows & Linux

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.

Syntax

[Visual Basic .NET]
Public Sub SetWithOptionalParameters( _
    ByVal Positions As System.Array, _
    ByVal OptionalParameters As IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters _
)
[C#]
public void SetWithOptionalParameters(
    System.Array Positions,
    IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters OptionalParameters
);
[Managed C++]
public: void SetWithOptionalParameters(
    System::Array ^ Positions,
    IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters ^ OptionalParameters
);
[Unmanaged C++]
public: HRESULT SetWithOptionalParameters(
    SAFEARRAY * * Positions,
    IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters * OptionalParameters
);
[Java]
public void setWithOptionalParameters(
    AgSafeArray Positions,
    IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters OptionalParameters
);
[Python - STK API ]
def SetWithOptionalParameters(self, Positions:list, OptionalParameters:"IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters") -> None:

Parameters

Positions
An array containing 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.

Remarks

This call overwrites the primitive's previous markers. To update a subset of markers, use Set Partial.

When a per-marker parameter is not specified in optionalParameters, its corresponding per-batch value is used. For example, if optionalParameters did not have a texture array defined with MarkerBatchPrimitiveOptionalParameters.SetTextures, each marker uses the batch's Texture.

See Also

Example

Shows the format of the Colors, Positions and Indices parameters when updating a marker batch primitive.
[C#]
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]
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)
© 2025 Analytical Graphics, Inc. All Rights Reserved.