SOFA API  d5d9f025
Open source framework for multi-physics simuation
sofa::component::misc::EvalSurfaceDistance< TDataTypes > Class Template Reference

#include <EvalSurfaceDistance.h>

Inheritance diagram for sofa::component::misc::EvalSurfaceDistance< TDataTypes >:

Detailed Description

template<class TDataTypes>
class sofa::component::misc::EvalSurfaceDistance< TDataTypes >

Compute the distance between surfaces in two objects

Public Attributes

Data< SRealmaxDist
 Alarm distance for proximity detection. More...
 
- Public Attributes inherited from sofa::component::misc::EvalPointsDistance< TDataTypes >
Data< boolf_draw
 Rendering of lines between associated points (activation) More...
 
Data< boolisToPrint
 Suppress field for save as function. More...
 
sofa::core::objectmodel::DataFileName f_filename
 Output file name. More...
 
Data< doublef_period
 Period between outputs. More...
 
Data< helper::vector< Real > > dist
 Computed distances. More...
 
Data< doubledistMean
 mean distance (OUTPUT) More...
 
Data< doubledistMin
 min distance (OUTPUT) More...
 
Data< doubledistMax
 max distance (OUTPUT) More...
 
Data< doubledistDev
 distance standard deviation (OUTPUT) More...
 
Data< doublerdistMean
 mean relative distance (OUTPUT) More...
 
Data< doublerdistMin
 min relative distance (OUTPUT) More...
 
Data< doublerdistMax
 max relative distance (OUTPUT) More...
 
Data< doublerdistDev
 relative distance standard deviation (OUTPUT) More...
 
LinkMState mstate1
 First model mechanical state. More...
 
LinkMState mstate2
 Second model mechanical state. More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< ComponentStated_componentstate
 the object state More...
 
Data< ComponentState > & m_componentstate {d_componentstate}
 TODO bruno: uncomment once c++17 is enabled in SOFA. More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Protected Attributes

VecCoord xproj
 Projection vector. More...
 
sofa::component::collision::PointCollisionModel< sofa::defaulttype::Vec3Types > * pointsCM
 Point model of first object. More...
 
sofa::component::collision::TriangleCollisionModel< sofa::defaulttype::Vec3Types > * surfaceCM
 Surface model of second object. More...
 
sofa::component::collision::NewProximityIntersection::SPtr intersection
 
sofa::component::collision::BruteForceDetection::SPtr detection
 
- Protected Attributes inherited from sofa::component::misc::EvalPointsDistance< TDataTypes >
std::ofstream * outfile
 output file More...
 
double lastTime
 time value for the distance computations More...
 
sofa::defaulttype::BoundingBox box1
 
sofa::defaulttype::BoundingBox box2
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
VecData m_vecData
 List of fields (Data instances) More...
 
MapData m_aliasData
 name -> Data multi-map (includes names and aliases) More...
 
VecLink m_vecLink
 List of links. More...
 
MapLink m_aliasLink
 name -> Link multi-map (includes names and aliases) More...
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(EvalSurfaceDistance, TDataTypes), SOFA_TEMPLATE(EvalPointsDistance, TDataTypes))
 
SReal eval () override
 Compute the error metric between two surfaces. More...
 
void init () override
 Init the computation. More...
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
- Public Member Functions inherited from sofa::component::misc::EvalPointsDistance< TDataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(EvalPointsDistance, TDataTypes), sofa::core::objectmodel::BaseObject)
 
void reinit () override
 Update. More...
 
void reset () override
 Reset the computation of the distances. More...
 
virtual SReal doEval (const VecCoord &x1, const VecCoord &x2, const VecCoord &x0)
 Compute the distances between the two objects. More...
 
void handleEvent (sofa::core::objectmodel::Event *event) override
 Handle an event. More...
 
virtual void doDraw (const core::visual::VisualParams *vparams, const VecCoord &x1, const VecCoord &x2)
 
core::behavior::MechanicalState< DataTypes > * getMState1 ()
 Retrieve the associated MechanicalState (First model) More...
 
core::behavior::BaseMechanicalStategetMechModel1 ()
 
core::behavior::MechanicalState< DataTypes > * getMState2 ()
 Retrieve the associated MechanicalState (Second model) More...
 
core::behavior::BaseMechanicalStategetMechModel2 ()
 
virtual std::string getTemplateName () const override
 Get the template type names (if any) used to instantiate this object. More...
 
void setPathToMS1 (const std::string &o)
 
void setPathToMS2 (const std::string &o)
 
void setPeriod (const double &_dt)
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void computeBBox (const core::ExecParams *, bool=false)
 
void setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
 Sets a source Object and parses it to collect dependent Data. More...
 
void setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
 
void * findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const
 Return the full path name of this object. More...
 
virtual bool insertInNode (BaseNode *)
 
virtual bool removeInNode (BaseNode *)
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual void bwdInit ()
 Initialization method called at graph creation and modification, during bottom-up traversal. More...
 
void updateInternal ()
 Update method called when variables (used to compute other internal variables) are modified. More...
 
virtual void storeResetState ()
 Save the initial state for later uses in reset() More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
const std::string & getName () const
 Accessor to the object name. More...
 
void setName (const std::string &n)
 Set the name of this object. More...
 
void setName (const std::string &n, int counter)
 Set the name of this object, adding an integer counter. More...
 
virtual std::string getTypeName () const
 Get the type name of this object (i.e. class and template types) More...
 
virtual std::string getClassName () const
 Get the class name of this object. More...
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 Set the source filename (where the component is implemented) More...
 
