LineGeometry Class
Represents a line.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class LineGeometry : VectorGeometryRemarks
A LineGeometry is a geometry that consists of a sequence of points.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Geometry
VectorGeometry
LineGeometry
Platforms
Windows, Linux, Android
LineGeometry Members
The LineGeometry type has the following members.
Constructors
| Name | Description |
|---|---|
| LineGeometry | Initializes a new instance of the LineGeometry class. |
Properties
| Name | Description |
|---|---|
| Closed | Gets or sets a value indicating whether the LineGeometry is a closed loop or not. |
| IsDisposed | Gets a value that tells whether the current LineGeometry has been disposed. Inherited from EngineObject |
| IsReadOnly | Gets a value indicating whether the LineGeometry is read-only or not. Inherited from Geometry |
| IsValid | Gets a value indicating whether the LineGeometry is valid or not. Inherited from Geometry |
| Length | Gets the 2D length of the LineGeometry. |
| Length3D | Gets the 3D length of the LineGeometry. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current LineGeometry represents. Inherited from EngineObject |
| Points | Gets all points in the LineGeometry. |
| Type | Gets the geometry type of a LineGeometry. Inherited from Geometry |
Methods
| Name | Description |
|---|---|
| BufferZone | Returns a buffer zone for the LineGeometry. |
| CalculateBounds | Returns the bounding rectangle of the Geometry. Inherited from Geometry |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
 FromWellKnownBinary | Overloaded. Initializes a new Geometry instance from a WKB representation. Inherited from Geometry |
| FromWellKnownText | Overloaded. Initializes a new Geometry instance from a WKT representation. Inherited from Geometry |
| LineIntersections | Returns all points where the current LineGeometry intersects another LineGeometry. |
| Move | Moves the Geometry by the specified offset. Inherited from Geometry |
| NearestPoint | Returns the point along the LineGeometry that is closest to the specified Point. |
| OffsetPointAlongLine | Returns a Point that has been orthogonally offset from the LineGeometry. |
| ParallelLine | Returns a LineGeometry that is parallel to this LineGeometry. |
| PointAlongLine | Overloaded. Returns a Point along the LineGeometry. |
| PointAlongLine3D | Overloaded. Returns a Point along the LineGeometry. |
| PointInside | Checks if a Point is inside the LineGeometry. |
| SegmentNearPoint | Returns the index of the segment closest to the specified Point. |
| SmoothCatmullRomSpline | Returns an approximation of a Catmull-Rom spline generated from the points in the LineGeometry. |
| SmoothCubicBezierSpline | Returns an approximation of a cubic Bezier spline generated from the points in the LineGeometry. |
| SmoothNurbSpline | Returns an approximation of a NURB spline generated from the points in the LineGeometry. |
| ToWellKnownBinary | Converts a Geometry instance into WKB representation. Inherited from Geometry |
| ToWellKnownText | Converts a Geometry instance into WKT representation. Inherited from Geometry |
| Transform | Applies a 2D transform to the geometry. Inherited from Geometry |
| Trim | Trims the front and/or back end of the line. |
| Trim3D | Trims the front and/or back end of the line. |