AGI STK Graphics 11 Send comments on this topic.
SetWithColorsAndRenderPass Method (IAgStkGraphicsPointBatchPrimitive)
See Also  Example
Positions
An array containing new positions (in the order x, y, z) for the point batch.
Colors
An array containing the numeric representation of colors for the point batch. There must be one color for each position in positions. 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 points in a point batch. The points are rendered in the primitive's Reference Frame. renderPassHint is provided for efficiency.

Syntax

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

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

[Managed C++]
public: void SetWithColorsAndRenderPass(
System::Array ^^ Positions,
System::Array ^^ Colors,
AgEStkGraphicsRenderPassHint RenderPassHint
);

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

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

Parameters

Positions
An array containing new positions (in the order x, y, z) for the point batch.
Colors
An array containing the numeric representation of colors for the point batch. There must be one color for each position in positions. 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 point batch.
[C#] Copy Code
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 colors = new object[] 

    Color.Red.ToArgb(), 
    Color.Green.ToArgb(), 
    Color.Blue.ToArgb(), 
    Color.White.ToArgb() 
}; 
 
Array indices = new object[] 

    0
    1
    2
    3 
}; 
 
pointBatch.SetPartialWithColorsIndicesOrderAndRenderPass( 
    ref positions, 
    ref colors, 
    ref indices, 
    AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, 
    AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque); 
 

Shows the format of the Positions, Colors and Indices parameters when updating a point batch.
[Visual Basic .NET] Copy Code
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}

pointBatch.SetPartialWithColorsIndicesOrderAndRenderPass(positions, colors, indices, AgEStkGraphicsIndicesOrderHint.eStkGraphicsIndicesOrderHintSortedAscending, AgEStkGraphicsRenderPassHint.eStkGraphicsRenderPassHintOpaque)

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1