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)

Methods

copy([cls])

Make an independent copy of the data object.

from_data(data)

Construct a cylinder 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, triangulated])

Returns a list of vertices and faces.

transform(transformation)

Transform the cylinder.

transformed(transformation)

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