compas.geometry.Torus

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

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

Examples

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

Methods

`copy`([cls])	Make an independent copy of the data object.
`from_data`(data)	Construct a torus 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.
`to_vertices_and_faces`([u, v])	Returns a list of vertices and faces
`transform`(transformation)	Transform the torus.
`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 surface area of the torus.
`center`
`data`	Returns the data dictionary that represents the torus.
`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.
`name`	The name of the object.
`plane`	The torus’ plane.
`radius_axis`	The radius of the axis.
`radius_pipe`	The radius of the pipe.
`volume`	The volume of the torus.