keep track of edges (defined by pair of integer id's) More...

#include <vtkGenericEdgeTable.h>

Inheritance diagram for vtkGenericEdgeTable:

Collaboration diagram for vtkGenericEdgeTable:

Classes
class	EdgeEntry

class	PointEntry

Public Member Functions
void	InsertEdge (vtkIdType e1, vtkIdType e2, vtkIdType cellId, int ref, vtkIdType &ptId)
	Split the edge with the indicated point id. More...

void	InsertEdge (vtkIdType e1, vtkIdType e2, vtkIdType cellId, int ref=1)
	Insert an edge but do not split it. More...

int	RemoveEdge (vtkIdType e1, vtkIdType e2)
	Method to remove an edge from the table. More...

int	CheckEdge (vtkIdType e1, vtkIdType e2, vtkIdType &ptId)
	Method to determine whether an edge is in the table (0 or 1), or not (-1). More...

int	IncrementEdgeReferenceCount (vtkIdType e1, vtkIdType e2, vtkIdType cellId)
	Method that increments the referencecount and returns it. More...

int	CheckEdgeReferenceCount (vtkIdType e1, vtkIdType e2)
	Return the edge reference count. More...

void	Initialize (vtkIdType start)
	To specify the starting point id. More...

int	GetNumberOfComponents ()
	Return the total number of components for the point-centered attributes. More...

void	SetNumberOfComponents (int count)
	Set the total number of components for the point-centered attributes. More...

int	CheckPoint (vtkIdType ptId)
	Check if a point is already in the point table. More...

int	CheckPoint (vtkIdType ptId, double point[3], double *scalar)
	Check for the existence of a point and return its coordinate value. More...

void	RemovePoint (vtkIdType ptId)
	Remove a point from the point table. More...

void	IncrementPointReferenceCount (vtkIdType ptId)
	Increment the reference count for the indicated point. More...


void	InsertPoint (vtkIdType ptId, double point[3])
	Insert point associated with an edge. More...

void	InsertPointAndScalar (vtkIdType ptId, double pt[3], double *s)
	Insert point associated with an edge. More...


void	DumpTable ()
	For debugging purposes. More...

void	LoadFactor ()
	For debugging purposes. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkGenericEdgeTable *	New ()
	Instantiate an empty edge table. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
	vtkGenericEdgeTable ()

	~vtkGenericEdgeTable () override

void	InsertEdge (vtkIdType e1, vtkIdType e2, vtkIdType cellId, int ref, int toSplit, vtkIdType &ptId)
	Split the edge with the indicated point id. More...

vtkIdType	HashFunction (vtkIdType e1, vtkIdType e2)

vtkIdType	HashFunction (vtkIdType ptId)

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkEdgeTableEdge *	EdgeTable

vtkEdgeTablePoints *	HashPoints

vtkIdType	LastPointId

vtkIdType	NumberOfComponents

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkObject	Superclass
	Standard VTK type and print macros. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard VTK type and print macros. More...

static vtkGenericEdgeTable *	SafeDownCast (vtkObjectBase *o)
	Standard VTK type and print macros. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard VTK type and print macros. More...

vtkGenericEdgeTable *	NewInstance () const
	Standard VTK type and print macros. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard VTK type and print macros. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK type and print macros. More...

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

keep track of edges (defined by pair of integer id's)

vtkGenericEdgeTable is used to indicate the existence of and hold information about edges. Similar to vtkEdgeTable, this class is more sophisticated in that it uses reference counting to keep track of when information about an edge should be deleted.

vtkGenericEdgeTable is a helper class used in the adaptor framework. It is used during the tessellation process to hold information about the error metric on each edge. This avoids recomputing the error metric each time the same edge is visited.

Definition at line 28 of file vtkGenericEdgeTable.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGenericEdgeTable::Superclass

Standard VTK type and print macros.

Definition at line 40 of file vtkGenericEdgeTable.h.

Constructor & Destructor Documentation

◆ vtkGenericEdgeTable()

vtkGenericEdgeTable::vtkGenericEdgeTable ( )

protected

◆ ~vtkGenericEdgeTable()

vtkGenericEdgeTable::~vtkGenericEdgeTable ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGenericEdgeTable* vtkGenericEdgeTable::New ( )

static

Instantiate an empty edge table.

◆ IsTypeOf()

static vtkTypeBool vtkGenericEdgeTable::IsTypeOf ( const char * type )

static

Standard VTK type and print macros.

◆ IsA()

virtual vtkTypeBool vtkGenericEdgeTable::IsA ( const char * type )

virtual

Standard VTK type and print macros.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkGenericEdgeTable* vtkGenericEdgeTable::SafeDownCast ( vtkObjectBase * o )

static

Standard VTK type and print macros.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericEdgeTable::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK type and print macros.

◆ NewInstance()

vtkGenericEdgeTable* vtkGenericEdgeTable::NewInstance ( ) const

Standard VTK type and print macros.

◆ PrintSelf()

void vtkGenericEdgeTable::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard VTK type and print macros.

Reimplemented from vtkObject.

◆ InsertEdge() [1/3]

void vtkGenericEdgeTable::InsertEdge	(	vtkIdType	e1,
		vtkIdType	e2,
		vtkIdType	cellId,
		int	ref,
		vtkIdType &	ptId
	)

Split the edge with the indicated point id.

◆ InsertEdge() [2/3]

void vtkGenericEdgeTable::InsertEdge	(	vtkIdType	e1,
		vtkIdType	e2,
		vtkIdType	cellId,
		int	ref = `1`
	)

Insert an edge but do not split it.

◆ RemoveEdge()

int vtkGenericEdgeTable::RemoveEdge	(	vtkIdType	e1,
		vtkIdType	e2
	)

Method to remove an edge from the table.

The method returns the current reference count.

◆ CheckEdge()

int vtkGenericEdgeTable::CheckEdge	(	vtkIdType	e1,
		vtkIdType	e2,
		vtkIdType &	ptId
	)

Method to determine whether an edge is in the table (0 or 1), or not (-1).

It returns whether the edge was split (1) or not (0), and the point id exists.

◆ IncrementEdgeReferenceCount()

int vtkGenericEdgeTable::IncrementEdgeReferenceCount	(	vtkIdType	e1,
		vtkIdType	e2,
		vtkIdType	cellId
	)

Method that increments the referencecount and returns it.

◆ CheckEdgeReferenceCount()

int vtkGenericEdgeTable::CheckEdgeReferenceCount	(	vtkIdType	e1,
		vtkIdType	e2
	)

Return the edge reference count.

◆ Initialize()

void vtkGenericEdgeTable::Initialize ( vtkIdType start )

To specify the starting point id.

It will initialize LastPointId This is very sensitive the start point should be cautiously chosen

◆ GetNumberOfComponents()

int vtkGenericEdgeTable::GetNumberOfComponents ( )

Return the total number of components for the point-centered attributes.

Postcondition: positive_result: result>0

◆ SetNumberOfComponents()

void vtkGenericEdgeTable::SetNumberOfComponents ( int count )

Set the total number of components for the point-centered attributes.

Precondition: positive_count: count>0

◆ CheckPoint() [1/2]

int vtkGenericEdgeTable::CheckPoint ( vtkIdType ptId )

Check if a point is already in the point table.

◆ CheckPoint() [2/2]

int vtkGenericEdgeTable::CheckPoint	(	vtkIdType	ptId,
		double	point[3],
		double *	scalar
	)

Check for the existence of a point and return its coordinate value.

Precondition: scalar_size: sizeof(scalar)==this->GetNumberOfComponents()

◆ InsertPoint()

void vtkGenericEdgeTable::InsertPoint	(	vtkIdType	ptId,
		double	point[3]
	)

Insert point associated with an edge.

◆ InsertPointAndScalar()

void vtkGenericEdgeTable::InsertPointAndScalar	(	vtkIdType	ptId,
		double	pt[3],
		double *	s
	)

Insert point associated with an edge.

◆ RemovePoint()

void vtkGenericEdgeTable::RemovePoint ( vtkIdType ptId )

Remove a point from the point table.

◆ IncrementPointReferenceCount()

void vtkGenericEdgeTable::IncrementPointReferenceCount ( vtkIdType ptId )

Increment the reference count for the indicated point.

◆ DumpTable()

void vtkGenericEdgeTable::DumpTable ( )

For debugging purposes.

It is particularly useful to dump the table and check that nothing is left after a complete iteration. LoadFactor should ideally be very low to be able to have a constant time access

◆ LoadFactor()

void vtkGenericEdgeTable::LoadFactor ( )

For debugging purposes.

It is particularly useful to dump the table and check that nothing is left after a complete iteration. LoadFactor should ideally be very low to be able to have a constant time access

◆ InsertEdge() [3/3]

void vtkGenericEdgeTable::InsertEdge	(	vtkIdType	e1,
		vtkIdType	e2,
		vtkIdType	cellId,
		int	ref,
		int	toSplit,
		vtkIdType &	ptId
	)

protected

Split the edge with the indicated point id.

◆ HashFunction() [1/2]

vtkIdType vtkGenericEdgeTable::HashFunction	(	vtkIdType	e1,
		vtkIdType	e2
	)

protected

◆ HashFunction() [2/2]

vtkIdType vtkGenericEdgeTable::HashFunction ( vtkIdType ptId )

protected

Member Data Documentation

◆ EdgeTable

vtkEdgeTableEdge* vtkGenericEdgeTable::EdgeTable

protected

Definition at line 245 of file vtkGenericEdgeTable.h.

◆ HashPoints

vtkEdgeTablePoints* vtkGenericEdgeTable::HashPoints

protected

Definition at line 248 of file vtkGenericEdgeTable.h.

◆ LastPointId

vtkIdType vtkGenericEdgeTable::LastPointId

protected

Definition at line 258 of file vtkGenericEdgeTable.h.

◆ NumberOfComponents

vtkIdType vtkGenericEdgeTable::NumberOfComponents

protected

Definition at line 260 of file vtkGenericEdgeTable.h.

The documentation for this class was generated from the following file:

Common/DataModel/vtkGenericEdgeTable.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGenericEdgeTable()

◆ ~vtkGenericEdgeTable()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ InsertEdge() [1/3]

◆ InsertEdge() [2/3]

◆ RemoveEdge()

◆ CheckEdge()

◆ IncrementEdgeReferenceCount()

◆ CheckEdgeReferenceCount()

◆ Initialize()

◆ GetNumberOfComponents()

◆ SetNumberOfComponents()

◆ CheckPoint() [1/2]

◆ CheckPoint() [2/2]

◆ InsertPoint()

◆ InsertPointAndScalar()

◆ RemovePoint()

◆ IncrementPointReferenceCount()

◆ DumpTable()

◆ LoadFactor()

◆ InsertEdge() [3/3]

◆ HashFunction() [1/2]

◆ HashFunction() [2/2]

Member Data Documentation

◆ EdgeTable

◆ HashPoints

◆ LastPointId

◆ NumberOfComponents