LuciadCPillar C# 2024.0.08
Luciad.Geometries.PolylineRing Class Reference

Represents a polyline that is closed, i.e., the first point and the last point coincide. More...

Inheritance diagram for Luciad.Geometries.PolylineRing:
Luciad.Geometries.CompositeRing Luciad.Geometries.Ring Luciad.Geometries.Curve Luciad.Geometries.Geometry

Public Member Functions

Luciad.Cartesian.Coordinate GetPoint (uint index)
 Returns the coordinate for the requested index. More...
 
Luciad.Geometries.PolylineRing InsertPoint (uint index, Luciad.Cartesian.Coordinate newLocation)
 Creates a new PolylineRing with an newly inserted control point. More...
 
Luciad.Geometries.PolylineRing MovePoint (uint index, Luciad.Cartesian.Coordinate newLocation)
 Creates a new PolylineRing with a moved control point. More...
 
Luciad.Geometries.PolylineRing RemovePoint (uint index)
 Creates a new PolylineRing with a control point removed. More...
 
Luciad.Geometries.PolylineRing Translate (Luciad.Cartesian.Coordinate translation)
 Translates the entire polyline ring. More...
 
- Public Member Functions inherited from Luciad.Geometries.CompositeRing
virtual Luciad.Geometries.Curve GetCurveAt (uint index)
 Returns the curve for the requested index. More...
 
- Public Member Functions inherited from Luciad.Geometries.Curve
virtual Luciad.Cartesian.Coordinate ComputePoint (double parameter)
 Computes a point of the curve, defined by the given parameter. More...
 
- Public Member Functions inherited from Luciad.Geometries.Geometry
void Dispose ()
 

Properties

Luciad.Geodesy.LineInterpolationType InterpolationType [get]
 The interpolation type of the line segment. More...
 
uint PointCount [get]
 The number of points in the polyline ring. More...
 
System.Collections.Generic.IList< Luciad.Cartesian.CoordinatePoints [get]
 The list of points of this polyline ring. More...
 
- Properties inherited from Luciad.Geometries.CompositeRing
uint CurveCount [get]
 The number of curves in this composite. More...
 
- Properties inherited from Luciad.Geometries.Curve
double Length2D [get]
 The length of the curve. More...
 
- Properties inherited from Luciad.Geometries.Geometry
Luciad.Geometries.Bounds Bounds [get]
 The bounds for the geometry object. More...
 
Luciad.Geodesy.CoordinateReference Reference [get]
 The coordinate reference of the geometry. More...
 

Detailed Description

Represents a polyline that is closed, i.e., the first point and the last point coincide.

See also
GeometryFactory.CreatePolylineRing

Member Function Documentation

◆ GetPoint()

Luciad.Cartesian.Coordinate Luciad.Geometries.PolylineRing.GetPoint ( uint  index)
inline

Returns the coordinate for the requested index.

Parameters
indexthe index of the requested point.
Returns
the point at the index.
Exceptions
System.ArgumentExceptionwhen requesting an invalid index.

◆ InsertPoint()

Luciad.Geometries.PolylineRing Luciad.Geometries.PolylineRing.InsertPoint ( uint  index,
Luciad.Cartesian.Coordinate  newLocation 
)
inline

Creates a new PolylineRing with an newly inserted control point.

Parameters
indexthe index of the newly inserted control point. Should be in [0, getPointCount()]. For index 0, a new point will be added at the start of the Polyline ring. For index getPointCount(), a new point is added at the end of the Polyline ring. For other index values, a new point will be added between the point at specified (index-1) and the point at the index position.
newLocationthe location of the new point
Returns
a new geometry
Exceptions
System.ArgumentExceptionfor an invalid index
Since
2020.1

◆ MovePoint()

Luciad.Geometries.PolylineRing Luciad.Geometries.PolylineRing.MovePoint ( uint  index,
Luciad.Cartesian.Coordinate  newLocation 
)
inline

Creates a new PolylineRing with a moved control point.

Parameters
indexthe index of the point to move. Should be in [0, getPointCount() - 1].
newLocationthe new location of the point
Returns
a new geometry
Exceptions
System.ArgumentExceptionfor an invalid index
Since
2020.1

◆ RemovePoint()

Luciad.Geometries.PolylineRing Luciad.Geometries.PolylineRing.RemovePoint ( uint  index)
inline

Creates a new PolylineRing with a control point removed.

This methods returns a copy of the polyline ring if its point count is less or equal to 3.

Parameters
indexthe index of the point to be removed. Should be in [0, getPointCount() - 1].
Returns
a new geometry
Exceptions
System.ArgumentExceptionfor an invalid index
Since
2020.1

◆ Translate()

Luciad.Geometries.PolylineRing Luciad.Geometries.PolylineRing.Translate ( Luciad.Cartesian.Coordinate  translation)
inline

Translates the entire polyline ring.

Note: when the polyline ring is defined in a geodetic reference and uses geodetic interpolation, the translation is not performed by translating the points one by one. Instead, a translation method is used that better preserves the shape of the polyline ring when moving it towards (or away from) the poles.

Parameters
translationthe translation vector
Returns
a new, translated geometry
Since
2020.1

Property Documentation

◆ InterpolationType

Luciad.Geodesy.LineInterpolationType Luciad.Geometries.PolylineRing.InterpolationType
get

The interpolation type of the line segment.

[get]

Returns the interpolation type of the line segment. One of

◆ PointCount

uint Luciad.Geometries.PolylineRing.PointCount
get

The number of points in the polyline ring.

[get]

Returns the number of points in the polyline ring.

◆ Points

System.Collections.Generic.IList<Luciad.Cartesian.Coordinate> Luciad.Geometries.PolylineRing.Points
get

The list of points of this polyline ring.

[get]

Returns the list of points of this polyline ring.