Description

Renders one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards.

For best performance, avoid creating lots of batches with only a few markers each. See the Batching Performance Overview.

Public Methods

AlignToAxis	Sets the up vector of the markers to point towards the axis of centralBody. It will be aligned with the tangent vector of the surface that points towards the axis. Setting axis to the north axis of the centralBody will have the same effect as calling MarkerBatchPrimitive.AlignToNorth.
AlignToNorth	Sets the up vector of the markers to point towards the north axis of centralBody. It will be aligned with the tangent vector of the surface that points north.
AlignToScreen	Sets the up vector of the markers to always be aligned to the up vector of the camera. This is the default alignment.
Set	Defines the positions of markers in a marker batch. The markers are rendered in the primitive's Reference Frame.
SetCartographic	For convenience. Defines the positions of markers in a marker batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set.
SetCartographicWithOptionalParameters	For convenience. Defines the positions and optional per-marker parameters of markers in a marker batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set.
SetCartographicWithOptionalParametersAndRenderPassHint	For convenience. Defines the positions and optional per-marker parameters of markers in a marker batch using Cartographic positions. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to Cartesian and calling Set.
SetPartial	Updates a subset of marker positions in a marker batch.
SetPartialCartographic	For convenience. Updates a subset of positions in a marker batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set Partial.
SetPartialCartographicWithIndicesOrder	For convenience. Updates a subset of positions in a marker batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set Partial.
SetPartialCartographicWithOptionalParameters	For convenience. Updates a subset of positions and/or optional per-marker parameters of markers in a marker batch using Cartographic positions. This is equivalent to converting each position in positions to Cartesian and calling Set Partial.
SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass	For convenience. Updates a subset of positions and/or optional per-marker parameters of markers in a marker batch using Cartographic positions. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to Cartesian and calling Set Partial.
SetPartialWithIndicesOrder	Updates a subset of marker positions in a marker batch.
SetPartialWithOptionalParameters	Updates a subset of marker positions and/or per-marker parameters in a marker batch.
SetPartialWithOptionalParametersIndicesOrderAndRenderPass	Updates a subset of marker positions and/or per-marker parameters in a marker batch.
SetWithOptionalParameters	Defines the positions and optional per-marker parameters of markers in a marker batch. The markers are rendered in the primitive's Reference Frame.
SetWithOptionalParametersAndRenderPassHint	Defines the positions and optional per-marker parameters of markers in a marker batch. The markers are rendered in the primitive's Reference Frame. renderPassHint is provided for efficiency.
Supported	Determines whether or not the video card supports the marker batch primitive with the given renderingMethod.

Public Properties

BoundingSphereScale	Gets or sets the scale applied to the radius of this primitive's bounding sphere.
CentralBodyClipped	Gets or sets whether the markers are clipped by the central body.
ClampToPixel	Gets or sets whether the screen space position of each marker is clamped to a pixel.
DistanceDisplayConditionPerMarker	Gets or sets a Distance Display Condition that is evaluated per marker in the marker batch during rendering. This is different than Display Condition, which is evaluated once for the entire marker batch. When `DistanceDisplayConditionPerMarker` is `null`, no per marker display condition is evaluated.
EyeOffset	Gets or sets the per-batch eye offset, which is applied to each marker in the batch. The array contains the components of the eye offset in the order x, y, z.
Origin	Gets or sets the per-batch origin, which is applied to each marker in the batch.
PerItemPickingEnabled	Gets or sets whether individual marker indices will be included in the PickResults returned from the Scene's `Pick` method. Each marker index that is picked will be returned as a BatchPrimitiveIndex.
PixelOffset	Gets or sets the per-batch pixel offset, which is applied to each marker in the batch. The array contains one x pixel offset followed by one y pixel offset.
RenderingMethod	Gets the rendering method used to render the marker batch.
RenderPass	Gets or sets the pass during which the marker batch is rendered.
Rotation	Gets or sets the per-batch rotation angle which is applied to each marker in the batch.
SetHint	Gets the primitive's Set Hint. See the Set Hint Performance Overview for selecting an appropriate value to construct the primitive with.
Size	Gets or sets the per-batch size, which is applied to each marker in the batch. The array contains one width followed by one height.
SizeSource	Gets the source used for the size of markers in the batch.
SizeUnit	Gets or sets the unit that each marker's size is defined in.
SortOrder	Gets the order in which markers in the marker batch are sorted before rendering.
Texture	Gets or sets the per-batch texture, which is applied to each marker in the batch.
TextureCoordinate	Gets or sets the per-batch texture coordinate, which is applied to each marker in the batch. The array contains the texture coordinates arranged in the order s, t, p, q.
TextureFilter	Gets or sets the filter used for per-marker or per-batch textures.
Wireframe	Gets or sets whether the primitive is rendered in wireframe. This is useful for debugging.

Interfaces

Implemented Interface
IAgStkGraphicsPrimitive

CoClasses that Implement IAgStkGraphicsMarkerBatchPrimitive

Name
AgStkGraphicsMarkerBatchPrimitive

Example

Draw a set of markers

[C#]

IAgStkGraphicsSceneManager manager = ((IAgScenario)root.CurrentScenario).SceneManager;

Array positions = new object[]
{
    39.88, -75.25, 0,    // Philadelphia
    38.85, -77.04, 0, // Washington, D.C.   
    29.98, -90.25, 0, // New Orleans
    37.37, -121.92, 0    // San Jose
};

IAgStkGraphicsMarkerBatchPrimitive markerBatch = manager.Initializers.MarkerBatchPrimitive.Initialize();
markerBatch.Texture = manager.Textures.LoadFromStringUri(
    markerImageFile);
markerBatch.SetCartographic("Earth", ref positions);

manager.Primitives.Add((IAgStkGraphicsPrimitive)markerBatch);