Public Types | Public Member Functions | Public Attributes | Friends | List of all members
fcl::Sphere< S_ > Class Template Reference

Center at zero point sphere. More...

#include <sphere.h>

Inheritance diagram for fcl::Sphere< S_ >:
Inheritance graph
[legend]

Public Types

using S = S_
 
- Public Types inherited from fcl::ShapeBase< S_ >
using S = S_
 

Public Member Functions

void computeLocalAABB () override
 Compute AABB More...
 
Matrix3< ScomputeMomentofInertia () const override
 
S computeVolume () const override
 
std::vector< Vector3< S > > getBoundVertices (const Transform3< S > &tf) const
 get the vertices of some convex shape which can bound this shape in a specific configuration More...
 
NODE_TYPE getNodeType () const override
 Get node type: a sphere. More...
 
std::string representation (int precision=20) const
 Create a string that should be sufficient to recreate this shape. This is akin to the repr() implementation in python. More...
 
 Sphere (S radius)
 
- Public Member Functions inherited from fcl::ShapeBase< S_ >
OBJECT_TYPE getObjectType () const
 Get object type: a geometric shape. More...
 
 ShapeBase ()
 
- Public Member Functions inherited from fcl::CollisionGeometry< S_ >
 CollisionGeometry ()
 
virtual Vector3< S_ > computeCOM () const
 compute center of mass More...
 
virtual Matrix3< S_ > computeMomentofInertia () const
 compute the inertia matrix, related to the origin More...
 
virtual Matrix3< S_ > computeMomentofInertiaRelatedToCOM () const
 compute the inertia matrix, related to the com More...
 
virtual S_ computeVolume () const
 compute the volume More...
 
virtual NODE_TYPE getNodeType () const
 get the node type More...
 
virtual OBJECT_TYPE getObjectType () const
 get the type of the object More...
 
void * getUserData () const
 get user data in geometry More...
 
bool isFree () const
 whether the object is completely free More...
 
bool isOccupied () const
 whether the object is completely occupied More...
 
bool isUncertain () const
 whether the object has some uncertainty More...
 
void setUserData (void *data)
 set user data in geometry More...
 
virtual ~CollisionGeometry ()
 

Public Attributes

S radius
 Radius of the sphere. More...
 
- Public Attributes inherited from fcl::CollisionGeometry< S_ >
Vector3< S_ > aabb_center
 AABB center in local coordinate. More...
 
AABB< S_ > aabb_local
 AABB in local coordinate, used for tight AABB when only translation transform. More...
 
S_ aabb_radius
 AABB radius. More...
 
S_ cost_density
 collision cost for unit volume More...
 
S_ threshold_free
 threshold for free (<= is free) More...
 
S_ threshold_occupied
 threshold for occupied ( >= is occupied) More...
 
void * user_data
 pointer to user defined data specific to this object More...
 

Friends

std::ostream & operator<< (std::ostream &out, const Sphere &sphere)
 

Detailed Description

template<typename S_>
class fcl::Sphere< S_ >

Center at zero point sphere.

Definition at line 51 of file sphere.h.

Member Typedef Documentation

◆ S

template<typename S_ >
using fcl::Sphere< S_ >::S = S_

Definition at line 55 of file sphere.h.

Constructor & Destructor Documentation

◆ Sphere()

template<typename S >
fcl::Sphere< S >::Sphere ( S  radius)

Definition at line 56 of file sphere-inl.h.

Member Function Documentation

◆ computeLocalAABB()

template<typename S >
void fcl::Sphere< S >::computeLocalAABB
overridevirtual

Compute AABB

Implements fcl::CollisionGeometry< S_ >.

Definition at line 62 of file sphere-inl.h.

◆ computeMomentofInertia()

template<typename S >
Matrix3< S > fcl::Sphere< S >::computeMomentofInertia
override

Definition at line 79 of file sphere-inl.h.

◆ computeVolume()

template<typename S >
S fcl::Sphere< S >::computeVolume
override

Definition at line 88 of file sphere-inl.h.

◆ getBoundVertices()

template<typename S >
std::vector< Vector3< S > > fcl::Sphere< S >::getBoundVertices ( const Transform3< S > &  tf) const

get the vertices of some convex shape which can bound this shape in a specific configuration

Definition at line 95 of file sphere-inl.h.

◆ getNodeType()

template<typename S >
NODE_TYPE fcl::Sphere< S >::getNodeType
override

Get node type: a sphere.

Definition at line 73 of file sphere-inl.h.

◆ representation()

template<typename S >
std::string fcl::Sphere< S >::representation ( int  precision = 20) const

Create a string that should be sufficient to recreate this shape. This is akin to the repr() implementation in python.

Parameters
precisionThe requested digits of precision for the numerical measures (same semantics as std::setprecision()).
Returns
The string representation of this instance.

Definition at line 124 of file sphere-inl.h.

Friends And Related Function Documentation

◆ operator<<

template<typename S_ >
std::ostream& operator<< ( std::ostream &  out,
const Sphere< S_ > &  sphere 
)
friend

Definition at line 84 of file sphere.h.

Member Data Documentation

◆ radius

template<typename S_ >
S fcl::Sphere< S_ >::radius

Radius of the sphere.

Definition at line 60 of file sphere.h.


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


fcl
Author(s):
autogenerated on Tue Dec 5 2023 03:40:50