SOFA API  93933a5d
Open source framework for multi-physics simuation
sofa::component::topology::container::dynamic::PointSetTopologyModifier Class Reference

#include <PointSetTopologyModifier.h>

Inheritance diagram for sofa::component::topology::container::dynamic::PointSetTopologyModifier:

Detailed Description

A class that can apply basic topology transformations on a set of points.

Public Attributes

Data< boold_propagateToDOF
 Propagate changes to Mechanical object DOFs. 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
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}
 

Public Member Functions

 SOFA_CLASS (PointSetTopologyModifier, core::topology::TopologyModifier)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
virtual void swapPoints (const Index i1, const Index i2)
 Swap points i1 and i2. More...
 
virtual void renumberPoints (const sofa::type::vector< PointID > &index, const sofa::type::vector< PointID > &inv_index, const bool renumberDOF=true)
 Generic method for points renumbering. More...
 
virtual void addPoints (const sofa::Size nPoints, const bool addDOF=true)
 Add a set of points. More...
 
virtual void addPoints (const sofa::Size nPoints, const sofa::type::vector< sofa::type::vector< PointID > > &ancestors, const sofa::type::vector< sofa::type::vector< SReal > > &coefs, const bool addDOF=true)
 Add a set of points. More...
 
virtual void addPoints (const sofa::Size nPoints, const sofa::type::vector< core::topology::PointAncestorElem > &ancestorElems, const bool addDOF=true)
 Add a set of points according to their ancestors topology elements. More...
 
virtual void removePoints (sofa::type::vector< PointID > &indices, const bool removeDOF=true)
 Generic method to remove a list of point. More...
 
void propagateStateChanges () override
 Called by a topology to warn the Mechanical Object component that points have been added or will be removed. More...
 
void notifyEndingEvent () override
 
void removeItems (const sofa::type::vector< PointID > &) override
 Generic method to remove a list of items. More...
 
- Public Member Functions inherited from sofa::core::topology::TopologyModifier
 SOFA_CLASS (TopologyModifier, 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)
 
virtual void draw (const core::visual::VisualParams *)
 Render internal data of this object, for debugging purposes. More...
 
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)
 
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...
 
virtual void reinit ()
 Update method called when variables used in precomputation are modified. 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)
 

Protected Member Functions

 PointSetTopologyModifier ()
 
 ~PointSetTopologyModifier () override
 
void addPointsWarning (const sofa::Size nPoints, const bool addDOF=true)
 Sends a message to warn that some points were added in this topology. More...
 
void addPointsWarning (const sofa::Size nPoints, const sofa::type::vector< sofa::type::vector< PointID > > &ancestors, const sofa::type::vector< sofa::type::vector< SReal > > &coefs, const bool addDOF=true)
 Sends a message to warn that some points were added in this topology. More...
 
void addPointsWarning (const sofa::Size nPoints, const sofa::type::vector< core::topology::PointAncestorElem > &ancestorElems, const bool addDOF=true)
 Sends a message to warn that some points were added in this topology. More...
 
virtual void addPointsProcess (const sofa::Size nPoints)
 Extend the point container storage by nPoints. More...
 
void removePointsWarning (sofa::type::vector< PointID > &indices, const bool removeDOF=true)
 Sends a message to warn that some points are about to be deleted. More...
 
virtual void removePointsProcess (const sofa::type::vector< PointID > &indices, const bool removeDOF=true)
 Remove a subset of points. More...
 
virtual void movePointsProcess (const sofa::type::vector< PointID > &id, const sofa::type::vector< sofa::type::vector< PointID > > &ancestors, const sofa::type::vector< sofa::type::vector< SReal > > &coefs, const bool moveDOF=true)
 move input points indices to input new coords. Also propagate event More...
 
void renumberPointsWarning (const sofa::type::vector< PointID > &index, const sofa::type::vector< PointID > &inv_index, const bool renumberDOF=true)
 Sends a message to warn that points are about to be reordered. More...
 
virtual void renumberPointsProcess (const sofa::type::vector< PointID > &index, const sofa::type::vector< PointID > &, const bool renumberDOF=true)
 Reorder this topology. More...
 
