SOFA API  ca70b0f0
Open source framework for multi-physics simuation
sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes > Class Template Reference

#include <PointSetGeometryAlgorithms.h>

Inheritance diagram for sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >:

Detailed Description

template<class DataTypes>
class sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >

A class that can perform some geometric computation on a set of points.

Protected Attributes

sofa::core::State< DataTypes > * object
 
sofa::core::topology::BaseMeshTopologym_topology
 
Data< floatd_showIndicesScale
 Debug : scale for view topology indices. More...
 
Data< boold_showPointIndices
 
Data< std::string > d_tagMechanics
 Tage of the Mechanical State associated with the vertex position. More...
 
SingleLink< PointSetGeometryAlgorithms< DataTypes >, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKl_topology
 Link to be set to the topology container in the component graph. More...
 
- 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
std::map< std::string, sofa::core::DataTrackerCallbackm_internalEngine
 
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(PointSetGeometryAlgorithms, DataTypes), core::topology::GeometryAlgorithms)
 
Angle computeAngle (PointID ind_p0, PointID ind_p1, PointID ind_p2) const
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void reinit () override
 Update method called when variables used in precomputation are modified. More...
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. More...
 
void computeBBox (const core::ExecParams *params, bool onlyVisible=false) override
 
Coord getPointSetCenter () const
 
void getEnclosingSphere (Coord &center, Real &radius) const
 
void getAABB (Real bb[6]) const
 
void getAABB (CPos &minCoord, CPos &maxCoord) const
 Returns the axis aligned bounding box. More...
 
const CoordgetPointPosition (const PointID pointId) const
 
const CoordgetPointRestPosition (const PointID pointId) const
 
sofa::core::State< DataTypes > * getDOF () const
 Returns the object where the DOFs are stored. More...
 
float getIndicesScale () const
 
void initPointsAdded (const type::vector< sofa::Index > &indices, const type::vector< core::topology::PointAncestorElem > &ancestorElems, const type::vector< core::VecCoordId > &coordVecs, const type::vector< core::VecDerivId > &derivVecs) override
 Called by the state change callback to initialize added points according to the topology (topology element & local coordinates) More...
 
virtual void initPointAdded (PointID indice, const core::topology::PointAncestorElem &ancestorElem, const type::vector< VecCoord * > &coordVecs, const type::vector< VecDeriv * > &derivVecs)
 Process the added point initialization according to the topology and local coordinates. More...
 
- Public Member Functions inherited from sofa::core::topology::GeometryAlgorithms
 SOFA_CLASS (GeometryAlgorithms, BaseTopologyObject)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
- Public Member Functions inherited from sofa::core::topology::BaseTopologyObject
 SOFA_CLASS (BaseTopologyObject, core::objectmodel::BaseObject)
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
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)
 
BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const override
 Return the full path name of this object. More...
 
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 handleEvent (Event *)
 Handle an event. More...
 
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 reset ()
 Reset to initial state. More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
void addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
 
void addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
 
void addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
 
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...
 
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...
 
virtual std::string getTemplateName () const final
 Get the template type names (if any) used to instantiate this object. More...
 
std::string getNameSpaceName () const
 Get the template type names (if any) used to instantiate 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
 
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 (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
 Helper method used to initialize a data field containing a value of type T. 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 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)
 

Static Public Member Functions

template<class T >
static bool canCreate (T *&obj, core::objectmodel::BaseContext *context, core::objectmodel::BaseObjectDescription *arg)
 
- 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 BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Protected Member Functions

 PointSetGeometryAlgorithms ()
 
 ~PointSetGeometryAlgorithms () override
 
virtual bool mustComputeBBox () const
 Return true if the visibility parameters are showing the object in any way whatsoever, false otherwise. More...
 
- Protected Member Functions inherited from sofa::core::topology::GeometryAlgorithms
 GeometryAlgorithms ()
 Constructor. More...
 
 ~GeometryAlgorithms () override
 Destructor. More...
 
