base-implementation of a selector More...

#include <selector_interface.h>

Inheritance diagram for ug::ISelector:

Public Types
enum	{ DESELECTED = 0 , SELECTED = 1 }

typedef byte	status_t

Public Member Functions
bool	autoselection_enabled ()

virtual void	broadcast_selection_states (bool deselect=false, bool includeGhosts=false)
	broadcasts the current selection More...

virtual void	clear ()=0

virtual bool	contains_edges () const =0
	returns true if the selector contains edges More...

virtual bool	contains_faces () const =0
	returns true if the selector contains faces More...

virtual bool	contains_vertices () const =0
	returns true if the selector contains vertices More...

virtual bool	contains_volumes () const =0
	returns true if the selector contains volumes More...

void	deselect (GridObject *elem)

template<class TElem >
void	deselect (TElem *elem)

template<class TIterator >
void	deselect (TIterator iterBegin, TIterator iterEnd)

virtual void	edge_created (Grid grid, Edge e, GridObject *pParent=NULL, bool replacesParent=false)
	Notified whenever a new element of the given type is created in the given grid. More...

virtual void	edge_to_be_erased (Grid grid, Edge e, Edge *replacedBy=NULL)
	Notified whenever an element of the given type is erased from the given grid. More...

virtual void	edges_to_be_merged (Grid grid, Edge target, Edge elem1, Edge elem2)
	Notified when two elements of the same type are going to be merged. More...

bool	elements_are_supported (uint shElements) const
	returns true if the given element-types are supported. More...

virtual void	elements_to_be_cleared (Grid *grid)

void	enable_autoselection (bool bEnable)

void	enable_selection_inheritance (bool bEnable)

void	enable_strict_inheritance (bool bEnable)

virtual void	face_created (Grid grid, Face f, GridObject *pParent=NULL, bool replacesParent=false)
	Notified whenever a new element of the given type is created in the given grid. More...

virtual void	face_to_be_erased (Grid grid, Face f, Face *replacedBy=NULL)
	Notified whenever an element of the given type is erased from the given grid. More...

virtual void	faces_to_be_merged (Grid grid, Face target, Face elem1, Face elem2)
	Notified when two elements of the same type are going to be merged. More...

virtual GridObjectCollection	get_grid_objects () const =0
	returns a geometric object collection, containing all selected objects More...

template<class TElem >
byte	get_mark (TElem *elem) const
	returns the selection state of the specified elelent More...

Grid *	grid () const

virtual void	grid_to_be_destroyed (Grid *grid)

template<class TElem >
bool	is_selected (TElem *elem) const
	returns true if an element is selected More...

	ISelector (Grid &grid, uint supportedElements=SE_ALL)

	ISelector (uint supportedElements=SE_ALL)

bool	selection_inheritance_enabled ()

bool	strict_inheritance_enabled ()

template<class TElem >
void	unmark (TElem *elem)
	deselects an element More...

virtual void	vertex_created (Grid grid, Vertex vrt, GridObject *pParent=NULL, bool replacesParent=false)
	Notified whenever a new element of the given type is created in the given grid. More...

virtual void	vertex_to_be_erased (Grid grid, Vertex vrt, Vertex *replacedBy=NULL)
	Notified whenever an element of the given type is erased from the given grid. More...

virtual void	vertices_to_be_merged (Grid grid, Vertex target, Vertex elem1, Vertex elem2)
	Notified when two elements of the same type are going to be merged. More...

virtual void	volume_created (Grid grid, Volume vol, GridObject *pParent=NULL, bool replacesParent=false)
	Notified whenever a new element of the given type is created in the given grid. More...

virtual void	volume_to_be_erased (Grid grid, Volume vol, Volume *replacedBy=NULL)
	Notified whenever an element of the given type is erased from the given grid. More...

virtual void	volumes_to_be_merged (Grid grid, Volume target, Volume elem1, Volume elem2)
	Notified when two elements of the same type are going to be merged. More...

virtual	~ISelector ()


void	select (GridObject *elem, byte status)
	selects an element More...

void	select (GridObject *elem)
	selects an element More...

template<class TElem >
void	select (TElem *elem, byte status)
	selects an element More...

template<class TElem >
void	select (TElem *elem)
	selects an element More...

template<class TIterator >
void	select (TIterator iterBegin, TIterator iterEnd, byte status=1)
	selects an element More...


template<class TElem >
void	mark (TElem *elem)
	selects an element More...

template<class TElem >
void	mark (TElem *elem, byte status)
	selects an element More...


byte	get_selection_status (GridObject *elem) const
	returns the selection state of the specified elelent More...

byte	get_selection_status (Vertex *vrt) const
	returns the selection state of the specified elelent More...

byte	get_selection_status (Edge *edge) const
	returns the selection state of the specified elelent More...

byte	get_selection_status (Face *face) const
	returns the selection state of the specified elelent More...

byte	get_selection_status (Volume *vol) const
	returns the selection state of the specified elelent More...

Public Member Functions inherited from ug::GridObserver
virtual	~GridObserver ()

Protected Types
typedef Grid::traits< Edge >::AttachedElementList	AttachedEdgeList

typedef Grid::traits< Face >::AttachedElementList	AttachedFaceList

typedef Grid::traits< Vertex >::AttachedElementList	AttachedVertexList

typedef Grid::traits< Volume >::AttachedElementList	AttachedVolumeList

typedef Attachment< unsigned char >	AUChar

typedef Grid::traits< Edge >::SectionContainer	EdgeSectionContainer

typedef Grid::traits< Face >::SectionContainer	FaceSectionContainer

typedef Grid::traits< Vertex >::SectionContainer	VertexSectionContainer

typedef Grid::traits< Volume >::SectionContainer	VolumeSectionContainer

Protected Member Functions
virtual void	add_to_list (Edge *elem)=0

virtual void	add_to_list (Face *elem)=0

virtual void	add_to_list (Vertex *elem)=0

virtual void	add_to_list (Volume *elem)=0

void	disable_element_support (uint shElements)
	disable support for element-types. More...

template<class TElem >
void	elems_to_be_merged (Grid grid, TElem target, TElem elem1, TElem elem2)
	helper for GridObserver callbacks. More...

void	enable_element_support (uint shElements)
	enable support for element-types. Does not invalidate previous settings. More...

virtual void	erase_from_list (Edge *elem)=0

virtual void	erase_from_list (Face *elem)=0

virtual void	erase_from_list (Vertex *elem)=0

virtual void	erase_from_list (Volume *elem)=0

void	mark_deselected (Edge *elem)

void	mark_deselected (Face *elem)

void	mark_deselected (Vertex *elem)

void	mark_deselected (Volume *elem)

void	mark_selected (Edge *elem, byte status)

void	mark_selected (Face *elem, byte status)

void	mark_selected (Vertex *elem, byte status)

void	mark_selected (Volume *elem, byte status)

void	set_grid (Grid *grid)
	performs grid registration / deregistration and initialisation of the observer. More...

void	set_supported_elements (uint shElements)
	set the type of elements that shall be handled by the SubsetHandler. More...

Private Member Functions
template<class TIntfcCom >
void	broadcast_selection_states (bool deselect, bool includeGhosts, TIntfcCom &icom)
	Copy Constructor not yet implemented! More...

	ISelector (const ISelector &sel)

Detailed Description

base-implementation of a selector

A selector is a useful class, that allows the user to mark elements of a grid as selected or deselected. The selection status is maintained even if new elements are created or old ones deleted. Features like autoselection and selection_inheritance allow users to follow the creation and removal of elements in all kind of algorithms.

Derived classes like Selector and MGSelector or VertexSelector, EdgeSelector, FaceSelector and VolumeSelector keep selected elements in linked lists and allow the user to iterate over them. If a selected element is removed from the underlying grid, it is automatically removed from the element-lists of all associated selectors.

Please note that the selector has to be registered at a grid before it may be used. Derived classes may use the protected method set_grid to do so, or pass a grid directly to the constructor.

This is a base implementation that can not be instatiated. It features most cruical methods like is_selected, select, deselect etc.

autoselection and selection_inheritance can be enabled here. If autoselection is enabled, then all elements that are created while the selector is registered at a grid will automatically be selected.

If selection_inheritance is enabled, then all elements that are created while the selector is registered at a grid, and whose parents (from the same grid) are selected will be automatically selected, too. selection_inheritance is ignored if autoselection is enabled.

Support for different element-types can be enabled / disabled by derived classes using set_supported_elements, enable_element_support or disable_element_support.

Derived classes have to store the selected elements in linked lists of type ISelector::SectionContainer and should feature begin and end itertors to the sections of those lists.

ISelector communicates with derived classes via the methods add_to_list and erase_from_list.

Especially for the implementation of erase_from_list the protected member function get_iterator may be useful, which returns the iterator that is associated with the selected element.

