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)
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.
offset
(distance)Returns a new offset plane by a given distance.
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 geometry.
Validate the object's data against its data schema (self.DATASCHEMA).
Validate the object's data against its json schema (self.JSONSCHEMA).
worldXY
()Construct the world XY plane.