STK Graphics PrimitivesSend comments on this topic.
SetOrigins Method (IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters)
See Also
Origins
An array containing a Origin element for each marker in the batch. There must be one origin for each position passed to the Marker Batch Primitive's Set or SetPartial method.
Windows





Windows & Linux

Description

Defines a collection of origins, one for each marker in the batch.

Syntax

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

Parameters

Origins
An array containing a Origin element for each marker in the batch. There must be one origin for each position passed to the Marker Batch Primitive's Set or SetPartial method.

Remarks

The origin defines where the marker is placed relative to its position.

Per-marker origins override the per-batch origin. Therefore, when per-marker origins are defined with this method, MarkerBatchPrimitive.Origin is not used.

See Also

Example

Shows the format of the Origins parameter when setting per marker origins.
[C#]
Array origins = new object[]
{
    AgEStkGraphicsOrigin.eStkGraphicsOriginCenter,
    AgEStkGraphicsOrigin.eStkGraphicsOriginBottomLeft,
    AgEStkGraphicsOrigin.eStkGraphicsOriginBottomRight,
    AgEStkGraphicsOrigin.eStkGraphicsOriginTopLeft
};

IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters parameters = sceneManager.Initializers.MarkerBatchPrimitiveOptionalParameters.Initialize();
parameters.SetOrigins(ref origins);
Shows the format of the Origins parameter when setting per marker origins.
[Visual Basic .NET]
Dim origins As Array = New Object() {AgEStkGraphicsOrigin.eStkGraphicsOriginCenter, AgEStkGraphicsOrigin.eStkGraphicsOriginBottomLeft, AgEStkGraphicsOrigin.eStkGraphicsOriginBottomRight, AgEStkGraphicsOrigin.eStkGraphicsOriginTopLeft}

Dim parameters As IAgStkGraphicsMarkerBatchPrimitiveOptionalParameters = sceneManager.Initializers.MarkerBatchPrimitiveOptionalParameters.Initialize()
parameters.SetOrigins(origins)
© 2024 Analytical Graphics, Inc. All Rights Reserved.