SOFA API  1a4bb3e7
Open source framework for multi-physics simuation
sofa::component::collision::geometry::TCylinder< TDataTypes > Class Template Reference

#include <CylinderModel.h>

Inheritance diagram for sofa::component::collision::geometry::TCylinder< TDataTypes >:

Detailed Description

template<class TDataTypes>
class sofa::component::collision::geometry::TCylinder< TDataTypes >

A Cylinder can be viewed as a segment with a radius, here the segment is defined by its apexes.

Public Member Functions

 TCylinder (ParentModel *model, Index index)
 
 TCylinder (const core::CollisionElementIterator &i)
 
Coord axis () const
 
Real radius () const
 
Coord point1 () const
 
Coord point2 () const
 
const Coordv () const
 
- Public Member Functions inherited from sofa::core::TCollisionElementIterator< CylinderCollisionModel< TDataTypes > >
 TCollisionElementIterator (Model *model=nullptr, Index index=0)
 
 TCollisionElementIterator (Model *model, Index index, VIterator it, VIterator itend)
 
 TCollisionElementIterator (Model *model, VIterator it, VIterator itend)
 
bool isActive (core::CollisionModel *cm=nullptr) const
 
bool operator== (const TCollisionElementIterator< Model2 > &i) const
 
bool operator!= (const TCollisionElementIterator< Model2 > &i) const
 
TCollisionElementIteratoroperator+= (int n)
 
TCollisionElementIterator operator+ (int n) const
 
bool valid () const
 
ModelgetCollisionModel () const
 Return the CollisionModel containing the referenced element. More...
 
std::pair< CollisionElementIterator, CollisionElementIteratorgetInternalChildren () const
 
std::pair< CollisionElementIterator, CollisionElementIteratorgetExternalChildren () const
 
bool isLeaf () const
 
bool canCollideWith (const TCollisionElementIterator< Model > &elem) const
 
SReal getProximity () const
 Distance to the actual (visual) surface. More...
 
SReal getContactStiffness () const
 Contact stiffness. More...
 
SReal getContactFriction () const
 Contact friction (damping) coefficient. More...
 
void draw (const core::visual::VisualParams *vparams)
 
- Public Member Functions inherited from sofa::core::BaseCollisionElementIterator
 BaseCollisionElementIterator (Index index=0)
 
 BaseCollisionElementIterator (Index index, VIterator it, VIterator itend)
 
 BaseCollisionElementIterator (VIterator it, VIterator itend)
 
void next ()
 Increment this iterator to reference the next element. More...
 
BaseCollisionElementIteratoroperator++ ()
 Prefix increment this iterator to reference the next element. More...
 
BaseCollisionElementIterator operator++ (int)
 Postfix increment this iterator to reference the next element. More...
 
BaseCollisionElementIteratoroperator+= (int n)
 
BaseCollisionElementIterator operator+ (int n) const
 
Index getIndex () const
 
const VIteratorgetVIterator () const
 Return the current iterator in the vector of indices, in case such a vector is currently used. More...
 
const VIteratorgetVIteratorEnd () const
 Return the end iterator in the vector of indices, in case such a vector is currently used. More...
 

Additional Inherited Members

- Public Attributes inherited from sofa::core::TCollisionElementIterator< CylinderCollisionModel< TDataTypes > >
Modelmodel
 CollisionModel containing the referenced element. More...
 
- Protected Attributes inherited from sofa::core::BaseCollisionElementIterator
Index index
 index of the referenced element inside the CollisionModel. More...
 
VIterator it
 current position in a vector of indices, in case this iterator traverse a non-contiguous set of indices More...
 
VIterator itend
 end position in a vector of indices, in case this iterator traverse a non-contiguous set of indices More...
 
- Static Protected Attributes inherited from sofa::core::BaseCollisionElementIterator
static std::vector< int > SOFA_CORE_API emptyVector
 empty vector to be able to initialize the iterator to an empty pair More...
 

Constructor details

◆ TCylinder() [1/2]

template<class DataTypes >
sofa::component::collision::geometry::TCylinder< DataTypes >::TCylinder ( ParentModel model,
Index  index 
)
inline

◆ TCylinder() [2/2]

template<class DataTypes >
sofa::component::collision::geometry::TCylinder< DataTypes >::TCylinder ( const core::CollisionElementIterator i)
inlineexplicit

Function details

◆ axis()

◆ point1()

◆ point2()

◆ radius()

◆ v()