Click or drag to resize

PointBatchPrimitiveSet Method (IEnumerableCartesian, IEnumerableColor)

Defines the positions and colors of points in a point batch. The points are rendered in the primitive's ReferenceFrame.

Namespace:  AGI.Foundation.Graphics
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 21.1.408.0 (21.1.408.0)
Syntax
public void Set(
	IEnumerable<Cartesian> positions,
	IEnumerable<Color> colors
)

Parameters

positions
Type: System.Collections.GenericIEnumerableCartesian
The new positions for the point batch.
colors
Type: System.Collections.GenericIEnumerableColor
The new colors for the point batch. There must be one color for each position in positions.
Exceptions
ExceptionCondition
ArgumentNullExceptionpositions or colors is null.
ArgumentExceptionpositions and colors must have the same number of elements.
CouldNotCreateVideoCardResourceException Could not allocate video memory for positions and colors.
Remarks

This call overwrites the primitive's previous positions and per-position colors. To update a subset of positions and colors, use SetPartial.

Each color in colors corresponds to a position in positions with the same location. For example, the first color in colors is applied to the first position in positions. These colors override the primitive's Color and Translucency properties. Accessing these properties will result in an InvalidOperationException.

To create translucent points, use the Color's alpha component. An alpha of 0 is completely transparent and an alpha of 255 is completely opaque.

If this method is called frequently, it is recommended to construct the primitive with Frequent, which is the default. If this method will be called only once or infrequently, construct the primitive with Infrequent. See the Set Hint topic for more information.

If the primitive's AutomaticallyComputeBoundingSphere property is , the primitive's BoundingSphere is computed based on positions. Otherwise, it is the caller's responsibility to update the primitive's BoundingSphere to a sphere that encompasses all the positions.

See Also