coal 3.0.2
Coal, The Collision Detection Library. Previously known as HPP-FCL, fork of FCL -- The Flexible Collision Library
Loading...
Searching...
No Matches
coal::Cone Class Reference

Cone The base of the cone is at \( z = - halfLength \) and the top is at \( z = halfLength \). More...

#include <coal/shape/geometric_shapes.h>

Inheritance diagram for coal::Cone:
coal::ShapeBasecoal::CollisionGeometry

Public Member Functions

 Cone ()
 Default constructor.
 Cone (CoalScalar radius_, CoalScalar lz_)
 Cone (const Cone &other)
virtual Coneclone () const
 Clone *this into a new Cone.
void computeLocalAABB ()
 Compute AABB.
NODE_TYPE getNodeType () const
 Get node type: a cone.
CoalScalar computeVolume () const
 compute the volume
Matrix3s computeMomentofInertia () const
 compute the inertia matrix, related to the origin
Vec3s computeCOM () const
 compute center of mass
CoalScalar minInflationValue () const
std::pair< Cone, Transform3sinflated (const CoalScalar value) const
 Inflate the cone by an amount given by value. This value can be positive or negative but must always >= minInflationValue().
Public Member Functions inherited from coal::ShapeBase
 ShapeBase ()
 ShapeBase (const ShapeBase &other)
  
ShapeBaseoperator= (const ShapeBase &other)=default
virtual ~ShapeBase ()
OBJECT_TYPE getObjectType () const
 Get object type: a geometric shape.
void setSweptSphereRadius (CoalScalar radius)
 Set radius of sphere swept around the shape. Must be >= 0.
CoalScalar getSweptSphereRadius () const
 Get radius of sphere swept around the shape. This radius is always >= 0.
Public Member Functions inherited from coal::CollisionGeometry
 CollisionGeometry ()
 CollisionGeometry (const CollisionGeometry &other)=default
 Copy constructor.
virtual ~CollisionGeometry ()
bool operator== (const CollisionGeometry &other) const
 Equality operator.
bool operator!= (const CollisionGeometry &other) const
 Difference operator.
void * getUserData () const
 get user data in geometry
void setUserData (void *data)
 set user data in geometry
bool isOccupied () const
 whether the object is completely occupied
bool isFree () const
 whether the object is completely free
bool isUncertain () const
 whether the object has some uncertainty
virtual Matrix3s computeMomentofInertiaRelatedToCOM () const
 compute the inertia matrix, related to the com

Public Attributes

CoalScalar radius
 Radius of the cone.
CoalScalar halfLength
 Half Length along z axis.
Public Attributes inherited from coal::CollisionGeometry
Vec3s aabb_center
 AABB center in local coordinate.
CoalScalar aabb_radius
 AABB radius.
AABB aabb_local
 AABB in local coordinate, used for tight AABB when only translation transform.
void * user_data
 pointer to user defined data specific to this object
CoalScalar cost_density
 collision cost for unit volume
CoalScalar threshold_occupied
 threshold for occupied ( >= is occupied)
CoalScalar threshold_free
 threshold for free (<= is free)

Additional Inherited Members

Protected Attributes inherited from coal::ShapeBase
CoalScalar m_swept_sphere_radius {0}
 Radius of the sphere swept around the shape. Default value is 0. Note: this property differs from inflated method of certain derived classes (e.g. Box, Sphere, Ellipsoid, Capsule, Cone, Cylinder) in the sense that inflated returns a new shape which can be inflated but also deflated. Also, an inflated shape is not rounded. It simply has a different size. Sweeping a shape with a sphere is a different operation (a Minkowski sum), which rounds the sharp corners of a shape. The swept sphere radius is a property of the shape itself and can be manually updated between collision checks.

Detailed Description

Cone The base of the cone is at \( z = - halfLength \) and the top is at \( z = halfLength \).


The documentation for this class was generated from the following file: