Click or drag to resize

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: 19.5.402.0 (19.5.402.0)
Syntax
public sealed class PointBatchPrimitive : Primitive

The PointBatchPrimitive type exposes the following members.

Constructors
  NameDescription
Public methodPointBatchPrimitive
Initializes a default point batch primitive. This is equivalent to constructing a point batch with a SetHint of Frequent.
Public methodPointBatchPrimitive(SetHint)
Initializes a new instance of a point batch primitive with the specified SetHint.
Top
Properties
  NameDescription
Public propertyAutomaticallyComputeBoundingSphere
Gets or sets if the primitive's BoundingSphere is automatically computed.
(Inherited from Primitive.)
Public propertyBoundingSphere
Gets or sets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame.
(Inherited from Primitive.)
Public propertyCentralBodyClipped
Gets or sets whether individual points will be clipped by the central body.
Public propertyColor
Gets or sets the color that affects every point in the batch.
(Overrides PrimitiveColor.)
Public propertyDisplay
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.)
Public propertyDisplayCondition
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.)
Public propertyDisplayOutline
Gets or sets whether an outline is rendered around each point in the batch.
Public propertyDistanceDisplayConditionPerPoint
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.
Public propertyStatic memberMaximumPixelSizeSupported
Gets the maximum pixel size supported by the video card.
Public propertyStatic memberMinimumPixelSizeSupported
Gets the minimum pixel size supported by the video card.
Public propertyOutlineColor
Gets or sets the outline's color.
Public propertyOutlineTranslucency
Gets or sets the translucency of the outline. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
Public propertyOutlineWidth
Gets or sets the size, in pixels, of the outline around each point in the batch.
Public propertyPerItemPickingEnabled
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.
Public propertyPixelSize
Gets or sets the size, in pixels, of each point in the point batch.
Public propertyReferenceFrame
Gets or sets the reference frame this primitive is defined and rendered in.
(Inherited from Primitive.)
Public propertySetHint
Gets the primitive's SetHint. See the Set Hint topic for more information on selecting an appropriate value to construct the primitive with.
Public propertyTag
Gets or sets custom data associated with this primitive.
(Inherited from Primitive.)
Public propertyTranslucency
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
  NameDescription
Public methodDispose (Inherited from Primitive.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSet(IEnumerableCartesian)
Defines the positions of points in a point batch. The points are rendered in the primitive's ReferenceFrame.
Public methodSet(IEnumerableCartesian, IEnumerableColor)
Defines the positions and colors of points in a point batch. The points are rendered in the primitive's ReferenceFrame.
Public methodSet(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.
Public methodSetCartographic(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.
Public methodSetCartographic(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.
Public methodSetCartographic(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.
Public methodSetPartial(IEnumerableCartesian, IEnumerableInt32)
Updates a subset of positions in a point batch.
Public methodSetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32)
Updates a subset of positions and/or colors in a point batch.
Public methodSetPartial(IEnumerableCartesian, IEnumerableInt32, IndicesOrderHint)
Updates a subset of positions in a point batch.
Public methodSetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32, IndicesOrderHint, RenderPassHint)
Updates a subset of positions and/or colors in a point batch.
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also