#include <BaseTopologyData.h>

Inheritance diagram for sofa::core::topology::BaseTopologyData< T >:

Detailed Description

template<class T = void*>
class sofa::core::topology::BaseTopologyData< T >

A class that define topological Data general methods

Protected Attributes
sofa::core::topology::BaseMeshTopology *	m_topology = nullptr
	Pointer to the Topology this TopologyData is depending on. More...

Index	m_lastElementIndex = 0

Protected Attributes inherited from sofa::core::objectmodel::Data< void * >
void *	m_defaultValue

ValueType	m_value
	Value. More...

Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer	inputs

DDGLinkContainer	outputs

Public Member Functions
	BaseTopologyData (const sofa::core::objectmodel::BaseData::BaseInitData &init)

virtual void	add (const sofa::type::vector< Topology::PointID > &, const sofa::type::vector< Topology::Point > &, const sofa::type::vector< sofa::type::vector< Topology::PointID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< PointAncestorElem > &)
	Add some values. Values are added at the end of the vector. More...

virtual void	add (const sofa::type::vector< Topology::EdgeID > &, const sofa::type::vector< Topology::Edge > &, const sofa::type::vector< sofa::type::vector< Topology::EdgeID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< EdgeAncestorElem > &)

virtual void	add (const sofa::type::vector< Topology::TriangleID > &, const sofa::type::vector< Topology::Triangle > &, const sofa::type::vector< sofa::type::vector< Topology::TriangleID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< TriangleAncestorElem > &)
	add Triangle More...

virtual void	add (const sofa::type::vector< Topology::TetrahedronID > &, const sofa::type::vector< Topology::Tetrahedron > &, const sofa::type::vector< sofa::type::vector< Topology::TetrahedronID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< TetrahedronAncestorElem > &)
	add Quad & Tetrahedron More...

virtual void	add (const sofa::type::vector< Topology::QuadID > &, const sofa::type::vector< Topology::Quad > &, const sofa::type::vector< sofa::type::vector< Topology::QuadID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< QuadAncestorElem > &)

virtual void	add (const sofa::type::vector< Topology::HexahedronID > &, const sofa::type::vector< Topology::Hexahedron > &, const sofa::type::vector< sofa::type::vector< Topology::HexahedronID > > &, const sofa::type::vector< sofa::type::vector< SReal > > &, const sofa::type::vector< HexahedronAncestorElem > &)
	add Hexahedron More...

virtual void	remove (const sofa::type::vector< unsigned int > &)
	Remove the values corresponding to the points removed. More...

virtual void	swap (unsigned int, unsigned int)
	Swaps values at indices i1 and i2. More...

virtual void	renumber (const sofa::type::vector< unsigned int > &)
	Reorder the values. More...

virtual void	move (const sofa::type::vector< unsigned int > &, const sofa::type::vector< sofa::type::vector< unsigned int > > &, const sofa::type::vector< sofa::type::vector< SReal > > &)
	Move a list of points. More...

sofa::core::topology::BaseMeshTopology *	getTopology ()

void	setDataSetArraySize (const Index s)
	to handle PointSubsetData More...

virtual Index	getLastElementIndex () const
	Return the last element index of the topolgy buffer this Data is linked to. More...

Public Member Functions inherited from sofa::core::objectmodel::Data< void * >
	Data (const Data &)=delete

const sofa::defaulttype::AbstractTypeInfo *	getValueTypeInfo () const override
	Get info about the value type of the associated variable. More...

bool	read (const std::string &s) override

bool SOFA_CORE_API	read (const std::string &str)
	Specialization for reading strings. More...

bool SOFA_CORE_API	read (const std::string &str)
	Specialization for reading booleans. More...

bool	read (const std::string &str)
	Specialization for reading strings. More...

bool	read (const std::string &str)
	Specialization for reading booleans. More...

void	printValue (std::ostream &out) const override
	General case for printing default value. More...

std::string	getValueString () const override
	General case for printing value. More...

std::string	getDefaultValueString () const override
	General case for printing default value. More...

std::string	getValueTypeString () const override
	Get the name of the type of the value held in this Data. More...

