Cone

class compas.geometry.Cone

Bases: Shape

A cone is defined by a frame, radius, and height.

The cone is oriented along the z-axis of the frame. The base point of the cone (i.e. the centre of the base circle) is at the origin of the frame. The entire cone is in the positive z-direction.

Parameters:

framecompas.geometry.Frame, optional

The local coordinate system of the cone. Default is None, in which case the world coordinate system is used.

radiusfloat, optional

The radius of the base of the cone.

heightfloat, optional

The height of the cone along the z-axis of the frame. The base of the cone is at the origin of the frame. The entire cone is above the XY plane of the frame.

namestr, optional

The name of the shape.

Examples

>>> frame = Frame.worldXY()
>>> cone = Cone(frame=frame, radius=0.3, height=1.0)
>>> cone = Cone(radius=0.3, height=1.0)
>>> cone = Cone()

Attributes:

areafloat, read-only

The surface area of the cone.

axiscompas.geometry.Line, read-only

The central axis of the cone.

basecompas.geometry.Point, read-only

The base point of the cone. The base point is at the origin of the local coordinate system.

circlecompas.geometry.Circle, read-only

The base circle of the cone. The center of the circle is at the origin of the local coordinate system.

diameterfloat, read-only

The diameter of the base circle of the cone.

framecompas.geometry.Frame

The local coordinate system of the cone. The cone is oriented along the local z-axis.

heightfloat

The height of the cone.

planecompas.geometry.Plane, read-only

The plane of the cone. The base point of the plane is at the origin of the local coordinate system. The normal of the plane is in the direction of the z-axis of the local coordinate system.

radiusfloat

The radius of the base circle of the cone.

transformationcompas.geometry.Transformation

The transformation of the cone to global coordinates.

volumefloat, read-only

The volume of the cone.

Methods

from_circle_and_height	Construct a cone from a circle and a height.
from_line_and_radius	Construct a cone from a line and a radius.
to_brep	Returns a BRep representation of the cone.
to_vertices_and_faces	Returns a list of vertices and faces.

Inherited Methods

ToString	Converts the instance to a string.
compute_aabb	Compute the axis-aligned bounding box of the geometry.
compute_obb	Compute the oriented bounding box of the geometry.
contains_point	Verify if a point is inside the shape.
contains_points	Verify if a list of points are inside the shape.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
rotate	Rotate the shape.
rotated	Returns a rotated copy of this geometry.
scale	Scale the shape.
scaled	Returns a scaled copy of this geometry.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
to_polyhedron	Convert the shape to a polyhedron.
transform	Transform the shape.
transformed	Returns a transformed copy of this geometry.
translate	Translate the shape.
translated	Returns a translated copy of this geometry.
validate_data	Validate the data against the object's data schema.