If a derived class wants to change the selection-status of an element behind the scenes (avoids select, deselect), then it may use the protected methods mark_selected, mark_deselected.

Member Typedef Documentation

◆ AttachedEdgeList

typedef Grid::traits<Edge>::AttachedElementList ug::ISelector::AttachedEdgeList

protected

◆ AttachedFaceList

typedef Grid::traits<Face>::AttachedElementList ug::ISelector::AttachedFaceList

protected

◆ AttachedVertexList

typedef Grid::traits<Vertex>::AttachedElementList ug::ISelector::AttachedVertexList

protected

◆ AttachedVolumeList

typedef Grid::traits<Volume>::AttachedElementList ug::ISelector::AttachedVolumeList

protected

◆ AUChar

typedef Attachment<unsigned char> ug::ISelector::AUChar

protected

◆ EdgeSectionContainer

typedef Grid::traits<Edge>::SectionContainer ug::ISelector::EdgeSectionContainer

protected

◆ FaceSectionContainer

typedef Grid::traits<Face>::SectionContainer ug::ISelector::FaceSectionContainer

protected

◆ status_t

typedef byte ug::ISelector::status_t

◆ VertexSectionContainer

typedef Grid::traits<Vertex>::SectionContainer ug::ISelector::VertexSectionContainer

protected

◆ VolumeSectionContainer

typedef Grid::traits<Volume>::SectionContainer ug::ISelector::VolumeSectionContainer

protected

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
DESELECTED
SELECTED

Constructor & Destructor Documentation

◆ ISelector() [1/3]

ug::ISelector::ISelector ( uint supportedElements = SE_ALL )

References m_bAutoselectionEnabled, m_bSelectionInheritanceEnabled, m_bStrictInheritanceEnabled, m_pGrid, and m_supportedElements.

◆ ISelector() [2/3]

ug::ISelector::ISelector	(	Grid &	grid,
		uint	supportedElements = `SE_ALL`
	)

References enable_element_support(), grid(), m_bAutoselectionEnabled, m_bSelectionInheritanceEnabled, m_bStrictInheritanceEnabled, m_pGrid, m_supportedElements, ug::OT_EDGE_OBSERVER, ug::OT_FACE_OBSERVER, ug::OT_GRID_OBSERVER, ug::OT_VERTEX_OBSERVER, ug::OT_VOLUME_OBSERVER, ug::Grid::register_observer(), and ug::SE_NONE.

◆ ~ISelector()

ug::ISelector::~ISelector ( )

virtual

References disable_element_support(), m_pGrid, m_supportedElements, and ug::Grid::unregister_observer().

◆ ISelector() [3/3]

ug::ISelector::ISelector ( const ISelector & sel )

inlineprivate

Member Function Documentation

◆ add_to_list() [1/4]