void	operator= (const void * &value)

Data &	operator= (const Data &)=delete

bool	copyValueFrom (const Data< void * > *data)

virtual void * *	beginEdit ()

virtual void * *	beginWriteOnly ()

virtual void	endEdit ()

void	setValue (const void * &value)

const void * &	getValue () const

BaseData *	getNewInstance () override

	Data (const BaseData::BaseInitData &init)

	Data (const InitData &init)

	Data (const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)

	Data (const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	Data (const void * &value, const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)

	Data (const void * &value, const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	~Data () override
	Destructor. More...

Public Member Functions inherited from sofa::core::objectmodel::BaseData
	BaseData (const BaseInitData &init)

	BaseData (const std::string &helpMsg, DataFlags flags=FLAG_DEFAULT)

	BaseData (const char *helpMsg, DataFlags flags=FLAG_DEFAULT)

	BaseData (const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	BaseData (const char *helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	~BaseData () override
	Destructor. More...

const void *	getValueVoidPtr () const
	Get current value as a void pointer (use getValueTypeInfo to find how to access it) More...

void *	beginEditVoidPtr ()
	Begin edit current value as a void pointer (use getValueTypeInfo to find how to access it) More...

void	endEditVoidPtr ()
	Must be called after beginEditVoidPtr(), after you are finished modifying this Data. More...

const std::string &	getHelp () const
	Get a help message that describes this Data. More...

void	setHelp (const std::string &val)
	Set the help message. More...

const std::string &	getGroup () const
	Get group. More...

void	setGroup (const std::string &val)
	Set group. More...

const std::string &	getWidget () const
	Get widget. More...

void	setWidget (const char *val)
	Set widget. More...

virtual std::string	getLinkPath () const
	If we use the Data as a link and not as value directly. More...

virtual bool	canBeLinked () const

Base *	getOwner () const
	Return the Base component owning this Data. More...

void	setOwner (Base *o)
	Set the owner of this Data. More...

BaseData *	getData () const
	This method is needed by DDGNode. More...

const std::string &	getName () const
	Return the name of this Data within the Base component. More...

void	setName (const std::string &name)

bool	hasDefaultValue () const
	Return whether the Data has a default value or not. More...

bool	setParent (BaseData *parent, const std::string &path=std::string())
	Link to a parent data. The value of this data will automatically duplicate the value of the parent data. More...

bool	setParent (const std::string &path)

virtual bool	validParent (const BaseData *parent)
	Check if a given Data can be linked as a parent of this data. More...

BaseData *	getParent () const

void	update () override
	Update the value of this Data. More...

bool	copyValueFrom (const BaseData *data)
	Update this Data from the value of its parent. More...

bool	updateValueFromLink (const BaseData *data)

template<class T >
	SOFA_ATTRIBUTE_DEPRECATED__UNNECESSARY_PARAMETER_IN_TYPENAME () static std

void	setFlag (DataFlagsEnum flag, bool b)
	Set one of the flags. More...

bool	getFlag (DataFlagsEnum flag) const
	Get one of the flags. More...

bool	isDisplayed () const
	Return whether this Data has to be displayed in GUIs. More...

bool	isReadOnly () const
	Return whether this Data will be read-only in GUIs. More...

bool	isPersistent () const
	Return whether this Data contains persistent information. More...

bool	isAutoLink () const
	Return whether this Data should be autolinked when using the src="" syntax. More...

bool	isRequired () const
	Return whether the Data has to be set by the user for the owner component to be valid. More...

void	setDisplayed (bool b)
	Set whether this Data should be displayed in GUIs. More...

void	setReadOnly (bool b)
	Set whether this Data is read-only. More...

void	setPersistent (bool b)
	Set whether this Data contains persistent information. More...

void	setAutoLink (bool b)
	Set whether this data should be autolinked when using the src="" syntax. More...

void	setRequired (bool b)
	Set whether the Data has to be set by the user for the owner component to be valid. More...

bool	isSet () const

void	unset ()
	Reset the isSet flag to false, to indicate that the current value is the default for this Data. More...

void	forceSet ()
	Reset the isSet flag to true, to indicate that the current value has been modified. More...

int	getCounter () const

Public Member Functions inherited from sofa::core::objectmodel::DDGNode
	DDGNode ()
	Constructor. More...

virtual	~DDGNode ()
	Destructor. Automatically remove remaining links. More...

void	addInput (DDGNode *n)
	Add a new input to this node. More...

void	delInput (DDGNode *n)
	Remove an input from this node. More...

void	addOutput (DDGNode *n)
	Add a new output to this node. More...

void	delOutput (DDGNode *n)
	Remove an output from this node. More...

const DDGLinkContainer &	getInputs ()
	Get the list of inputs for this DDGNode. More...

const DDGLinkContainer &	getOutputs ()
	Get the list of outputs for this DDGNode. More...

bool	isDirty () const
	Returns true if the DDGNode needs to be updated. More...

virtual void	setDirtyValue ()
	Indicate the value needs to be updated. More...

virtual void	setDirtyOutputs ()
	Indicate the outputs needs to be updated. This method must be called after changing the value of this node. More...

void	cleanDirty ()
	Set dirty flag to false. More...

virtual void	notifyEndEdit ()
	Notify links that the DGNode has been modified. More...

void	updateIfDirty () const
	Utility method to call update if necessary. This method should be called before reading of writing the value of this node. More...

Additional Inherited Members
Public Attributes inherited from sofa::core::objectmodel::Data< void * >
int	m_counter
	Number of changes since creation. More...

bool	m_isSet
	True if this Data is set, i.e. its value is different from the default value. More...

Public Attributes inherited from sofa::core::objectmodel::BaseData
std::string	help {""}
	Help message. More...

std::string	ownerClass {""}
	Owner class. More...

std::string	group {""}
	group More...

std::string	widget {""}
	widget More...

int	m_counter
	Number of changes since creation. More...

bool	m_isSet
	True if this Data is set, i.e. its value is different from the default value. More...

DataFlags	m_dataFlags
	Flags indicating the purpose and behaviour of this Data. More...

Base *	m_owner {nullptr}
	Return the Base component owning this Data. More...

std::string	m_name
	Data name within the Base component. More...

bool	m_hasDefaultValue = false
	True if this Data has a default value. More...

DataLink< BaseData >	parentData
	Parent Data. More...

Static Public Member Functions inherited from sofa::core::objectmodel::Data< void * >
static constexpr bool	isCopyOnWrite ()

static std::string	templateName ()

Static Public Member Functions inherited from sofa::core::objectmodel::BaseData
static std::string	decodeTypeName (const std::type_info &t)
	Helper method to decode the type name to a more readable form if possible. More...

template<class T >
static std::string	typeName ()
	Helper method to get the type name of type T. More...

Protected Member Functions inherited from sofa::core::objectmodel::Data< void * >
std::istream &	readValue (std::istream &in)

std::istream &	readValue (std::istream &in)

SOFA_CORE_API std::istream &	readValue (std::istream &in)

Protected Member Functions inherited from sofa::core::objectmodel::BaseData
bool	genericCopyValueFrom (const BaseData *parent)
	Try to update this Data from the value of its parent in "fast mode";. More...

Protected Member Functions inherited from sofa::core::objectmodel::DDGNode
virtual void	doAddInput (DDGNode *n)

virtual void	doAddOutput (DDGNode *n)

virtual void	doDelOutput (DDGNode *n)

void	cleanDirtyOutputsOfInputs ()
	the dirtyOutputs flags of all the inputs will be set to false More...

Attribute details

◆ m_lastElementIndex

template<class T = void*>

Index sofa::core::topology::BaseTopologyData< T >::m_lastElementIndex = 0

protected

to handle properly the removal of items, the container must keep the last element index and update it during operations (add/remove). Note that this index is mandatory and can't be retrieved directly from the topology in the case when several topology events are queued. i.e: If 2 removalElements events are queued, the second event still point to a topology not yet updated by the first event.

◆ m_topology

template<class T = void*>

sofa::core::topology::BaseMeshTopology* sofa::core::topology::BaseTopologyData< T >::m_topology = nullptr

protected

Pointer to the Topology this TopologyData is depending on.

Constructor details

◆ BaseTopologyData()

template<class T = void*>

sofa::core::topology::BaseTopologyData< T >::BaseTopologyData ( const sofa::core::objectmodel::BaseData::BaseInitData & init )

inlineexplicit

Constructor used via the Base::initData() methods.

Function details

◆ add() [1/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::EdgeID > &	,
		const sofa::type::vector< Topology::Edge > &	,
		const sofa::type::vector< sofa::type::vector< Topology::EdgeID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< EdgeAncestorElem > &
	)

inlinevirtual

Temporary Hack: find a way to have a generic description of topological element: add Edge

◆ add() [2/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::HexahedronID > &	,
		const sofa::type::vector< Topology::Hexahedron > &	,
		const sofa::type::vector< sofa::type::vector< Topology::HexahedronID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< HexahedronAncestorElem > &
	)

inlinevirtual

add Hexahedron

◆ add() [3/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::PointID > &	,
		const sofa::type::vector< Topology::Point > &	,
		const sofa::type::vector< sofa::type::vector< Topology::PointID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< PointAncestorElem > &
	)

inlinevirtual

Add some values. Values are added at the end of the vector.

◆ add() [4/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::QuadID > &	,
		const sofa::type::vector< Topology::Quad > &	,
		const sofa::type::vector< sofa::type::vector< Topology::QuadID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< QuadAncestorElem > &
	)

inlinevirtual

◆ add() [5/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::TetrahedronID > &	,
		const sofa::type::vector< Topology::Tetrahedron > &	,
		const sofa::type::vector< sofa::type::vector< Topology::TetrahedronID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< TetrahedronAncestorElem > &
	)

inlinevirtual

add Quad & Tetrahedron

◆ add() [6/6]

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::add	(	const sofa::type::vector< Topology::TriangleID > &	,
		const sofa::type::vector< Topology::Triangle > &	,
		const sofa::type::vector< sofa::type::vector< Topology::TriangleID > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &	,
		const sofa::type::vector< TriangleAncestorElem > &
	)

inlinevirtual

add Triangle

◆ getLastElementIndex()

template<class T = void*>

virtual Index sofa::core::topology::BaseTopologyData< T >::getLastElementIndex ( ) const

inlinevirtual

Return the last element index of the topolgy buffer this Data is linked to.

See also: m_lastElementIndex

Reimplemented in sofa::core::topology::TopologySubsetIndices.

◆ getTopology()

template<class T = void*>

sofa::core::topology::BaseMeshTopology* sofa::core::topology::BaseTopologyData< T >::getTopology ( )

inline

◆ move()

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::move	(	const sofa::type::vector< unsigned int > &	,
		const sofa::type::vector< sofa::type::vector< unsigned int > > &	,
		const sofa::type::vector< sofa::type::vector< SReal > > &
	)

inlinevirtual

Move a list of points.

◆ remove()

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::remove ( const sofa::type::vector< unsigned int > & )

inlinevirtual

Remove the values corresponding to the points removed.

◆ renumber()

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::renumber ( const sofa::type::vector< unsigned int > & )

inlinevirtual

Reorder the values.

◆ setDataSetArraySize()

template<class T = void*>

void sofa::core::topology::BaseTopologyData< T >::setDataSetArraySize ( const Index s )

inline

to handle PointSubsetData

◆ swap()

template<class T = void*>

virtual void sofa::core::topology::BaseTopologyData< T >::swap	(	unsigned int	,
		unsigned int
	)

inlinevirtual

Swaps values at indices i1 and i2.

Detailed Description

template<class T = void*> class sofa::core::topology::BaseTopologyData< T >

Protected Attributes

Public Member Functions

Additional Inherited Members

Attribute details

◆ m_lastElementIndex

◆ m_topology

Constructor details

◆ BaseTopologyData()

Function details

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ getLastElementIndex()

◆ getTopology()

◆ move()

◆ remove()

◆ renumber()

◆ setDataSetArraySize()

◆ swap()

template<class T = void*>
class sofa::core::topology::BaseTopologyData< T >