void propagateTopologicalChanges () override
 Called by a topology to warn specific topologies linked to it that TopologyChange objects happened. More...
 
virtual void propagateTopologicalEngineChanges ()
 function to propagate topological change events by parsing the list of TopologyHandlers linked to this topology. TODO: temporary duplication of topological events (commented by default) More...
 
- Protected Member Functions inherited from sofa::core::topology::TopologyModifier
 TopologyModifier ()
 Constructor. More...
 
 ~TopologyModifier () override
 Destructor. More...
 
void addTopologyChange (const TopologyChange *topologyChange)
 Adds a TopologyChange object to the list of the topology this object describes. More...
 
void addStateChange (const TopologyChange *topologyChange)
 Adds a StateChange object to the list of the topology this object describes. 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...
 

Friends

template<class DataTypes >
class PointSetGeometryAlgorithms
 

Additional Inherited Members

- Protected Attributes inherited from sofa::core::topology::TopologyModifier
TopologyContainerm_topologyContainer
 Contains the actual topology data and give acces to it (nature of these data heavily depends on the kind of topology). 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...
 
- 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)
 

Attribute details

◆ d_propagateToDOF

Data<bool> sofa::component::topology::container::dynamic::PointSetTopologyModifier::d_propagateToDOF

Propagate changes to Mechanical object DOFs.

Constructor details

◆ PointSetTopologyModifier()

sofa::component::topology::container::dynamic::PointSetTopologyModifier::PointSetTopologyModifier ( )
inlineprotected

◆ ~PointSetTopologyModifier()

sofa::component::topology::container::dynamic::PointSetTopologyModifier::~PointSetTopologyModifier ( )
inlineoverrideprotected

Function details

