T_Rhino_Geometry_Plane - mcneel/rhinocommon-api-docs GitHub Wiki

Plane Structure

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

Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public struct Plane : IEquatable<Plane>

VB

<SerializableAttribute>
Public Structure Plane
	Implements IEquatable(Of Plane)

The Plane type exposes the following members.

Constructors

 

Name Description
Public method Plane(Plane) Copy constructor. This is nothing special and performs the same as assigning to another variable.
Public methodCode example Plane(Point3d, Vector3d) Constructs a plane from a point and a normal vector.
Public methodCode example Plane(Point3d, Point3d, Point3d) Initializes a plane from three non-colinear points.
Public method Plane(Point3d, Vector3d, Vector3d) Constructs a plane from a point and two vectors in the plane.
Public method Plane(Double, Double, Double, Double) Constructs a plane from an equation ax+by+cz=d.
  Back to Top

Properties

 

Name Description
Public property 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 zaxis.
Public property Normal Gets the normal of this plane. This is essentially the ZAxis of the plane.
Public property Origin Gets or sets the origin point of this plane.
Public property OriginX Gets or sets the X coordinate of the origin of this plane.
Public property OriginY Gets or sets the Y coordinate of the origin of this plane.
Public property OriginZ Gets or sets the Z coordinate of the origin of this plane.
Public propertyStatic member Unset Gets a plane that contains Unset origin and axis vectors.
Public propertyStatic member WorldXY plane coincident with the World XY plane.
Public propertyStatic member WorldYZ plane coincident with the World YZ plane.
Public propertyStatic member WorldZX plane coincident with the World ZX plane.
Public property XAxis Gets or sets the X axis vector of this plane.
Public property YAxis Gets or sets the Y axis vector of this plane.
Public property ZAxis Gets or sets the Z axis vector of this plane.
  Back to Top

Methods

 

Name Description
Public methodCode example ClosestParameter Gets the parameters of the point on the plane closest to a test point.
Public method ClosestPoint Gets the point on the plane closest to a test point.
Public methodCode example DistanceTo(Point3d) Returns the signed distance from testPoint to its projection onto this plane. If the point is below the plane, a negative distance is returned.
Public method DistanceTo(BoundingBox, Double, Double) Returns the signed minimum and maximum distances from bbox to this plane.
Public method EpsilonEquals Check that all values in other are within epsilon of the values in this
Public method Equals(Object) Determines if an object is a plane and has the same components as this plane. (Overrides ValueType.Equals(Object).)
Public method Equals(Plane) Determines if another plane has the same components as this plane.
Public method ExtendThroughBox(BoundingBox, Interval, Interval) Extends this plane through a bounding box.
Public method ExtendThroughBox(Box, Interval, Interval) Extend this plane through a Box.
Public methodStatic member FitPlaneToPoints(IEnumerable(Point3d), Plane) Fit a plane through a collection of points.
Public methodStatic member FitPlaneToPoints(IEnumerable(Point3d), Plane, Double) Fit a plane through a collection of points.
Public method Flip Flip this plane by swapping out the X and Y axes and inverting the Z axis.
Public method GetHashCode Gets a non-unique hashing code for this entity. (Overrides ValueType.GetHashCode().)
Public method GetPlaneEquation Gets the plane equation for this plane in the format of Ax+By+Cz+D=0.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method PointAt(Double, Double) Evaluate a point on the plane.
Public method PointAt(Double, Double, Double) Evaluate a point on the plane.
Public method RemapToPlaneSpace Convert a point from World space coordinates into Plane space coordinates.
Public method Rotate(Double, Vector3d) Rotate the plane about its origin point.
Public method Rotate(Double, Vector3d, Point3d) Rotate the plane about a custom anchor point.
Public method Rotate(Double, Double, Vector3d) Rotate the plane about its origin point.
Public method Rotate(Double, Double, Vector3d, Point3d) Rotate the plane about a custom anchor point.
Public method ToString Constructs the string representation of this plane. (Overrides ValueType.ToString().)
Public method Transform Transform the plane with a Transformation matrix.
Public method Translate Translate (move) the plane along a vector.
Public method UpdateEquation Update Equations
Public method ValueAt Get the value of the plane equation at the point.
  Back to Top

Operators

 

Name Description
Public operatorStatic member Equality Determines if two planes are equal.
Public operatorStatic member Inequality Determines if two planes are different.
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️