Plane Class |
This class represents infinite planes in 3D
space. For more information, see Working with Planes.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.GeometryEntity3d
Teigha.GeometrySurface
Teigha.GeometryPlanarEntity
Teigha.GeometryPlane
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.GeometryEntity3d
Teigha.GeometrySurface
Teigha.GeometryPlanarEntity
Teigha.GeometryPlane
Namespace: Teigha.Geometry
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 24.2.0.0
Syntax
The Plane type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
Plane | Default constructor for the Plane class. Creates a default corresponding C++ XY plane object. |
|
|
Plane(Plane) | Copy constructor for the Plane class. Copies the passed plane. |
|
|
Plane(Point3d, Vector3d) | Constructor for the Plane class. Creates a plane from a normal to the plane and plane origin. |
|
|
Plane(Point3d, Point3d, Point3d) | Constructor for the Plane class. Creates a plane with points that define the u- and v-axes and an origin point of the plane. |
|
|
Plane(Point3d, Vector3d, Vector3d) | Constructor for the Plane class. Creates a plane with points that define u- and v-axes and an origin point of the plane. |
|
|
Plane(Double, Double, Double, Double) | Constructor for the Plane class. Creates a plane with specified
coefficients for the plane equation. The plane equation for this
plane is as follows:
C#
a * x + b * y + c * z + d = 0
|
Properties
| Name | Description | |
|---|---|---|
|
AutoDelete | (Inherited from DisposableWrapper) |
|
|
Coefficients | Property that represents coefficients for the plane equation
for this plane. The plane equation for this plane is as follows:
C#
a * x + b * y + c * z + d = 0
(Inherited from PlanarEntity) |
|
|
IsDisposed | (Inherited from DisposableWrapper) |
|
|
IsNormalReversed | Property that indicates whether the normal of this surface is
reversed an odd number of times. (Inherited from Surface) |
|
|
Normal | Property that represents a normal vector to this planar
entity. (Inherited from PlanarEntity) |
|
|
PointOnPlane | Property that represents an arbitrary point on this planar
entity. (Inherited from PlanarEntity) |
|
|
ReverseNormal | Property that creates a surface with a reversed normal vector
orientation (the same exact surface but with changed normal
orientation). (Inherited from Surface) |
|
|
UnmanagedObject | (Inherited from DisposableWrapper) |
Methods
| Name | Description | |
|---|---|---|
|
|
Clone | Clones this entity and returns a handle to the cloned
entity. (Inherited from Entity3d) |
|
|
ClosestPointTo(Point3d) | Gets a point on this surface that is the closest to the
specified point. (Inherited from Surface) |
|
|
ClosestPointTo(Point3d, Tolerance) | Gets a point on this surface that is the closest to the
specified point according to a tolerance. (Inherited from Surface) |
|
|
ClosestPointToLinearEntity(LinearEntity3d) | Calculates the point on this planar entity that is closest to
the specified line and the point on the specified line that is
closest to this planar entity. (Inherited from PlanarEntity) |
|
|
ClosestPointToLinearEntity(LinearEntity3d, Tolerance) | Calculates the point on this planar entity that is closest to
the specified line and the point on the specified line that is
closest to this planar entity. (Inherited from PlanarEntity) |
|
|
ClosestPointToPlanarEntity(PlanarEntity) | Calculates the point on this planar entity that is closest to
the specified planar entity and the point on the specified planar
entity that is closest to this planar entity. (Inherited from PlanarEntity) |
|
|
ClosestPointToPlanarEntity(PlanarEntity, Tolerance) | Calculates the point on this planar entity that is closest to
the specified planar entity and the point on the specified planar
entity that is closest to this planar entity. (Inherited from PlanarEntity) |
|
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) |
|
|
DistanceTo(Point3d) | Retrieves the distance from the closest point on this plane to
the specified point. (Inherited from Surface) |
|
|
DistanceTo(Point3d, Tolerance) | Retrieves the distance from the closest point on this plane to
the specified point according to a tolerance. (Inherited from Surface) |
|
|
Equals | (Inherited from PlanarEntity) |
|
|
EvaluatePoint | Retrieves the 3D point on this surface that corresponds to the
specified point parameter value. (Inherited from Surface) |
|
|
GetClosestPointTo(Point3d) | Gets a point on this surface that is the closest to the
specified point. (Inherited from Surface) |
|
|
GetClosestPointTo(Point3d, Tolerance) | Gets a point on this surface that is the closest to the
specified point according to a tolerance. (Inherited from Surface) |
|
|
GetCoordinateSystem | Returns the orthonormal canonical coordinate system of this
plane. (Inherited from PlanarEntity) |
|
|
GetEnvelope | (Inherited from Surface) |
|
|
GetHashCode | (Inherited from DisposableWrapper) |
|
|
GetLifetimeService | Retrieves the current lifetime service object that controls the
lifetime policy for this instance. (Inherited from MarshalByRefObject) |
|
|
GetSignedDistanceTo | Returns the signed distance to (elevation of) the specified point. The sign of the result is the same as the sign of the dot product of the vector: pointValue - originOfPlane and the normal to the plane. |
|
|
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(BoundedPlane) | Returns the intersection line segment if the specified bounded plane intersects with this plane. |
|
|
IntersectWith(LinearEntity3d) | Calculates an intersection point with the specified line. (Inherited from PlanarEntity) |
|
|
IntersectWith(Plane) | Returns the intersection line segment if the specified plane intersects with this plane. |
|
|
IntersectWith(BoundedPlane, Tolerance) | Returns the intersection line segment if the specified bounded plane intersects with this plane according to a geometric tolerance. |
|
|
IntersectWith(LinearEntity3d, Tolerance) | Calculates an intersection point with the specified line. (Inherited from PlanarEntity) |
|
|
IntersectWith(Plane, Tolerance) | Returns the intersection line segment if the specified plane intersects with this plane according to a geometric tolerance. |
|
|
IsClosedInU | (Inherited from Surface) |
|
|
IsClosedInU(Tolerance) | (Inherited from Surface) |
|
|
IsClosedInV | (Inherited from Surface) |
|
|
IsClosedInV(Tolerance) | (Inherited from Surface) |
|
|
IsCoplanarTo(PlanarEntity) | Checks whether the specified planar entity is coplanar to this
entity. (Inherited from PlanarEntity) |
|
|
IsCoplanarTo(PlanarEntity, Tolerance) | Checks whether the specified planar entity is coplanar to this
entity. (Inherited from PlanarEntity) |
|
|
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) |
|
|
IsOn(Point3d) | Checks whether the specified point is on this entity. (Inherited from Entity3d) |
|
|
IsOn(Point3d, Tolerance) | Checks whether the specified point is on this entity according
to a geometric tolerance. (Inherited from Entity3d) |
|
|
IsOn(Point3d, Point2d) | (Inherited from Surface) |
|
|
IsOn(Point3d, Point2d, Tolerance) | (Inherited from Surface) |
|
|
IsParallelTo(LinearEntity3d) | Checks whether the specified linear entity is parallel to this
entity. (Inherited from PlanarEntity) |
|
|
IsParallelTo(PlanarEntity) | Checks whether the specified planar entity is parallel to this
entity. (Inherited from PlanarEntity) |
|
|
IsParallelTo(LinearEntity3d, Tolerance) | Checks whether the specified linear entity is parallel to this
entity. (Inherited from PlanarEntity) |
|
|
IsParallelTo(PlanarEntity, Tolerance) | Checks whether the specified planar entity is parallel to this
entity. (Inherited from PlanarEntity) |
|
|
IsPerpendicularTo(LinearEntity3d) | Checks whether the specified linear entity is perpendicular to
this entity. (Inherited from PlanarEntity) |
|
|
IsPerpendicularTo(PlanarEntity) | Checks whether the specified planar entity is perpendicular to
this entity. (Inherited from PlanarEntity) |
|
|
IsPerpendicularTo(LinearEntity3d, Tolerance) | Checks whether the specified linear entity is perpendicular to
this entity. (Inherited from PlanarEntity) |
|
|
IsPerpendicularTo(PlanarEntity, Tolerance) | Checks whether the specified planar entity is perpendicular to
this entity. (Inherited from PlanarEntity) |
|
|
Mirror | Mirrors this entity about the specified plane. (Inherited from Entity3d) |
|
|
ParameterOf(Point3d) | Retrieves a 2D point (U, V) that represents parametric values
for the passed 3D point on this surface. (Inherited from Surface) |
|
|
ParameterOf(Point3d, Tolerance) | Retrieves a 2D point (U, V) that represents parametric values
for the passed 3D point on this surface. (Inherited from Surface) |
|
|
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, Vector3d) | Sets the parameters for this plane according to the arguments. |
|
|
Set(Point3d, Point3d, Point3d) | Sets the parameters for this plane according to the arguments. |
|
|
Set(Point3d, Vector3d, Vector3d) | Sets the parameters for this plane according to the arguments. |
|
|
Set(Double, Double, Double, Double) | Sets the parameters for this plane according to the arguments. |
|
|
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