Click or drag to resize

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

Namespace:  AGI.Foundation.Graphics
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public sealed class PolylinePrimitive : Primitive

The PolylinePrimitive type exposes the following members.

Constructors
  NameDescription
Public methodPolylinePrimitive
Initializes a default polyline primitive. This is equivalent to constructing a polyline with a SetHint of Frequent and a PolylineType of LineStrip.
Public methodPolylinePrimitive(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.
Public methodPolylinePrimitive(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.
Public methodPolylinePrimitive(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.
Public methodPolylinePrimitive(PolylineType, SetHint)
Initializes a new instance of a polyline primitive with the specified polylineType and setHint.
Public methodPolylinePrimitive(PositionInterpolator, SetHint)
Initializes a polyline primitive with the specified interpolator and 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 the polyline will be clipped by the central body.
Public propertyColor
Gets or sets the primitive's color.
(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 the polyline.
Public propertyStatic memberMaximumWidthSupported
Gets the maximum width, in pixels, supported by the video card.
Public propertyStatic memberMinimumWidthSupported
Gets the minimum width, in pixels, 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 width, in pixels, of the outline around the polyline.
Public propertyPerItemPickingEnabled
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.
Public propertyPolylineType
Gets how the polyline interprets the positions passed to Set methods.
Public propertyPositionInterpolator
Gets the PositionInterpolator applied to positions passed to Set, SetCartographic, SetSubset, and SetSubsetCartographic methods. When this property is null, linear interpolation is used.
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 primitive's translucency. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
(Overrides PrimitiveTranslucency.)
Public propertyWidth
Gets or sets the line width, in pixels.
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 for a polyline primitive. The polyline is rendered in it's ReferenceFrame.
Public methodSet(SolidTriangulatorResult)
Defines the positions of a polyline using the outline positions of the specified solidTriangulatorResult.
Public methodSet(SurfaceShapesResult)
Defines the positions of a polyline using the positions of the specified surfaceShapesResult.
Public methodSet(SurfaceTriangulatorResult)
Defines the positions of a polyline using the boundary positions of the specified surfaceTriangulatorResult.
Public methodSet(IEnumerableCartesian, IEnumerableColor)
Defines the positions and colors of a polyline. The polyline is rendered in it's ReferenceFrame.
Public methodSet(IEnumerableCartesian, IEnumerableColor, RenderPassHint)
Defines the positions and colors of a polyline. The polyline is rendered in it's ReferenceFrame. renderPassHint is provided for efficiency.
Public methodSetCartographic(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.
Public methodSetCartographic(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.
Public methodSetCartographic(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.
Public methodSetPartial(IEnumerableCartesian, IEnumerableInt32)
Updates a subset of positions in a polyline.
Public methodSetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32)
Updates a subset of positions and/or colors in a polyline.
Public methodSetPartial(IEnumerableCartesian, IEnumerableInt32, IndicesOrderHint)
Updates a subset of positions in a polyline.
Public methodSetPartial(IEnumerableCartesian, IEnumerableColor, IEnumerableInt32, IndicesOrderHint, RenderPassHint)
Updates a subset of positions and/or colors in a polyline.
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodSetPartialCartographic(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
Public methodSetSubset
Defines the positions of a polyline using a subset of input positions.
Public methodSetSubsetCartographic
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also