Torus

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

Bases: Shape

A torus is defined by a plane and two radii.

Parameters
  • plane ([point, normal] | compas.geometry.Plane) – 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 torus’ plane.

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

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

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

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

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

Examples

>>> from compas.geometry import Plane
>>> from compas.geometry import Torus
>>> torus = Torus(Plane.worldXY(), 5., 2.)
>>> from compas.geometry import Plane
>>> from compas.geometry import Torus
>>> torus = Torus(Plane.worldXY(), 5, 2)
>>> sdict = {'plane': Plane.worldXY().data, 'radius_axis': 5., 'radius_pipe': 2.}
>>> sdict == torus.data
True

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.

validate_json

Validate the object's data against its json schema.