Defines API for interpolating/modifying nodes from a vtkContourRepresentation. More...

#include <vtkContourLineInterpolator.h>

Inheritance diagram for vtkContourLineInterpolator:

Collaboration diagram for vtkContourLineInterpolator:

Public Member Functions
virtual int	InterpolateLine (vtkRenderer ren, vtkContourRepresentation rep, int idx1, int idx2)=0
	Subclasses that wish to interpolate a line segment must implement this. More...

virtual int	UpdateNode (vtkRenderer , vtkContourRepresentation , double *vtkNotUsed(node), int vtkNotUsed(idx))
	The interpolator is given a chance to update the node. More...

virtual void	GetSpan (int nodeIndex, vtkIntArray nodeIndices, vtkContourRepresentation rep)
	Span of the interpolator. 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...

Protected Member Functions
	vtkContourLineInterpolator ()

	~vtkContourLineInterpolator () override

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 &)

typedef vtkObject	Superclass
	Standard methods for instances of this class. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkContourLineInterpolator *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class. More...

vtkContourLineInterpolator *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class. More...

Additional Inherited Members
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...

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Detailed Description

Defines API for interpolating/modifying nodes from a vtkContourRepresentation.

vtkContourLineInterpolator is an abstract base class for interpolators that are used by the vtkContourRepresentation class to interpolate and/or modify nodes in a contour. Subclasses must override the virtual method InterpolateLine. This is used by the contour representation to give the interpolator a chance to define an interpolation scheme between nodes. See vtkBezierContourLineInterpolator for a concrete implementation. Subclasses may also override UpdateNode. This provides a way for the representation to give the interpolator a chance to modify the nodes, as the user constructs the contours. For instance, a sticky contour widget may be implemented that moves nodes to nearby regions of high gradient, to be used in contour-guided segmentation.

Definition at line 31 of file vtkContourLineInterpolator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkContourLineInterpolator::Superclass

Standard methods for instances of this class.

Definition at line 38 of file vtkContourLineInterpolator.h.

Constructor & Destructor Documentation

◆ vtkContourLineInterpolator()

vtkContourLineInterpolator::vtkContourLineInterpolator ( )

protected

◆ ~vtkContourLineInterpolator()

vtkContourLineInterpolator::~vtkContourLineInterpolator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods for instances of this class.

◆ IsA()

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkObjectBase.

Reimplemented in vtkTerrainContourLineInterpolator, vtkPolygonalSurfaceContourLineInterpolator, vtkPolyDataContourLineInterpolator, vtkLinearContourLineInterpolator, vtkDijkstraImageContourLineInterpolator, and vtkBezierContourLineInterpolator.

◆ SafeDownCast()

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

static

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkContourLineInterpolator::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented in vtkTerrainContourLineInterpolator, vtkPolygonalSurfaceContourLineInterpolator, vtkPolyDataContourLineInterpolator, vtkLinearContourLineInterpolator, vtkDijkstraImageContourLineInterpolator, and vtkBezierContourLineInterpolator.

◆ NewInstance()

vtkContourLineInterpolator* vtkContourLineInterpolator::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkObject.

Reimplemented in vtkTerrainContourLineInterpolator, vtkPolygonalSurfaceContourLineInterpolator, vtkPolyDataContourLineInterpolator, vtkLinearContourLineInterpolator, and vtkDijkstraImageContourLineInterpolator.

◆ InterpolateLine()

virtual int vtkContourLineInterpolator::InterpolateLine	(	vtkRenderer *	ren,
		vtkContourRepresentation *	rep,
		int	idx1,
		int	idx2
	)

pure virtual

Subclasses that wish to interpolate a line segment must implement this.

For instance vtkBezierContourLineInterpolator adds nodes between idx1 and idx2, that allow the contour to adhere to a bezier curve.

Implemented in vtkPolyDataContourLineInterpolator, vtkTerrainContourLineInterpolator, vtkPolygonalSurfaceContourLineInterpolator, vtkLinearContourLineInterpolator, vtkDijkstraImageContourLineInterpolator, and vtkBezierContourLineInterpolator.

◆ UpdateNode()

virtual int vtkContourLineInterpolator::UpdateNode	(	vtkRenderer *	,
		vtkContourRepresentation *	,
		double *	vtkNotUsednode,
		int	vtkNotUsedidx
	)

virtual

The interpolator is given a chance to update the node.

For instance, the vtkImageContourLineInterpolator updates the idx'th node in the contour, so it automatically sticks to edges in the vicinity as the user constructs the contour. Returns 0 if the node (world position) is unchanged.

Reimplemented in vtkPolyDataContourLineInterpolator, vtkTerrainContourLineInterpolator, and vtkPolygonalSurfaceContourLineInterpolator.

◆ GetSpan()

virtual void vtkContourLineInterpolator::GetSpan	(	int	nodeIndex,
		vtkIntArray *	nodeIndices,
		vtkContourRepresentation *	rep
	)

virtual

Span of the interpolator.

ie. the number of control points its supposed to interpolate given a node.

The first argument is the current nodeIndex. ie, you'd be trying to interpolate between nodes "nodeIndex" and "nodeIndex-1", unless you're closing the contour in which case, you're trying to interpolate "nodeIndex" and "Node=0".

The node span is returned in a vtkIntArray. The default node span is 1 (ie. nodeIndices is a 2 tuple (nodeIndex, nodeIndex-1)). However, it need not always be 1. For instance, cubic spline interpolators, which have a span of 3 control points, it can be larger. See vtkBezierContourLineInterpolator for instance.

Reimplemented in vtkBezierContourLineInterpolator.

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

Interaction/Widgets/vtkContourLineInterpolator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkContourLineInterpolator()

◆ ~vtkContourLineInterpolator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ InterpolateLine()

◆ UpdateNode()

◆ GetSpan()