Circle

class compas.geometry.Circle(plane, radius, **kwargs)[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

copy([cls])

Make an independent copy of the data object.

from_data(data)

Construct a circle from its data representation.

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.

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 the circle.

transformed(transformation)

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