Circle

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

Bases: Primitive

A circle is defined by a plane and a radius.

Parameters
  • plane ([point, vector] | compas.geometry.Plane) – 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 of the circle.

  • center (compas.geometry.Point) – The center of the circle.

  • normal (compas.geometry.Vector, read-only) – The normal of the circle.

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

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

  • circumference (float, read-only) – The circumference 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

Construct a circle from its data representation.

transform

Transform the circle.

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.

validate_json

Validate the object's data against its json schema.