Torus

class compas.geometry.Torus(plane, radius_axis, radius_pipe, **kwargs)[source]

Bases: compas.geometry.shapes._shape.Shape

A torus is defined by a plane and two radii.

Parameters

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

• radius_axis (float) – The radius of the axis.

• radius_pipe (float) – The radius of the pipe.

Attributes

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

• radius_axis (float) – The radius of the axis.

• radius_pipe (float) – The radius of the pipe.

• center (read-only) (compas.geometry.Point) – The center of the torus.

• area (read-only) (float) – The surface area of the torus.

• volume (read-only) (float) – The volume of the torus.

Examples

>>> from compas.geometry import Plane
>>> from compas.geometry import Torus
>>> torus = Torus(Plane.worldXY(), 5., 2.)

Attributes

DATASCHEMA	The schema of the data of this object.
JSONSCHEMANAME
area	The surface area of the torus.
center
data	Returns the data dictionary that represents the torus.
plane	The torus' plane.
radius_axis	The radius of the axis.
radius_pipe	The radius of the pipe.
volume	The volume of the torus.

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 torus from its data representation.
to_vertices_and_faces	Returns a list of vertices and faces
transform	Transform the torus.

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