Cylinder

class compas.geometry.Cylinder(circle, height, **kwargs)[source]

Bases: compas.geometry.shapes._shape.Shape

A cylinder is defined by a circle and a height.

Parameters

circle (compas.geometry.Circle) – The circle of the cylinder.
height (float) – The height of the cylinder.

Attributes

plane (compas.geometry.Plane) – The plane containing the circle.
circle (compas.geometry.Circle) – The base circle of the cylinder.
radius (float) – The radius of the base circle.
height (float) – The height of the cylinder.
normal (read-only) (compas.geometry.Vector) – The normal of the base plane.
diameter (float) – The diameter of the cylinder.

Examples

>>> from compas.geometry import Plane
>>> from compas.geometry import Cylinder
>>> plane = Plane([0, 0, 0], [0, 0, 1])
>>> circle = Circle(plane, 5)
>>> cylinder = Cylinder(circle, 7)

Attributes

`DATASCHEMA`	The schema of the data of this object.
`JSONSCHEMANAME`
`area`	The surface area of the cylinder.
`center`	The center of the cylinder.
`circle`	The circle of the cylinder.
`data`	Returns the data dictionary that represents the cylinder.
`diameter`	The diameter of the cylinder.
`height`	The height of the cylinder.
`normal`	The normal of the cylinder.
`plane`	The plane of the cylinder.
`radius`	The radius of the cylinder.
`volume`	The volume of the cylinder.

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

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

Cylinder

COMPAS