Plane

class compas.geometry.Plane(point, normal, **kwargs)[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)

Attributes

DATASCHEMA	The schema of the data of this object.
JSONSCHEMANAME
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.
normal	The normal vector of the plane.
point	The base point of the plane.

Inherited Attributes

JSONSCHEMA	The schema of the JSON representation of the data of this object.
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.
jsondefinitions	Reusable schema definitions.
jsonstring	The representation of the object data in JSON format.
jsonvalidator	JSON schema validator for draft 7.
name	The name of the object.

Methods

from_abcd	Construct a plane from the plane equation coefficients.
from_data	Construct a plane from its data representation.
from_frame	Construct a plane from a frame.
from_point_and_two_vectors	Construct a plane from a base point and two vectors.
from_three_points	Construct a plane from three points in three-dimensional space.
offset	Returns a new offset plane by a given distance.
transform	Transform this plane.
worldXY	Construct the world XY plane.

Inherited Methods

copy	Make an independent copy of the data object.
from_json	Construct an object from serialized data contained in a JSON file.
from_jsonstring	Construct an object from serialized data contained in a JSON string.
to_data	Convert an object to its native data representation.
to_json	Serialize the data representation of an object to a JSON file.
to_jsonstring	Serialize the data representation of an object to a JSON string.
transformed	Returns a transformed copy of this geometry.
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).