Capsule

class compas.geometry.Capsule(line, radius, **kwargs)[source]

Bases: Shape

A capsule is defined by a line segment and a radius.

Parameters

• line ([point, point] | Line) – The axis line of the capsule.

• radius (float) – The radius of the capsule.

Attributes

• line (Line) – The centre line of the capsule.

• radius (float) – The radius of the capsule.

• start (Point, read-only) – The start point of the centre line.

• end (Point, read-only) – The end point of the centre line.

• length (float, read-only) – The length of the centre line of the capsule.

• volume (float, read-only) – The volume of the capsule.

• area (float, read-only) – The area of the capsule surface.

Examples

>>> line = Line((1, 2, 3), (5, 3, 1))
>>> capsule = Capsule(line, 2.3)

Methods

from_data	Construct a capsule from its data representation.
to_vertices_and_faces	Returns a list of vertices and faces.
transform	Transform this Capsule using a given transformation.

Inherited Methods

ToString	Converts the instance to a string.
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.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
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.
validate_json	Validate the object's data against its json schema.