const std::string & getDefinitionSourceFileName () const
 Get the source filename (where the component is implemented) More...
 
void setDefinitionSourceFilePos (const int)
 Set the source location (where the component is implemented) More...
 
int getDefinitionSourceFilePos () const
 Get the source location (where the component is implemented) More...
 
void setInstanciationSourceFileName (const std::string &sourceFileName)
 
const std::string & getInstanciationSourceFileName () const
 
void setInstanciationSourceFilePos (const int)
 
int getInstanciationSourceFilePos () const
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
void addMessage (const sofa::helper::logging::Message &m) const
 
size_t countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
const std::deque< sofa::helper::logging::Message > & getLoggedMessages () const
 
const std::string getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
void clearLoggedMessages () const
 
bool notMuted () const
 
const sofa::core::objectmodel::TagSetgetTags () const
 Represents the subsets the object belongs to. More...
 
bool hasTag (Tag t) const
 Return true if the object belong to the given subset. More...
 
void addTag (Tag t)
 Add a subset qualification to the object. More...
 
void removeTag (Tag t)
 Remove a subset qualification to the object. More...
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 Assign one field value (Data or Link) More...
 
virtual bool hasField (const std::string &attribute) const
 Check if a given Data field or Link exists. More...
 
void parseFields (const std::list< std::string > &str)
 Assign the field values stored in the given list of name + value pairs of strings. More...
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 Assign the field values stored in the given map of name -> value pairs. More...
 
void writeDatas (std::map< std::string, std::string * > &str)
 Write the current field values to the given map of name -> value pairs. More...
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 Find data fields given a name: several can be found as we look into the alias map. More...
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 Find link fields given a name: several can be found as we look into the alias map. More...
 
virtual void updateLinks (bool logErrors=true)
 Update pointers in case the pointed-to objects have appeared. More...
 
template<class T >
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 Remove a data field. More...
 
void addAlias (BaseData *field, const char *alias)
 Add an alias to a Data. More...
 
void addLink (BaseLink *l)
 Add a link. More...
 
void removeLink (BaseLink *l)
 Remove a link. More...
 
void addAlias (BaseLink *link, const char *alias)
 Add an alias to a Link. More...
 
const VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Protected Member Functions

 EvalSurfaceDistance ()
 
virtual ~EvalSurfaceDistance ()
 
- Protected Member Functions inherited from sofa::component::misc::EvalPointsDistance< TDataTypes >
 EvalPointsDistance ()
 
 ~EvalPointsDistance () override
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 Implementation of the internal update. More...
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, unsigned int, bool add)
 This method insures that slaves objects have master and context links set correctly. More...
 
void trackInternalData (const BaseData &data)
 Method called to add the Data to the DataTracker (listing the Data to track) More...
 
void cleanTracker ()
 
bool hasDataChanged (const BaseData &data)
 Method called to know if a tracked Data has changed. More...
 
- Protected Member Functions inherited from sofa::core::objectmodel::Base
 Base ()
 
virtual ~Base ()
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
 Helper method used by initData() More...
 
template<class T >
void initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sofa::component::misc::EvalPointsDistance< TDataTypes >
template<class T >
static bool canCreate (T *&obj, core::objectmodel::BaseContext *context, core::objectmodel::BaseObjectDescription *arg)
 
static std::string templateName (const EvalPointsDistance< DataTypes > *=nullptr)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 Pre-construction check method called by ObjectFactory. More...
 
template<class T >
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 Construction method called by ObjectFactory. More...
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const MyClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

template<class TDataTypes >
sofa::component::collision::BruteForceDetection::SPtr sofa::component::misc::EvalSurfaceDistance< TDataTypes >::detection
protected
template<class TDataTypes >
sofa::component::collision::NewProximityIntersection::SPtr sofa::component::misc::EvalSurfaceDistance< TDataTypes >::intersection
protected
template<class TDataTypes >
Data< SReal > sofa::component::misc::EvalSurfaceDistance< TDataTypes >::maxDist

Alarm distance for proximity detection.

Point model of first object.

Surface model of second object.

template<class TDataTypes >
VecCoord sofa::component::misc::EvalSurfaceDistance< TDataTypes >::xproj
protected

Projection vector.

Constructor details

template<class DataTypes >
sofa::component::misc::EvalSurfaceDistance< DataTypes >::EvalSurfaceDistance ( )
protected

Default constructor

template<class DataTypes >
sofa::component::misc::EvalSurfaceDistance< DataTypes >::~EvalSurfaceDistance ( )
protectedvirtual

Function details

template<class DataTypes >
void sofa::component::misc::EvalSurfaceDistance< DataTypes >::draw ( const core::visual::VisualParams )
overridevirtual

Render internal data of this object, for debugging purposes.

Reimplemented from sofa::component::misc::EvalPointsDistance< TDataTypes >.

template<class DataTypes >
SReal sofa::component::misc::EvalSurfaceDistance< DataTypes >::eval ( )
overridevirtual

Compute the error metric between two surfaces.

Reimplemented from sofa::component::misc::EvalPointsDistance< TDataTypes >.

template<class DataTypes >
void sofa::component::misc::EvalSurfaceDistance< DataTypes >::init ( void  )
overridevirtual

Init the computation.

Reimplemented from sofa::component::misc::EvalPointsDistance< TDataTypes >.

template<class TDataTypes >
sofa::component::misc::EvalSurfaceDistance< TDataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(EvalSurfaceDistance< TDataTypes >, TDataTypes)  ,
SOFA_TEMPLATE(EvalPointsDistance, TDataTypes)   
)