Cylinder
-
class
compas.geometry.
Cylinder
(circle, height)[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
__init__
(circle, height)Initialize self.
copy
()Makes a copy of this primitive.
from_data
(data)Construct a cylinder from its data representation.
from_json
(filepath)Construct a primitive from structured data contained in a json file.
to_data
()Returns the data dictionary that represents the primitive.
to_json
(filepath)Serialise the structured data representing the primitive to json.
Returns a list of vertices and faces.
transform
(transformation)Transform the cylinder.
transformed
(transformation)Returns a transformed copy of this primitive.
Validate the data of this object against its data schema (self.DATASCHEMA).
Validate the data loaded from a JSON representation of the data of this object against its data schema (self.DATASCHEMA).