STK Graphics PrimitivesSend comments on this topic.
SetWithColorsAndHint Method (IAgStkGraphicsPolylinePrimitive)
See Also
Positions
An array containing new positions (in the order x, y, z) for the polyline.
Colors
An array containing the numeric representation of colors for the polyline. There must be one color for each position in positions. The first color is ignored, each additional color defines the color of the line segment ending at that position. In .NET a Color should be translated to a number by calling its ToArgb method and casting the result as an unsigned integer.
RenderPassHint
Windows





Windows & Linux

Description

Defines the positions and colors of a polyline. The polyline is rendered in its Reference Frame. renderPassHint is provided for efficiency.

Syntax

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

Parameters

Positions
An array containing new positions (in the order x, y, z) for the polyline.
Colors
An array containing the numeric representation of colors for the polyline. There must be one color for each position in positions. The first color is ignored, each additional color defines the color of the line segment ending at that position. In .NET a Color should be translated to a number by calling its ToArgb method and casting the result as an unsigned integer.
RenderPassHint

Remarks

Calling this method with a renderPassHint of Unknown is equivalent to calling Set with just positions and colors. When a more specific renderPassHint is used, this method can be more efficient.

See Set for a full discussion.

See Also

Example

Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive.
[C#]
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 colors = new object[]
{
    Color.Red.ToArgb(),
    Color.Green.ToArgb(),
    Color.Blue.ToArgb(),
    Color.White.ToArgb()
};

Array indices = new object[]
{
    0,
    1,
    2,
    3
};

polyline.SetPartialWithColorsIndicesOrderAndRenderPassHint(
    ref positions, 
    ref colors, 
    ref indices,
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending,
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque);
Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive.
[Visual Basic .NET]
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 colors As Array = New Object() {Color.Red.ToArgb(), Color.Green.ToArgb(), Color.Blue.ToArgb(), Color.White.ToArgb()}

Dim indices As Array = New Object() {0, 1, 2, 3}

polyline.SetPartialWithColorsIndicesOrderAndRenderPassHint(positions, colors, indices, AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque)
© 2024 Analytical Graphics, Inc. All Rights Reserved.