compas.geometry.Ellipse

class compas.geometry.Ellipse(plane, major, minor)[source]

Bases: compas.geometry.primitives._primitive.Primitive

A ellipse is defined by a plane and a major.

Parameters

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

  • major (float) – The major of the ellipse.

Attributes

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

  • major (float) – The major.

  • minor (float) – The minor.

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

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

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

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

Examples

>>> from compas.geometry import Plane
>>> from compas.geometry import Ellipse
>>> plane = Plane([0, 0, 0], [0, 0, 1])
>>> ellipse = Ellipse(plane, 2, 1)

Methods

copy([cls])

Make an independent copy of the data object.

from_data(data)

Construct a ellipse 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 ellipse.

transformed(transformation)

Returns a transformed copy of this primitive.

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

Attributes

DATASCHEMA

The schema of the data of this object.

JSONSCHEMA

The schema of the JSON representation of the data of this object.

area

The area of the ellipse.

center

The center of the ellipse.

circumference

The circumference of the ellipse.

data

The data dictionary that represents the ellipse.

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.

major

The major of the ellipse.

minor

The minor of the ellipse.

name

The name of the object.

normal

The normal of the ellipse.

plane

The plane of the ellipse.