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

Center at zero point ellipsoid. More...

#include <ellipsoid.h>

Inheritance diagram for fcl::Ellipsoid< 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
 
 Ellipsoid (const Vector3< S > &radii)
 Constructor. More...
 
 Ellipsoid (S a, S b, S c)
 Constructor. More...
 
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...
 
- 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

Vector3< Sradii
 Radii of the ellipsoid. 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 Ellipsoid &ellipsoid)
 

Detailed Description

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

Center at zero point ellipsoid.

Definition at line 51 of file ellipsoid.h.

Member Typedef Documentation

◆ S

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

Definition at line 55 of file ellipsoid.h.

Constructor & Destructor Documentation

◆ Ellipsoid() [1/2]

template<typename S >
fcl::Ellipsoid< S >::Ellipsoid ( S  a,
S  b,
S  c 
)

Constructor.

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

◆ Ellipsoid() [2/2]

template<typename S >
fcl::Ellipsoid< S >::Ellipsoid ( const Vector3< S > &  radii)

Constructor.

Definition at line 64 of file ellipsoid-inl.h.

Member Function Documentation

◆ computeLocalAABB()

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

Compute AABB.

Implements fcl::CollisionGeometry< S_ >.

Definition at line 72 of file ellipsoid-inl.h.

◆ computeMomentofInertia()

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

Definition at line 90 of file ellipsoid-inl.h.

◆ computeVolume()

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

Definition at line 103 of file ellipsoid-inl.h.

◆ getBoundVertices()

template<typename S >
std::vector< Vector3< S > > fcl::Ellipsoid< 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 111 of file ellipsoid-inl.h.

◆ getNodeType()

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

Get node type: a sphere.

Definition at line 83 of file ellipsoid-inl.h.

◆ representation()

template<typename S >
std::string fcl::Ellipsoid< 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 152 of file ellipsoid-inl.h.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 90 of file ellipsoid.h.

Member Data Documentation

◆ radii

template<typename S_ >
Vector3<S> fcl::Ellipsoid< S_ >::radii

Radii of the ellipsoid.

Definition at line 64 of file ellipsoid.h.


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


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