Ellipse

class compas.geometry.Ellipse(plane, major, minor, **kwargs)[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)

Attributes

`DATASCHEMA`	The schema of the data of this object.
`JSONSCHEMANAME`
`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.
`major`	The major of the ellipse.
`minor`	The minor of the ellipse.
`normal`	The normal of the ellipse.
`plane`	The plane of the ellipse.

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 ellipse from its data representation.
`transform`	Transform the ellipse.

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

Ellipse

COMPAS