Line
|
This class represents line segments in 3D
space. For more information, see Working with Lines.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.GeometryEntity3d
Teigha.GeometryCurve3d
Teigha.GeometryLinearEntity3d
Teigha.GeometryLineSegment3d
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.GeometryEntity3d
Teigha.GeometryCurve3d
Teigha.GeometryLinearEntity3d
Teigha.GeometryLineSegment3d
Namespace: Teigha.Geometry
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 24.2.0.0
Syntax
The LineSegment3d type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
LineSegment3d | Default constructor for the LineSegment3d class. Creates a default corresponding C++ object with the lower parameter set to 0.0 and the upper parameter set to 1.0. |
|
|
LineSegment3d(Point3d, Point3d) | Constructor for the LineSegment3d class. Creates a line segment with two specified points. |
|
|
LineSegment3d(Point3d, Vector3d) | Constructor for the LineSegment3d class. Creates a line segment with a point and vector. |
Properties
| Name | Description | |
|---|---|---|
|
AutoDelete | (Inherited from DisposableWrapper) |
|
|
BoundBlock | (Inherited from Curve3d) |
|
|
Direction | (Inherited from LinearEntity3d) |
|
|
EndPoint | |
|
|
HasEndPoint | (Inherited from Curve3d) |
|
|
HasStartPoint | (Inherited from Curve3d) |
|
|
IsDisposed | (Inherited from DisposableWrapper) |
|
|
Length | |
|
|
MidPoint | |
|
|
OrthoBoundBlock | (Inherited from Curve3d) |
|
|
PointOnLine | (Inherited from LinearEntity3d) |
|
|
StartPoint | |
|
|
UnmanagedObject | (Inherited from DisposableWrapper) |
Methods
| Name | Description | |
|---|---|---|
|
|
BaryComb | |
|
|
Clone | Clones this entity and returns a handle to the cloned
entity. (Inherited from Entity3d) |
|
Create | Creates an object based on the passed pointer and returns a handle to the created object. |
|
|
CreateObjRef | Creates an object that contains all the relevant information
required to generate a proxy used to communicate with a remote
object. (Inherited from MarshalByRefObject) |
|
|
Dispose | (Inherited from DisposableWrapper) |
|
|
Equals | (Inherited from DisposableWrapper) |
|
|
EvaluatePoint | Retrieves the point on the curve corresponding to the specified
parameter value. (Inherited from Curve3d) |
|
|
Explode | Explodes the curve into its component sub-curves. (Inherited from Curve3d) |
|
|
GetArea(Double, Double) | Retrieves the area of the parametric interval defined by the
passed start and end parameters. (Inherited from Curve3d) |
|
|
GetArea(Double, Double, Tolerance) | Retrieves the area of the parametric interval defined by the
passed start and end parameters. (Inherited from Curve3d) |
|
|
GetBisector | Returns the unbounded perpendicular bisecting plane of this line segment. |
|
|
GetBoundBlockOf | Retrieves the oriented bounding box of the specified
sub-interval of this curve. (Inherited from Curve3d) |
|
|
GetClosestPointTo(Curve3d) | Retrieves the closest points between this curve and the passed
curve. (Inherited from Curve3d) |
|
|
GetClosestPointTo(Point3d) | Retrieves the closest point on this curve to the specified
point. (Inherited from Curve3d) |
|
|
GetClosestPointTo(Curve3d, Tolerance) | Retrieves the closest points between this curve and the passed
curve within a specified tolerance. (Inherited from Curve3d) |
|
|
GetClosestPointTo(Point3d, Tolerance) | Retrieves the closest point on this curve to the specified
point within a specified tolerance. (Inherited from Curve3d) |
|
|
GetDistanceTo(Curve3d) | Retrieves the distance of the closest points between this curve
and the passed curve. (Inherited from Curve3d) |
|
|
GetDistanceTo(Point3d) | Retrieves the distance of the closest point on this curve and
the specified point. (Inherited from Curve3d) |
|
|
GetDistanceTo(Curve3d, Tolerance) | Retrieves the distance of the closest points between this curve
and the passed curve within a specified tolerance. (Inherited from Curve3d) |
|
|
GetDistanceTo(Point3d, Tolerance) | Retrieves the distance of the closest point on this curve and
the specified point within a specified tolerance. (Inherited from Curve3d) |
|
|
GetHashCode | (Inherited from DisposableWrapper) |
|
|
GetInterval | Retrieves the parametric interval of this curve. (Inherited from Curve3d) |
|
|
GetLength | Retrieves the arc length of the curve between the two parameter
values. (Inherited from Curve3d) |
|
|
GetLifetimeService | Retrieves the current lifetime service object that controls the
lifetime policy for this instance. (Inherited from MarshalByRefObject) |
|
|
GetLine | Returns an infinite line that is colinear with this linear
entity. (Inherited from LinearEntity3d) |
|
|
GetNormalPoint(Point3d) | Retrieves the point on this curve where normal extends through
the passed point. (Inherited from Curve3d) |
|
|
GetNormalPoint(Point3d, Tolerance) | Retrieves the point on this curve where normal extends through
the passed point within the specified tolerance. (Inherited from Curve3d) |
|
|
GetOrthoBoundBlockOf | Retrieves the bounding box of the specified parametric range of
this curve. Bounding box sides are parallel to the coordinate
axes. (Inherited from Curve3d) |
|
|
GetOrthoProjectEntity(Plane) | Retrieves the entity representing the curve's orthogonal
projection onto the projection plane. (Inherited from Curve3d) |
|
|
GetOrthoProjectEntity(Plane, Tolerance) | Retrieves the entity representing the curve's orthogonal
projection onto the projection plane. (Inherited from Curve3d) |
|
|
GetParameterAtLength | Retrieves the parameter value of the point whose arc length
distance is the input length. (Inherited from Curve3d) |
|
|
GetParameterOf(Point3d) | Retrieves the parameter value of a point. (Inherited from Curve3d) |
|
|
GetParameterOf(Point3d, Tolerance) | Retrieves the parameter value of a point within a specified
tolerance. (Inherited from Curve3d) |
|
|
GetPerpendicularPlane | Returns a plane that is perpendicular to this linear entity at
the specified point. (Inherited from LinearEntity3d) |
|
|
GetProjectedClosestPointTo(Curve3d, Vector3d) | Retrieves the point on this curve closest to the specified
curve, and the point on the passed curve closest to this curve,
when this curve is projected in the specified direction. (Inherited from Curve3d) |
|
|
GetProjectedClosestPointTo(Point3d, Vector3d) | Retrieves the point on this curve closest to the specified
point when projected in the specified direction. (Inherited from Curve3d) |
|
|
GetProjectedClosestPointTo(Curve3d, Vector3d, Tolerance) | Retrieves the points on this curve closest to the specified
curve, and the point on the other curve closest to this curve, when
this curve is projected in the specified direction. (Inherited from Curve3d) |
|
|
GetProjectedClosestPointTo(Point3d, Vector3d, Tolerance) | Retrieves the point on this curve closest to the specified
point when projected in the specified direction. (Inherited from Curve3d) |
|
|
GetProjectedEntity(Plane, Vector3d) | Retrieves the entity representing the curve's projection onto
the projection plane. (Inherited from Curve3d) |
|
|
GetProjectedEntity(Plane, Vector3d, Tolerance) | Retrieves the entity representing the curve's projection onto
the projection plane. (Inherited from Curve3d) |
|
|
GetReverseParameterCurve | Reverses the parameter *direction* of this *curve*. (Inherited from Curve3d) |
|
|
GetSamplePoints(Int32) | Retrieves an array of sample points along this curve. (Inherited from Curve3d) |
|
|
GetSamplePoints(Double, Double, Double) | Retrieves specified arrays of sample points along this curve
and their parameter values. (Inherited from Curve3d) |
|
|
GetSplitCurves | Retrieves two segments of this curve split at the specified
parameter value. (Inherited from Curve3d) |
|
|
GetTrimmedOffset(Double, Vector3d, OffsetCurveExtensionType) | Receives one or more offset curves that represent the trimmed
offset of the curve. (Inherited from Curve3d) |
|
|
GetTrimmedOffset(Double, Vector3d, OffsetCurveExtensionType, Tolerance) | Receives one or more offset curves that represent the trimmed
offset of the curve. (Inherited from Curve3d) |
|
|
GetType | Gets the Type of the current
instance. (Inherited from Object) |
|
|
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime
policy for this instance. (Inherited from MarshalByRefObject) |
|
|
IntersectWith(LinearEntity3d) | Calculates an intersection point with the specified line. (Inherited from LinearEntity3d) |
|
|
IntersectWith(PlanarEntity) | Calculates an intersection point with the specified
plane. (Inherited from LinearEntity3d) |
|
|
IntersectWith(LinearEntity3d, Tolerance) | Calculates an intersection point with the specified line
according to a geometry tolerance. (Inherited from LinearEntity3d) |
|
|
IntersectWith(PlanarEntity, Tolerance) | Calculates an intersection point with the specified plane
according to a geometry tolerance. (Inherited from LinearEntity3d) |
|
|
IsClosed | Checks whether the curve is closed. (Inherited from Curve3d) |
|
|
IsClosed(Tolerance) | Checks whether the curve is closed within a specified
tolerance. (Inherited from Curve3d) |
|
|
IsColinearTo(LinearEntity3d) | Checks whether the specified line is colinear to this linear
entity. (Inherited from LinearEntity3d) |
|
|
IsColinearTo(LinearEntity3d, Tolerance) | Checks whether the specified line is colinear to this linear
entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsCoplanarWith(Curve3d, Plane) | Checks whether the specified curve entity is coplanar with this
curve and returns the common plane. (Inherited from Curve3d) |
|
|
IsCoplanarWith(Curve3d, Plane, Tolerance) | Checks whether the specified curve entity is coplanar with this
curve and returns the common plane. (Inherited from Curve3d) |
|
|
IsDegenerate(Entity3d) | Checks whether this curve is degenerate and returns the type of
entity that the curve degenerates to (if degenerate). (Inherited from Curve3d) |
|
|
IsDegenerate(Entity3d, Tolerance) | Checks whether this curve is degenerate and returns the type of
entity that the curve degenerates to (if degenerate). (Inherited from Curve3d) |
|
|
IsEqualTo(Entity3d) | Checks whether this entity is equal to the specified
entity. (Inherited from Entity3d) |
|
|
IsEqualTo(Entity3d, Tolerance) | Checks whether this entity is equal to the specified entity
within a geometric tolerance. (Inherited from Entity3d) |
|
|
IsLinear(Line3d) | Checks whether this curve is linear. (Inherited from Curve3d) |
|
|
IsLinear(Line3d, Tolerance) | Checks whether this curve is linear within a specified
tolerance. (Inherited from Curve3d) |
|
|
IsOn(Double) | Checks whether a specified parameter value is within a valid
parametric range of the curve. (Inherited from Curve3d) |
|
|
IsOn(Plane) | Checks whether this linear entity lies on the specified
plane. (Inherited from LinearEntity3d) |
|
|
IsOn(Point3d) | Checks whether a specified point lies on this curve. (Inherited from Curve3d) |
|
|
IsOn(Double, Tolerance) | Checks whether a specified parameter value is within a valid
parametric range of the curve. (Inherited from Curve3d) |
|
|
IsOn(Plane, Tolerance) | Checks whether this linear entity lies on the specified plane
according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsOn(Point3d, Double) | Checks whether a specified point lies on this curve. (Inherited from Curve3d) |
|
|
IsOn(Point3d, Tolerance) | Checks whether a specified point lies on this curve within a
specified tolerance. (Inherited from Curve3d) |
|
|
IsOn(Point3d, Double, Tolerance) | Checks whether a specified point lies on this curve. (Inherited from Curve3d) |
|
|
IsParallelTo(LinearEntity3d) | Checks whether the specified line is parallel to this linear
entity. (Inherited from LinearEntity3d) |
|
|
IsParallelTo(PlanarEntity) | Checks whether the specified plane is parallel to this linear
entity. (Inherited from LinearEntity3d) |
|
|
IsParallelTo(LinearEntity3d, Tolerance) | Checks whether the specified line is parallel to this linear
entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsParallelTo(PlanarEntity, Tolerance) | Checks whether the specified plane is parallel to this linear
entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsPeriodic | Checks whether the curve is periodic. (Inherited from Curve3d) |
|
|
IsPerpendicularTo(LinearEntity3d) | Checks whether the specified line is perpendicular to this
linear entity. (Inherited from LinearEntity3d) |
|
|
IsPerpendicularTo(PlanarEntity) | Checks whether the specified plane is perpendicular to this
linear entity. (Inherited from LinearEntity3d) |
|
|
IsPerpendicularTo(LinearEntity3d, Tolerance) | Checks whether the specified line is perpendicular to this
linear entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsPerpendicularTo(PlanarEntity, Tolerance) | Checks whether the specified plane is perpendicular to this
linear entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
IsPlanar(Plane) | Checks whether this curve is planar. If the curve is a line,
this function returns an arbitrary plane that contains the line.
The plane parameter contains meaningful data only if this function
returns a value of true. (Inherited from Curve3d) |
|
|
IsPlanar(Plane, Tolerance) | Checks whether this curve is planar within a specified
tolerance. If the curve is a line, this function returns an
arbitrary plane that contains the line. The plane parameter
contains meaningful data only if this function returns a value of
true. (Inherited from Curve3d) |
|
|
Mirror | Mirrors this entity about the specified plane. (Inherited from Entity3d) |
|
|
Overlap(LinearEntity3d) | Calculates and returns the overlap of this linear entity and
the specified line. (Inherited from LinearEntity3d) |
|
|
Overlap(LinearEntity3d, Tolerance) | Calculates and returns the overlap of this linear entity and
the specified line according to a tolerance. (Inherited from LinearEntity3d) |
|
|
ProjectedIntersectWith(LinearEntity3d, Vector3d) | Calculates the projected intersection of the specified line
with this linear entity. (Inherited from LinearEntity3d) |
|
|
ProjectedIntersectWith(LinearEntity3d, Vector3d, Tolerance) | Calculates the projected intersection of the specified line
with this linear entity according to a tolerance. (Inherited from LinearEntity3d) |
|
|
RotateBy | Rotates this entity by the specified angle about the axis
defined by the point and the vector. (Inherited from Entity3d) |
|
|
ScaleBy | Scales this entity by the scale factor about the specified
point. (Inherited from Entity3d) |
|
|
Set(Point3d, Point3d) | Specifies points for this line segment. |
|
|
Set(Point3d, Vector3d) | Specifies a point and vector for this line segment. |
|
|
Set(Curve3d, Point3d, Double) | Specifies the parameters for this line according to the arguments. |
|
|
Set(Curve3d, Curve3d, Double, Double) | Specifies the parameters for this line according to the arguments. |
|
|
SetInterval | Sets the parametric range of this curve. (Inherited from Curve3d) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object) |
|
|
TransformBy | Applies the specified 2D transformation matrix to this
entity. (Inherited from Entity3d) |
|
|
TranslateBy | Translates this entity by applying a 3D translation
vector. (Inherited from Entity3d) |
See Also