Circle

class compas.geometry.Circle(plane, radius)[source]

Bases: compas.geometry.primitives._primitive.Primitive

A circle is defined by a plane and a radius.

Parameters

  • plane (compas.geometry.Plane or tuple of point and normal) – The plane of the circle.

  • radius (float) – The radius of the circle.

Attributes

  • plane (compas.geometry.Plane) – The plane of the circle.

  • radius (float) – The radius.

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

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

  • diameter (float, read-only) – The diameter of the circle.

  • circumference (float, read-only) – The circumference of the circle.

  • area (float, read-only) – The area of the circle.

Examples

>>> from compas.geometry import Plane
>>> from compas.geometry import Circle
>>> plane = Plane([0, 0, 0], [0, 0, 1])
>>> circle = Circle(plane, 5)

Methods

from_data(data)

Construct a circle from its data representation.

transform(T)

Transform the circle.

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