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)

Attributes

DATASCHEMA	The schema of the data of this object.
JSONSCHEMANAME
area	The area of the circle.
center	The center of the circle.
circumference	The circumference of the circle.
data	The data dictionary that represents the circle.
diameter	The diameter of the circle.
normal	The normal of the circle.
plane	The plane of the circle.
radius	The radius of the circle.

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_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 (self.DATASCHEMA).
validate_json	Validate the object's data against its json schema (self.JSONSCHEMA).