compas.geometry.Plane

class compas.geometry.Plane(point, normal)[source]

Bases: compas.geometry.primitives._primitive.Primitive

A plane is defined by a base point and a normal vector.

Parameters

• point (point) – The base point of the plane.

• normal (vector) – The normal vector of the plane.

Attributes

• data (dict) – The data representation of the plane.

• point (compas.geometry.Point) – The base point of the plane.

• normal (compas.geometry.Vector) – The normal of the plane.

• d (float, read-only) – The d parameter of the equation describing the plane.

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)

Methods

copy([cls])	Make an independent copy of the data object.
from_abcd(abcd)	Construct a plane from the plane equation coefficients.
from_data(data)	Construct a plane from its data representation.
from_frame(frame)	Construct a plane from a frame.
from_json(filepath)	Construct an object from serialized data contained in a JSON file.
from_jsonstring(string)	Construct an object from serialized data contained in a JSON string.
from_point_and_two_vectors(point, u, v)	Construct a plane from a base point and two vectors.
from_three_points(a, b, c)	Construct a plane from three points in three-dimensional space.
to_data()	Convert an object to its native data representation.
to_json(filepath[, pretty])	Serialize the data representation of an object to a JSON file.
to_jsonstring([pretty])	Serialize the data representation of an object to a JSON string.
transform(T)	Transform this plane.
transformed(transformation)	Returns a transformed copy of this primitive.
validate_data()	Validate the object’s data against its data schema (self.DATASCHEMA).
validate_json()	Validate the object’s data against its json schema (self.JSONSCHEMA).
worldXY()	Construct the world XY plane.

Attributes

DATASCHEMA	The schema of the data of this object.
JSONSCHEMA	The schema of the JSON representation of the data of this object.
abcd	The coefficients of the plane equation.
d	The d parameter of the linear equation describing the plane.
data	The data dictionary that represents the plane.
dtype	The type of the object in the form of a “2-level” import and a class name.
guid	The globally unique identifier of the object.
name	The name of the object.
normal	The normal vector of the plane.
point	The base point of the plane.