- Protected Member Functions inherited from sofa::core::topology::BaseTopologyObject
 BaseTopologyObject ()
 
 ~BaseTopologyObject () 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, std::size_t, 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

- 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
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
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::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Attribute details

◆ d_showIndicesScale

template<class DataTypes >
Data<float> sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::d_showIndicesScale
protected

Debug : scale for view topology indices.

◆ d_showPointIndices

template<class DataTypes >
Data<bool> sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::d_showPointIndices
protected

Debug : view Point indices

◆ d_tagMechanics

template<class DataTypes >
Data<std::string> sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::d_tagMechanics
protected

Tage of the Mechanical State associated with the vertex position.

◆ l_topology

◆ m_topology

◆ object

the object where the mechanical DOFs are stored

Constructor details

◆ PointSetGeometryAlgorithms()

◆ ~PointSetGeometryAlgorithms()

Function details

◆ canCreate()

template<class DataTypes >
template<class T >
static bool sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::canCreate ( T *&  obj,
core::objectmodel::BaseContext context,
core::objectmodel::BaseObjectDescription arg 
)
inlinestatic

◆ computeAngle()

template<class DataTypes >
PointSetGeometryAlgorithms< DataTypes >::Angle sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::computeAngle ( PointID  ind_p0,
PointID  ind_p1,
PointID  ind_p2 
) const

◆ computeBBox()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::computeBBox ( const core::ExecParams ,
bool  = false 
)
overridevirtual

Bounding Box computation method. Default to empty method.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ draw()

◆ getAABB() [1/2]

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getAABB ( CPos minCoord,
CPos maxCoord 
) const

Returns the axis aligned bounding box.

◆ getAABB() [2/2]

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getAABB ( typename DataTypes::Real  bb[6]) const

return the axis aligned bounding box : index 0 = xmin, index 1=ymin, index 2 = zmin, index 3 = xmax, index 4 = ymax, index 5=zmax

◆ getDOF()

Returns the object where the DOFs are stored.

◆ getEnclosingSphere()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getEnclosingSphere ( typename DataTypes::Coord &  center,
typename DataTypes::Real &  radius 
) const

return the centre and a radius of a sphere enclosing the set of points (may not be the smalled one)

◆ getIndicesScale()

◆ getPointPosition()

template<class DataTypes >
const DataTypes::Coord & sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getPointPosition ( const PointID  pointId) const

◆ getPointRestPosition()

template<class DataTypes >
const DataTypes::Coord & sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getPointRestPosition ( const PointID  pointId) const

◆ getPointSetCenter()

template<class DataTypes >
DataTypes::Coord sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::getPointSetCenter

return the centroid of the set of points

◆ init()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::init ( void  )
overridevirtual

◆ initPointAdded()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::initPointAdded ( PointID  indice,
const core::topology::PointAncestorElem ancestorElem,
const type::vector< VecCoord * > &  coordVecs,
const type::vector< VecDeriv * > &  derivVecs 
)
virtual

◆ initPointsAdded()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::initPointsAdded ( const type::vector< sofa::Index > &  indices,
const type::vector< core::topology::PointAncestorElem > &  ancestorElems,
const type::vector< core::VecCoordId > &  coordVecs,
const type::vector< core::VecDerivId > &  derivVecs 
)
overridevirtual

Called by the state change callback to initialize added points according to the topology (topology element & local coordinates)

Reimplemented from sofa::core::topology::GeometryAlgorithms.

◆ mustComputeBBox()

◆ reinit()

template<class DataTypes >
void sofa::component::topology::container::dynamic::PointSetGeometryAlgorithms< DataTypes >::reinit
overridevirtual

Update method called when variables used in precomputation are modified.

Reimplemented from sofa::core::objectmodel::BaseObject.

Reimplemented in sofa::component::topology::container::dynamic::TriangleSetGeometryAlgorithms< DataTypes >.

◆ SOFA_CLASS()

Enum details

◆ anonymous enum

template<class DataTypes >
anonymous enum
Enumerator
NC 

◆ Angle

Enumerator
ACUTE 
RIGHT 
OBTUSE