virtual void ug::ISelector::add_to_list ( Edge * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ add_to_list() [2/4]

virtual void ug::ISelector::add_to_list ( Face * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ add_to_list() [3/4]

virtual void ug::ISelector::add_to_list ( Vertex * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

Referenced by select().

◆ add_to_list() [4/4]

virtual void ug::ISelector::add_to_list ( Volume * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ autoselection_enabled()

bool ug::ISelector::autoselection_enabled ( )

inline

Referenced by ug::Duplicate(), edge_created(), face_created(), ug::GenerateIcosphere(), vertex_created(), and volume_created().

◆ broadcast_selection_states() [1/2]

template<class TIntfcCom >

void ug::ISelector::broadcast_selection_states	(	bool	deselect,
		bool	includeGhosts,
		TIntfcCom &	icom
	)

private

Copy Constructor not yet implemented!

References deselect(), ug::Grid::distributed_grid_manager(), ug::DistributedGridManager::grid_layout_map(), ug::INT_H_MASTER, ug::INT_H_SLAVE, ug::INT_V_MASTER, ug::INT_V_SLAVE, and m_pGrid.

◆ broadcast_selection_states() [2/2]

void ug::ISelector::broadcast_selection_states	(	bool	deselect = `false`,
		bool	includeGhosts = `false`
	)

virtual

broadcasts the current selection

This method is only interesting for parallel algorithms. By setting 'deselect' to true, all copies of an element will be deselected if one or more copies already were deselected.

If 'deselect' is false (this is the default), the selection-states of all copies of an element will be united and applied to all copies of that element.

Set 'includeGhosts' to true, to also broadcast the selection-state to ghost-copies. Default is false.

References deselect(), m_icomEDGE, m_icomFACE, m_icomVOL, m_icomVRT, and m_pGrid.

◆ clear()

virtual void ug::ISelector::clear ( )

pure virtual

Implemented in ug::MGSelector, ug::MGSelector, ug::Selector, and ug::Selector.

Referenced by elements_to_be_cleared(), and set_grid().

◆ contains_edges()

virtual bool ug::ISelector::contains_edges ( ) const

pure virtual

returns true if the selector contains edges

Implemented in ug::MGSelector, and ug::Selector.

Referenced by ug::GridWriterUGX::add_selector().

◆ contains_faces()

virtual bool ug::ISelector::contains_faces ( ) const

pure virtual

returns true if the selector contains faces

Implemented in ug::MGSelector, and ug::Selector.

Referenced by ug::GridWriterUGX::add_selector().

◆ contains_vertices()

virtual bool ug::ISelector::contains_vertices ( ) const

pure virtual

returns true if the selector contains vertices

Implemented in ug::MGSelector, and ug::Selector.

Referenced by ug::GridWriterUGX::add_selector().

◆ contains_volumes()

virtual bool ug::ISelector::contains_volumes ( ) const

pure virtual

returns true if the selector contains volumes

Implemented in ug::MGSelector, and ug::Selector.

Referenced by ug::GridWriterUGX::add_selector().

◆ deselect() [1/3]

void ug::ISelector::deselect ( GridObject * elem )

inline

References ug::GridObject::base_object_id(), ug::EDGE, ug::FACE, ug::VERTEX, and ug::VOLUME.

Referenced by ug::AssignVerticalMasterAndSlaveStates(), broadcast_selection_states(), ug::HangingNodeRefiner_MultiGrid::collect_objects_for_coarsen(), ug::CollectInnerVertices(), ug::CutEdgesWithPlane(), deselect(), ug::DeselectFamily(), edge_to_be_erased(), ug::ComPol_BroadcastCoarsenMarks< TLayout >::extract(), ug::ComPol_Selection< TLayout >::extract(), face_to_be_erased(), ug::HangingNodeRefiner_MultiGrid::perform_coarsening(), ug::PerformCollapses(), ug::PerformSplits(), ug::PerformSwaps(), ug::HangingNodeRefiner_MultiGrid::restrict_selection_to_coarsen_families(), ug::HangingNodeRefiner_MultiGrid::restrict_selection_to_surface_coarsen_elements(), select(), ug::SelectAreaBoundary(), ug::SeparateSubsetsByLowerDimSeparators(), vertex_to_be_erased(), and volume_to_be_erased().

◆ deselect() [2/3]

template<class TElem >

void ug::ISelector::deselect ( TElem * elem )

inline

References erase_from_list(), is_selected(), and mark_deselected().

◆ deselect() [3/3]

template<class TIterator >

void ug::ISelector::deselect	(	TIterator	iterBegin,
		TIterator	iterEnd
	)

inline

References deselect().

◆ disable_element_support()

void ug::ISelector::disable_element_support ( uint shElements )

protected

disable support for element-types.

pass an or-combination of constants enumerated in SubsetHandlerElements.

References ug::Grid::detach_from_edges(), ug::Grid::detach_from_faces(), ug::Grid::detach_from_vertices(), ug::Grid::detach_from_volumes(), elements_are_supported(), m_aSelected, m_pGrid, m_supportedElements, ug::SE_EDGE, ug::SE_FACE, ug::SE_VERTEX, and ug::SE_VOLUME.

Referenced by ug::Selector::disable_element_support(), ug::MGSelector::disable_element_support(), set_grid(), set_supported_elements(), and ~ISelector().

◆ edge_created()

void ug::ISelector::edge_created	(	Grid *	grid,
		Edge *	e,
		GridObject *	pParent = `NULL`,
		bool	replacesParent = `false`
	)

virtual

Notified whenever a new element of the given type is created in the given grid.

Creation callbacks are called in the order in which the GridObservers were registered at the given grid.

If replacesParent is true, then pParent is of the same base type as the created object (e.g. in case of edge_created, the parent is an Edge*). This case usually appears, when a contraining object is replaced by a regular grid object if the same base type during refinement. The method is called with replacesParent == true by Grid::create_and_replace methods.

Please note: If replacesParent == true, then a call to OBJECT_to_be_erased(grid, pParent, obj) will follow (OBJECT and obj are pseudonyms for the concrete type).

Reimplemented from ug::GridObserver.

References autoselection_enabled(), ug::GridObject::base_object_id(), ug::EDGE, elements_are_supported(), get_selection_status(), grid(), m_bStrictInheritanceEnabled, m_pGrid, mark_deselected(), ug::SE_EDGE, select(), selection_inheritance_enabled(), and UG_ASSERT.

◆ edge_to_be_erased()

void ug::ISelector::edge_to_be_erased	(	Grid *	grid,
		Edge *	e,
		Edge *	replacedBy = `NULL`
	)

virtual

Notified whenever an element of the given type is erased from the given grid.

Erase callbacks are called in reverse order in which the GridObservers were registered at the given grid.

if replacedBy != NULL the erased object is only replaced by another grid object of the same base type. This usually happens when constraining objects are replaced by regular objects in refinements. (E.g. a constraining edge by become a regular Edge; note that both objects are of type Edge*).

Reimplemented from ug::GridObserver.

References deselect(), elements_are_supported(), grid(), m_pGrid, and ug::SE_EDGE.

◆ edges_to_be_merged()

void ug::ISelector::edges_to_be_merged	(	Grid *	grid,
		Edge *	target,
		Edge *	elem1,
		Edge *	elem2
	)

virtual

Notified when two elements of the same type are going to be merged.

Note that this method is invoked by Grid::objects_will_be_merged, which is called from outside the grid class. Implementors of algorithms in which objects are merged are thus responsible to call Grid::objects_will_be_merged.

This callback is called in addition to ..._created and ..._to_be_erased callbacks and should thus only be used if small adjustments have to be made during a merge.

Note that target may be identical to elem1 or elem2.

Reimplemented from ug::GridObserver.

References elems_to_be_merged(), grid(), and boost::target().

◆ elements_are_supported()

bool ug::ISelector::elements_are_supported ( uint shElements ) const

inline

returns true if the given element-types are supported.

pass an or-combination of constants enumerated in SubsetHandlerElements.

References m_supportedElements.

Referenced by ug::MGSelector::add_level(), ug::Selector::disable_element_support(), disable_element_support(), ug::MGSelector::disable_element_support(), edge_created(), edge_to_be_erased(), ug::Selector::enable_element_support(), enable_element_support(), ug::MGSelector::enable_element_support(), face_created(), face_to_be_erased(), ug::GridReaderUGX::selector(), vertex_created(), vertex_to_be_erased(), volume_created(), volume_to_be_erased(), and ug::Selector::~Selector().

◆ elements_to_be_cleared()

void ug::ISelector::elements_to_be_cleared ( Grid * grid )

virtual

Reimplemented from ug::GridObserver.

References clear().

◆ elems_to_be_merged()

template<class TElem >

void ug::ISelector::elems_to_be_merged	(	Grid *	grid,
		TElem *	target,
		TElem *	elem1,
		TElem *	elem2
	)

protected

helper for GridObserver callbacks.

References is_selected(), select(), and boost::target().

Referenced by edges_to_be_merged(), faces_to_be_merged(), vertices_to_be_merged(), and volumes_to_be_merged().

◆ enable_autoselection()

void ug::ISelector::enable_autoselection ( bool bEnable )

References m_bAutoselectionEnabled.

Referenced by ug::AllGatherGrid(), ug::AdaptiveRegularRefiner_MultiGrid::create_closure_elements_2d(), ug::AdaptiveRegularRefiner_MultiGrid::create_closure_elements_3d(), ug::Duplicate(), ug::ExpandFractures2d(), ug::ExpandFractures3d(), ug::GatherGrid(), ug::GenerateIcosphere(), ug::ResolveTriangleIntersections(), and ug::AdaptiveRegularRefiner_MultiGrid::set_grid().

◆ enable_element_support()

void ug::ISelector::enable_element_support ( uint shElements )

protected

enable support for element-types. Does not invalidate previous settings.

pass an or-combination of constants enumerated in SubsetHandlerElements.

References ug::Grid::attach_to_edges(), ug::Grid::attach_to_faces(), ug::Grid::attach_to_vertices(), ug::Grid::attach_to_volumes(), ug::Grid::begin(), elements_are_supported(), ug::Grid::end(), m_aaSelEDGE, m_aaSelFACE, m_aaSelVOL, m_aaSelVRT, m_aSelected, m_pGrid, m_supportedElements, ug::SE_EDGE, ug::SE_FACE, ug::SE_VERTEX, ug::SE_VOLUME, and ug::SetAttachmentValues().

Referenced by ug::Selector::enable_element_support(), ug::MGSelector::enable_element_support(), ISelector(), set_grid(), and set_supported_elements().

◆ enable_selection_inheritance()

void ug::ISelector::enable_selection_inheritance ( bool bEnable )

References m_bSelectionInheritanceEnabled.

Referenced by ug::AdjustEdgeLength(), ug::Duplicate(), ug::ExpandFractures2d(), ug::ExpandFractures3d(), ug::ResolveTriangleIntersections(), and ug::AdaptiveRegularRefiner_MultiGrid::set_grid().

◆ enable_strict_inheritance()

void ug::ISelector::enable_strict_inheritance ( bool bEnable )

restricts subset inheritance so that new elements derive their selection status only from parents with the same base-type. Disabled by default. NOTE: strict inheritance only has an effect if selection inheritance is enabled.

References m_bStrictInheritanceEnabled.

Referenced by ug::ExpandFractures3d(), and ug::AdaptiveRegularRefiner_MultiGrid::set_grid().

◆ erase_from_list() [1/4]

virtual void ug::ISelector::erase_from_list ( Edge * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ erase_from_list() [2/4]

virtual void ug::ISelector::erase_from_list ( Face * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ erase_from_list() [3/4]

virtual void ug::ISelector::erase_from_list ( Vertex * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

Referenced by deselect().

◆ erase_from_list() [4/4]

virtual void ug::ISelector::erase_from_list ( Volume * elem )

protectedpure virtual

Implemented in ug::MGSelector, and ug::Selector.

◆ face_created()

void ug::ISelector::face_created	(	Grid *	grid,
		Face *	f,
		GridObject *	pParent = `NULL`,
		bool	replacesParent = `false`
	)

virtual

Notified whenever a new element of the given type is created in the given grid.

Creation callbacks are called in the order in which the GridObservers were registered at the given grid.

If replacesParent is true, then pParent is of the same base type as the created object (e.g. in case of edge_created, the parent is an Edge*). This case usually appears, when a contraining object is replaced by a regular grid object if the same base type during refinement. The method is called with replacesParent == true by Grid::create_and_replace methods.

Please note: If replacesParent == true, then a call to OBJECT_to_be_erased(grid, pParent, obj) will follow (OBJECT and obj are pseudonyms for the concrete type).

Reimplemented from ug::GridObserver.

References autoselection_enabled(), ug::GridObject::base_object_id(), elements_are_supported(), ug::FACE, get_selection_status(), grid(), m_bStrictInheritanceEnabled, m_pGrid, mark_deselected(), ug::SE_FACE, select(), selection_inheritance_enabled(), and UG_ASSERT.

◆ face_to_be_erased()

void ug::ISelector::face_to_be_erased	(	Grid *	grid,
		Face *	f,
		Face *	replacedBy = `NULL`
	)

virtual

Notified whenever an element of the given type is erased from the given grid.

Erase callbacks are called in reverse order in which the GridObservers were registered at the given grid.

if replacedBy != NULL the erased object is only replaced by another grid object of the same base type. This usually happens when constraining objects are replaced by regular objects in refinements. (E.g. a constraining edge by become a regular Edge; note that both objects are of type Edge*).

Reimplemented from ug::GridObserver.

References deselect(), elements_are_supported(), grid(), m_pGrid, and ug::SE_FACE.

◆ faces_to_be_merged()

void ug::ISelector::faces_to_be_merged	(	Grid *	grid,
		Face *	target,
		Face *	elem1,
		Face *	elem2
	)

virtual

Notified when two elements of the same type are going to be merged.

Note that this method is invoked by Grid::objects_will_be_merged, which is called from outside the grid class. Implementors of algorithms in which objects are merged are thus responsible to call Grid::objects_will_be_merged.

This callback is called in addition to ..._created and ..._to_be_erased callbacks and should thus only be used if small adjustments have to be made during a merge.

Note that target may be identical to elem1 or elem2.

Reimplemented from ug::GridObserver.

References elems_to_be_merged(), grid(), and boost::target().

◆ get_grid_objects()

virtual GridObjectCollection ug::ISelector::get_grid_objects ( ) const

pure virtual

returns a geometric object collection, containing all selected objects

Implemented in ug::MGSelector, and ug::Selector.

Referenced by ug::AssignSelectionToSubset(), ug::CollectVerticesTouchingSelection(), ug::CopySubsetIndicesToSides(), ug::GridWriterUGX::create_selector_element_node(), ug::FaceArea(), ug::GetSelectedElementIndices(), ug::SelectAssociatedElements(), and ug::SelectLinkedElements().