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

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_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.

transform(T)

Transform this plane.

worldXY()

Construct the world XY plane.

Inherited Methods

copy()

Makes a copy of this primitive.

from_json(filepath)

Construct a primitive from structured data contained in a json file.

to_data()

Returns the data dictionary that represents the primitive.

to_json(filepath)

Serialise the structured data representing the primitive to json.

transformed(transformation)

Returns a transformed copy of this primitive.

validate_data()

Validate the data of this object against its data schema (self.DATASCHEMA).

validate_json()

Validate the data loaded from a JSON representation of the data of this object against its data schema (self.DATASCHEMA).