PointBatchPrimitive Class

Renders one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each. See the Batching Performance topic.

Inheritance Hierarchy

SystemObject
AGI.Foundation.GraphicsPrimitive
AGI.Foundation.GraphicsPointBatchPrimitive

Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public sealed class PointBatchPrimitive : Primitive

Public NotInheritable Class PointBatchPrimitive
	Inherits Primitive

public ref class PointBatchPrimitive sealed : public Primitive

[<SealedAttribute>]
type PointBatchPrimitive =  
    class
        inherit Primitive
    end

The PointBatchPrimitive type exposes the following members.

Constructors

	Name	Description
	PointBatchPrimitive	Initializes a default point batch primitive. This is equivalent to constructing a point batch with a SetHint of Frequent.
	PointBatchPrimitive(SetHint)	Initializes a new instance of a point batch primitive with the specified SetHint.

Top

Properties

	Name	Description
	AutomaticallyComputeBoundingSphere	Gets or sets if the primitive's BoundingSphere is automatically computed. (Inherited from Primitive.)
	BoundingSphere	Gets or sets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame. (Inherited from Primitive.)
	CentralBodyClipped	Gets or sets whether individual points will be clipped by the central body.
	Color	Gets or sets the color that affects every point in the batch. (Overrides PrimitiveColor.)
	Display	Gets or sets if the primitive should be rendered. Both this and DisplayCondition must evaluate to true for the primitive to be rendered. (Inherited from Primitive.)
	DisplayCondition	Gets or sets the display condition that determines if the primitive should be rendered. Both this and Display must evaluate to true for the primitive to be rendered. (Inherited from Primitive.)
	DisplayOutline	Gets or sets whether an outline is rendered around each point in the batch.
	DistanceDisplayConditionPerPoint	Gets or sets a DistanceDisplayCondition that is evaluated per point in the point batch during rendering. This is different than DisplayCondition, which is evaluated once for the entire point batch. When DistanceDisplayConditionPerPoint is null, no per point display condition is evaluated.
	MaximumPixelSizeSupported	Gets the maximum pixel size supported by the video card.
	MinimumPixelSizeSupported	Gets the minimum pixel size supported by the video card.
	OutlineColor	Gets or sets the outline's color.
	OutlineTranslucency	Gets or sets the translucency of the outline. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
	OutlineWidth	Gets or sets the size, in pixels, of the outline around each point in the batch.
	PerItemPickingEnabled	Gets or sets whether individual point indices will be included in the PickResults returned from the Scene's Pick method. Each point index that is picked will be returned as a BatchPrimitiveIndex.
	PixelSize	Gets or sets the size, in pixels, of each point in the point batch.
	ReferenceFrame	Gets or sets the reference frame this primitive is defined and rendered in. (Inherited from Primitive.)
	SetHint	Gets the primitive's SetHint. See the Set Hint topic for more information on selecting an appropriate value to construct the primitive with.
	Tag	Gets or sets custom data associated with this primitive. (Inherited from Primitive.)
	Translucency	Gets or sets the translucency that affects every point in the batch. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent. (Overrides PrimitiveTranslucency.)

Top

Methods

	Name	Description
	Dispose	(Inherited from Primitive.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Set(IEnumerableCartesian)	Defines the positions of points in a point batch. The points are rendered in the primitive's ReferenceFrame.
	Set(IEnumerableCartesian, IEnumerableColor)	Defines the positions and colors of points in a point batch. The points are rendered in the primitive's ReferenceFrame.
	Set(IEnumerableCartesian, IEnumerableColor, RenderPassHint)	Defines the positions and colors of points in a point batch. The points are rendered in the primitive's ReferenceFrame. renderPassHint is provided for efficiency.
	SetCartographic(CentralBody, IEnumerableCartographic)	For convenience. Defines the positions of points in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling Set.
	SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableColor)	For convenience. Defines the positions and colors of points in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling Set.
	SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableColor, RenderPassHint)	For convenience. Defines the positions and colors of points in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to Cartesian and calling Set.
	SetPartial(IEnumerableCartesian, IEnumerableInt32)	Updates a subset of positions in a point batch.
	SetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32)	Updates a subset of positions and/or colors in a point batch.
	SetPartial(IEnumerableCartesian, IEnumerableInt32, IndicesOrderHint)	Updates a subset of positions in a point batch.
	SetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32, IndicesOrderHint, RenderPassHint)	Updates a subset of positions and/or colors in a point batch.
	SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableInt32)	For convenience. Updates a subset of positions in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling SetPartial
	SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableColor, IEnumerableInt32)	For convenience. Updates a subset of positions and/or colors in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling SetPartial
	SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableInt32, IndicesOrderHint)	For convenience. Updates a subset of positions in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling SetPartial
	SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableColor, IEnumerableInt32, IndicesOrderHint, RenderPassHint)	For convenience. Updates a subset of positions and/or colors in a point batch using Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting each position in positions to Cartesian and calling SetPartial
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics Namespace

Other Resources

Point Batch Primitive topic

Performance topic