◆ addPoints() [1/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPoints ( const sofa::Size  nPoints,
const bool  addDOF = true 
)
virtual

Add a set of points.

See also
addPoints

◆ addPoints() [2/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPoints ( const sofa::Size  nPoints,
const sofa::type::vector< core::topology::PointAncestorElem > &  ancestorElems,
const bool  addDOF = true 
)
virtual

Add a set of points according to their ancestors topology elements.

See also
addPoints

◆ addPoints() [3/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPoints ( const sofa::Size  nPoints,
const sofa::type::vector< sofa::type::vector< PointID > > &  ancestors,
const sofa::type::vector< sofa::type::vector< SReal > > &  coefs,
const bool  addDOF = true 
)
virtual

Add a set of points.

See also
addPoints

◆ addPointsProcess()

◆ addPointsWarning() [1/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPointsWarning ( const sofa::Size  nPoints,
const bool  addDOF = true 
)
protected

Sends a message to warn that some points were added in this topology.

See also
addPointsProcess

◆ addPointsWarning() [2/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPointsWarning ( const sofa::Size  nPoints,
const sofa::type::vector< core::topology::PointAncestorElem > &  ancestorElems,
const bool  addDOF = true 
)
protected

Sends a message to warn that some points were added in this topology.

See also
addPointsProcess

◆ addPointsWarning() [3/3]

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::addPointsWarning ( const sofa::Size  nPoints,
const sofa::type::vector< sofa::type::vector< PointID > > &  ancestors,
const sofa::type::vector< sofa::type::vector< SReal > > &  coefs,
const bool  addDOF = true 
)
protected

Sends a message to warn that some points were added in this topology.

See also
addPointsProcess

◆ init()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::init ( void  )
overridevirtual

◆ movePointsProcess()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::movePointsProcess ( const sofa::type::vector< PointID > &  id,
const sofa::type::vector< sofa::type::vector< PointID > > &  ancestors,
const sofa::type::vector< sofa::type::vector< SReal > > &  coefs,
const bool  moveDOF = true 
)
protectedvirtual

move input points indices to input new coords. Also propagate event

Parameters
id: list of indices to move
ancestors list of ancestors to define relative new position
coefs: barycoef to locate new coord relatively to ancestors. @moveDOF bool allowing the move (default true)

Reimplemented in sofa::component::topology::container::dynamic::TriangleSetTopologyModifier, and sofa::component::topology::container::dynamic::EdgeSetTopologyModifier.

◆ notifyEndingEvent()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::notifyEndingEvent ( )
overridevirtual

\notify the end for the current sequence of topological change events.

Reimplemented from sofa::core::topology::TopologyModifier.

◆ propagateStateChanges()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::propagateStateChanges ( )
overridevirtual

Called by a topology to warn the Mechanical Object component that points have been added or will be removed.

StateChangeList should contain all TopologyChange objects corresponding to vertex changes in this topology that just happened (in the case of creation) or are about to happen (in the case of destruction) since last call to propagateTopologicalChanges.

See also
beginChange()
endChange()

Reimplemented from sofa::core::topology::TopologyModifier.

◆ propagateTopologicalChanges()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::propagateTopologicalChanges ( )
overrideprotectedvirtual

Called by a topology to warn specific topologies linked to it that TopologyChange objects happened.

ChangeList should contain all TopologyChange objects corresponding to changes in this topology that just happened (in the case of creation) or are about to happen (in the case of destruction) since last call to propagateTopologicalChanges.

See also
beginChange()
endChange()

Reimplemented from sofa::core::topology::TopologyModifier.

◆ propagateTopologicalEngineChanges()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::propagateTopologicalEngineChanges ( )
protectedvirtual

◆ removeItems()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::removeItems ( const sofa::type::vector< PointID > &  indices)
overridevirtual

◆ removePoints()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::removePoints ( sofa::type::vector< PointID > &  indices,
const bool  removeDOF = true 
)
virtual

Generic method to remove a list of point.

Parameters
indicesthe indices of the point to remove fromt his topology
removeDOFNotify if the DOF from the mechanical container need to be updated as well.

◆ removePointsProcess()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::removePointsProcess ( const sofa::type::vector< PointID > &  indices,
const bool  removeDOF = true 
)
protectedvirtual

Remove a subset of points.

Elements corresponding to these points are removed from the mechanical object's state vectors.

Important : some structures might need to be warned BEFORE the points are actually deleted, so always use method removePointsWarning before calling removePointsProcess.

See also
removePointsWarning
Parameters
indicesis not const because it is actually sorted from the highest index to the lowest one.
removeDOFif true the points are actually deleted from the mechanical object's state vectors

Reimplemented in sofa::component::topology::container::dynamic::TriangleSetTopologyModifier, sofa::component::topology::container::dynamic::TetrahedronSetTopologyModifier, sofa::component::topology::container::dynamic::QuadSetTopologyModifier, sofa::component::topology::container::dynamic::HexahedronSetTopologyModifier, and sofa::component::topology::container::dynamic::EdgeSetTopologyModifier.

◆ removePointsWarning()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::removePointsWarning ( sofa::type::vector< PointID > &  indices,
const bool  removeDOF = true 
)
protected

Sends a message to warn that some points are about to be deleted.

See also
removePointsProcess

◆ renumberPoints()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::renumberPoints ( const sofa::type::vector< PointID > &  index,
const sofa::type::vector< PointID > &  inv_index,
const bool  renumberDOF = true 
)
virtual

Generic method for points renumbering.

Important : the points are actually renumbered in the mechanical object's state vectors iff (renumberDOF == true)

See also
MechanicalObject::renumberValues

◆ renumberPointsProcess()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::renumberPointsProcess ( const sofa::type::vector< PointID > &  index,
const sofa::type::vector< PointID > &  ,
const bool  renumberDOF = true 
)
protectedvirtual

◆ renumberPointsWarning()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::renumberPointsWarning ( const sofa::type::vector< PointID > &  index,
const sofa::type::vector< PointID > &  inv_index,
const bool  renumberDOF = true 
)
protected

Sends a message to warn that points are about to be reordered.

See also
renumberPointsProcess

◆ SOFA_CLASS()

sofa::component::topology::container::dynamic::PointSetTopologyModifier::SOFA_CLASS ( PointSetTopologyModifier  ,
core::topology::TopologyModifier   
)

◆ swapPoints()

void sofa::component::topology::container::dynamic::PointSetTopologyModifier::swapPoints ( const Index  i1,
const Index  i2 
)
virtual

Swap points i1 and i2.

Related details

◆ PointSetGeometryAlgorithms

template<class DataTypes >
friend class PointSetGeometryAlgorithms
friend