AGI STK Graphics 11	Send comments on this topic.
SetWithColorsAndHint Method (IAgStkGraphicsPolylinePrimitive)
See Also Example

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

Description

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

Syntax

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

[Visual Basic .NET]

Public Sub SetWithColorsAndHint( _
   ByRef Positions As System.Array, _
   ByRef Colors As System.Array, _
   ByVal RenderPassHint As AgEStkGraphicsRenderPassHint _
)

[C#]
public void SetWithColorsAndHint( ref System.Array Positions, ref System.Array Colors, AgEStkGraphicsRenderPassHint RenderPassHint );

[C#]

public void SetWithColorsAndHint(
   ref System.Array Positions, 
   ref System.Array Colors, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);

[Managed 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
);

[Java]
public setWithColorsAndHint( Object[] Positions, Object[] Colors, AgEStkGraphicsRenderPassHint RenderPassHint );

[Java]

public  setWithColorsAndHint(
   Object[] Positions, 
   Object[] Colors, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);

[Unmanaged C++]
public: HRESULT SetWithColorsAndHint( SAFEARRAY ** Positions, SAFEARRAY ** Colors, AgEStkGraphicsRenderPassHint RenderPassHint );

[Unmanaged C++]

public: HRESULT SetWithColorsAndHint(
   SAFEARRAY ** Positions, 
   SAFEARRAY ** Colors, 
   AgEStkGraphicsRenderPassHint RenderPassHint
);

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

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.

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.

Example

Shows the format of the Positions, Colors and Indices parameters when updating a polyline primitive.

[C#] Copy Code

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);