PolylinePrimitive Class

Renders a polyline in the 3D scene. Each line segment may have a different color. A polyline can be constructed with a PositionInterpolator to render great arcs or rhumb lines.

Inheritance Hierarchy

SystemObject
AGI.Foundation.GraphicsPrimitive
AGI.Foundation.GraphicsPolylinePrimitive

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

Syntax

C++

Copy

public sealed class PolylinePrimitive : Primitive

Public NotInheritable Class PolylinePrimitive
	Inherits Primitive

public ref class PolylinePrimitive sealed : public Primitive

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

The PolylinePrimitive type exposes the following members.

Constructors

	Name	Description
	PolylinePrimitive	Initializes a default polyline primitive. This is equivalent to constructing a polyline with a SetHint of Frequent and a PolylineType of LineStrip.
	PolylinePrimitive(PolylineType)	Initializes a polyline primitive with the specified polylineType. This is equivalent to constructing a polyline with the specified polylineType and a SetHint of Frequent.
	PolylinePrimitive(PositionInterpolator)	Initializes a polyline primitive with the specified interpolator. This is equivalent to constructing a polyline with the specified interpolator and a SetHint of Frequent.
	PolylinePrimitive(SetHint)	Initializes a new instance of a polyline primitive with the specified SetHint. This is equivalent to constructing a polyline with a PolylineType of LineStrip and the specified SetHint.
	PolylinePrimitive(PolylineType, SetHint)	Initializes a new instance of a polyline primitive with the specified polylineType and setHint.
	PolylinePrimitive(PositionInterpolator, SetHint)	Initializes a polyline primitive with the specified interpolator and 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 the polyline will be clipped by the central body.
	Color	Gets or sets the primitive's color. (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 the polyline.
	MaximumWidthSupported	Gets the maximum width, in pixels, supported by the video card.
	MinimumWidthSupported	Gets the minimum width, in pixels, 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 width, in pixels, of the outline around the polyline.
	PerItemPickingEnabled	Gets or sets whether individual line indices will be included in the PickResults returned from the Scene's Pick method. Each line index that is picked will be returned as a BatchPrimitiveIndex.
	PolylineType	Gets how the polyline interprets the positions passed to Set methods.
	PositionInterpolator	Gets the PositionInterpolator applied to positions passed to Set, SetCartographic, SetSubset, and SetSubsetCartographic methods. When this property is null, linear interpolation is used.
	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 primitive's translucency. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent. (Overrides PrimitiveTranslucency.)
	Width	Gets or sets the line width, in pixels.

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 for a polyline primitive. The polyline is rendered in its ReferenceFrame.
	Set(SolidTriangulatorResult)	Defines the positions of a polyline using the outline positions of the specified solidTriangulatorResult.
	Set(SurfaceShapesResult)	Defines the positions of a polyline using the positions of the specified surfaceShapesResult.
	Set(SurfaceTriangulatorResult)	Defines the positions of a polyline using the boundary positions of the specified surfaceTriangulatorResult.
	Set(IEnumerableCartesian, IEnumerableColor)	Defines the positions and colors of a polyline. The polyline is rendered in its ReferenceFrame.
	Set(IEnumerableCartesian, IEnumerableColor, RenderPassHint)	Defines the positions and colors of a polyline. The polyline is rendered in its ReferenceFrame. renderPassHint is provided for efficiency.
	Set(IEnumerableCartesian, IEnumerableColor, PolylinePrimitiveOptionalParameters)	Defines the positions, colors, and/or optional point properties of a polyline. The polyline is rendered in its ReferenceFrame.
	SetCartographic(CentralBody, IEnumerableCartographic)	For convenience. Defines the positions of a polyline 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 a polyline 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 a polyline 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.
	SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableColor, PolylinePrimitiveOptionalParameters)	For convenience. Defines the positions, colors, and/or optional point properties of a polyline 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.
	SetPartial(IEnumerableCartesian, IEnumerableInt32)	Updates a subset of positions in a polyline.
	SetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32)	Updates a subset of positions and/or colors in a polyline.
	SetPartial(IEnumerableCartesian, IEnumerableInt32, IndicesOrderHint)	Updates a subset of positions in a polyline.
	SetPartial(IEnumerableCartesian, IEnumerableColor, PolylinePrimitiveOptionalParameters, IEnumerableInt32)	Updates a subset of positions, colors, and/or optional point properties in a polyline.
	SetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32, IndicesOrderHint, RenderPassHint)	Updates a subset of positions and/or colors in a polyline.
	SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableInt32)	For convenience. Updates a subset of positions in a polyline 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 polyline 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 polyline 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, PolylinePrimitiveOptionalParameters, IEnumerableInt32)	For convenience. Updates a subset of positions, colors, and/or optional point properties in a polyline 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 polyline 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
	SetSubset	Defines the positions of a polyline using a subset of input positions.
	SetSubsetCartographic	For convenience. Defines the positions of a polyline using a subset of input Cartographic positions. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting the subset of positions to Cartesian and calling SetSubset.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics Namespace

Other Resources

Polyline Primitive topic