compas.geometry.Capsule

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

Bases: compas.geometry.shapes._shape.Shape

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

Parameters

  • line (tuple or compas.geometry.Line) – The axis line of the capsule.

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

Attributes

  • line (compas.geometry.Line) – The axis line of the capsule.

  • start (compas.geometry.Point) – The start point of the axis line. This is the base point of the capsule.

  • end (compas.geometry.Point) – The end point of the axis line. This is the top of the capsule.

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

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

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

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

Examples

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

Methods

copy([cls])

Make an independent copy of the data object.

from_data(data)

Construct a capsule 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, v])

Returns a list of vertices and faces.

transform(transformation)

Transform this Capsule using a given transformation.

transformed(transformation)

Returns a transformed copy of this primitive.

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

Attributes

DATASCHEMA

The schema of the data of this object.

JSONSCHEMA

The schema of the JSON representation of the data of this object.

area

data

Returns the data dictionary that represents the capsule.

dtype

The type of the object in the form of a “2-level” import and a class name.

end

guid

The globally unique identifier of the object.

length

line

name

The name of the object.

radius

The radius of the capsule.

start

volume