Plane

Plane struct

Represents the value of a center point and two axes in a plane in three dimensions.

Derived Classes:

Namespace: Rhino.Geometry
Plane: references

Constructors (5)

Plane(double a, double b, double c, double d)

Constructs a plane from an equation Ax+By+Cz+D=0.

Plane(Plane other)

Copy constructor.

Plane(Point3d origin, Point3d xPoint, Point3d yPoint)

Initializes a plane from three non-collinear points.

Plane(Point3d origin, Vector3d normal)

Constructs a plane from a point and a normal vector.

Plane(Point3d origin, Vector3d xDirection, Vector3d yDirection)

Constructs a plane from a point and two vectors in the plane.

Properties (13)

IsValid

Gets a value indicating whether or not this is a valid plane. A plane is considered to be valid when all fields contain reasonable information and the equation jibes with point and z-axis.

Normal

Gets the normal of this plane. This is essentially the ZAxis of the plane.

Origin

Gets or sets the origin point of this plane.

OriginX

Gets or sets the X coordinate of the origin of this plane.

OriginY

Gets or sets the Y coordinate of the origin of this plane.

OriginZ

Gets or sets the Z coordinate of the origin of this plane.

Unset

Gets a plane that contains Unset origin and axis vectors.

WorldXY

plane coincident with the World XY plane.

WorldYZ

plane coincident with the World YZ plane.

WorldZX

plane coincident with the World ZX plane.

XAxis

Gets or sets the X axis vector of this plane.

YAxis

Gets or sets the Y axis vector of this plane.

ZAxis

Gets or sets the Z axis vector of this plane.

Methods (34)

Clone()

Returns a deep copy of this instance.

ClosestParameter(Point3d testPoint, out double s, out double t)

Gets the parameters of the point on the plane closest to a test point.

ClosestPoint(Point3d testPoint)

Gets the point on the plane closest to a test point.

CreateFromFrame(Point3d origin, Vector3d xDirection, Vector3d yDirection)

Constructs a plane from a point, and two vectors in the plane.

CreateFromNormal(Point3d origin, Vector3d normal)

Constructs a plane from a point and normal vector.

CreateFromNormalYup(Point3d origin, Vector3d normal, Vector3d yDirection)

Construct a plane from a point, a normal vector, and a vector that projects to the positive YAxis.

CreateFromPoints(Point3d origin, Point3d xPoint, Point3d yPoint)

Construct a plane from three non-collinear points.

DistanceTo(BoundingBox bbox, out double min, out double max)

Returns the signed minimum and maximum distances from bounding box to this plane.

DistanceTo(Point3d testPoint)

Returns the signed distance from testPoint to its projection onto this plane. If the point is below the plane, a negative distance is returned.

EpsilonEquals(Plane other, double epsilon)

Check that all values in other are within epsilon of the values in this

Equals(object obj)

Determines if an object is a plane and has the same components as this plane.

Equals(Plane plane)

Determines if another plane has the same components as this plane.

ExtendThroughBox(BoundingBox box, out Interval s, out Interval t)

Extends this plane through a bounding box.

ExtendThroughBox(Box box, out Interval s, out Interval t)

Extend this plane through a Box.

FitPlaneToPoints(IEnumerable<Point3d> points, out Plane plane, out double maximumDeviation)

Fit a plane through a collection of points.

FitPlaneToPoints(IEnumerable<Point3d> points, out Plane plane)

Fit a plane through a collection of points.

Flip()

Flip this plane by swapping out the X and Y axes and inverting the Z axis.

GetHashCode()

Gets a non-unique hashing code for this entity.

GetPlaneEquation()

Gets the plane equation for this plane in the format of Ax+By+Cz+D=0.

IsCoplanar(Plane plane, double tolerance)

Test if this plane is co-planar with a another plane.

IsCoplanar(Plane plane)

Test if this plane is co-planar with a another plane.

PointAt(double u, double v, double w)

Evaluate a point on the plane.

PointAt(double u, double v)

Evaluate a point on the plane.

RemapToPlaneSpace(Point3d ptSample, out Point3d ptPlane)

Convert a point from World space coordinates into Plane space coordinates.

Rotate(double angle, Vector3d axis, Point3d centerOfRotation)

Rotate the plane about a custom anchor point.

Rotate(double angle, Vector3d axis)

Rotate the plane about its origin point.

Rotate(double sinAngle, double cosAngle, Vector3d axis, Point3d centerOfRotation)

Rotate the plane about a custom anchor point.

Rotate(double sinAngle, double cosAngle, Vector3d axis)

Rotate the plane about its origin point.

ToString()

Constructs the string representation of this plane.

ToString(string format,IFormatProvider formatProvider)

Transform(Transform xform)

Transform the plane with a Transformation matrix.

Translate(Vector3d delta)

Translate (move) the plane along a vector.

UpdateEquation()

Update Equations

ValueAt(Point3d p)

Get the value of the plane equation at the point.

Operators (2)

Determines if two planes are different.

Determines if two planes are equal.

Nothing found