Plane
- class compas.geometry.Plane[source]
Bases:
Geometry
A plane is defined by a base point and a normal vector.
- Parameters:
- point[float, float, float] |
compas.geometry.Point
The base point of the plane.
- normal[float, float, float] |
compas.geometry.Vector
The normal vector of the plane.
- namestr, optional
The name of the plane.
- point[float, float, float] |
Examples
>>> plane = Plane([0, 0, 0], [0, 0, 1]) >>> plane.point Point(0.000, 0.000, 0.000) >>> plane.normal Vector(0.000, 0.000, 1.000)
- Attributes:
- abcdlist[float], read-only
The coefficients of the plane equation.
- dfloat, read-only
The d parameter of the linear equation describing the plane.
- normal
compas.geometry.Vector
The normal vector of the plane.
- point
compas.geometry.Plane
The base point of the plane.
Methods
Compute the closest point on the plane to a given point.
Verify if a given point lies in the plane.
Compute the distance from a given point to the plane.
Construct a plane from the plane equation coefficients.
Construct a plane from a frame.
Construct a plane from a base point and two vectors.
Construct a plane from a list of points.
Construct a plane from three points in three-dimensional space.
Compute the intersection of a plane and a line.
Compute the intersection of two planes.
Compute the intersection of a plane and a curve.
Verify if this plane is parallel to another plane.
Verify if this plane is perpendicular to another plane.
Returns the mirror image of a given point.
Returns a new offset plane by a given distance.
Returns the projection of a given point onto the plane.
Transform this plane.
Construct the world XY plane.
Construct the world YZ plane.
Construct the world ZX plane.
Inherited Methods
Converts the instance to a string.
Compute the axis-aligned bounding box of the geometry.
Compute the oriented bounding box of the geometry.
Make an independent copy of the data object.
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Rotate the geometry.
Returns a rotated copy of this geometry.
Scale the geometry.
Returns a scaled copy of this geometry.
Compute a hash of the data for comparison during version control using the sha256 algorithm.
Convert an object to its native data representation and save it to a JSON file.
Convert an object to its native data representation and save it to a JSON string.
Returns a transformed copy of this geometry.
Translate the geometry.
Returns a translated copy of this geometry.
Validate the data against the object's data schema.