Cylinder

class compas.robots.Cylinder(radius, length)[source]

Bases: compas.robots.model.geometry.BaseShape

3D shape primitive representing a cylinder.

Parameters

  • radius (str or float) – The cylinder’s radius.

  • length (str or float) – The cylinder’s length.

Attributes

  • radius (float) – The cylinder’s radius.

  • length (float) – The cylinder’s length.

  • geometry (compas.geometry.Cylinder) – The COMPAS geometry of this cylinder.

Examples

>>> c = Cylinder(1, 4)
>>> c.geometry
Cylinder(Circle(Plane(Point(0.000, 0.000, 0.000), Vector(0.000, 0.000, 1.000)), 1.0), 4.0)

Methods

__init__(radius, length)

Initialize self.

from_data(data)

Construct an object of this type from the provided data.

from_json(filepath)

Construct an object from serialised data contained in a JSON file.

to_data()

Convert an object to its native data representation.

to_json(filepath)

Serialize the data representation of an object to a JSON file.

validate_data()

Validate the data of this object against its data schema (self.DATASCHEMA).

validate_json()

Validate the data loaded from a JSON representation of the data of this object against its data schema (self.DATASCHEMA).