#include <vtkLabelHierarchyIterator.h>

Inheritance diagram for vtkLabelHierarchyIterator:

Collaboration diagram for vtkLabelHierarchyIterator:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkLabelHierarchyIterator *	NewInstance () const

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

virtual void	Begin (vtkIdTypeArray *)
	Initializes the iterator. More...

virtual void	Next ()
	Advance the iterator. More...

virtual bool	IsAtEnd ()
	Returns true if the iterator is at the end. More...

virtual void	GetPoint (double x[3])
	Retrieves the current label location. More...

virtual void	GetSize (double sz[2])
	Retrieves the current label size. More...

virtual void	GetBoundedSize (double sz[2])
	Retrieves the current label maximum width in world coordinates. More...

virtual int	GetType ()
	Retrieves the current label type. More...

virtual vtkStdString	GetLabel ()
	Retrieves the current label string. More...

virtual vtkUnicodeString	GetUnicodeLabel ()
	Retrieves the current label as a unicode string. More...

virtual double	GetOrientation ()
	Retrieves the current label orientation. More...

virtual vtkIdType	GetLabelId ()
	Retrieves the current label id. More...

virtual void	SetTraversedBounds (vtkPolyData *)
	Sets a polydata to fill with geometry representing the bounding boxes of the traversed octree nodes. More...

virtual void	GetNodeGeometry (double ctr[3], double &size)=0
	Retrieve the coordinates of the center of the current hierarchy node and the size of the node. More...

virtual void	BoxNode ()
	Add a representation to TraversedBounds for the current octree node. More...

virtual void	BoxAllNodes (vtkPolyData *)
	Add a representation for all existing octree nodes to the specified polydata. More...


virtual vtkLabelHierarchy *	GetHierarchy ()
	Get the label hierarchy associated with the current label. More...


virtual void	SetAllBounds (int)
	Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed. More...

virtual int	GetAllBounds ()
	Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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...

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

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

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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...

virtual 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...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkLabelHierarchyIterator *	SafeDownCast (vtkObjectBase *o)

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 (int 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 int	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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLabelHierarchyIterator ()

	~vtkLabelHierarchyIterator () override

void	BoxNodeInternal3 (const double *ctr, double sz)

void	BoxNodeInternal2 (const double *ctr, double sz)

virtual void	SetHierarchy (vtkLabelHierarchy *h)
	The hierarchy being traversed by this iterator. More...

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkLabelHierarchy *	Hierarchy

vtkPolyData *	TraversedBounds

double	BoundsFactor

int	AllBounds

int	AllBoundsRecorded

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

iterator over vtkLabelHierarchy

Abstract superclass for iterators over vtkLabelHierarchy.

Definition at line 40 of file vtkLabelHierarchyIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkLabelHierarchyIterator::Superclass

Definition at line 43 of file vtkLabelHierarchyIterator.h.

Constructor & Destructor Documentation

◆ vtkLabelHierarchyIterator()

vtkLabelHierarchyIterator::vtkLabelHierarchyIterator ( )

protected

◆ ~vtkLabelHierarchyIterator()

vtkLabelHierarchyIterator::~vtkLabelHierarchyIterator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkLabelHierarchyIterator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

Reimplemented in vtkLabelHierarchyCompositeIterator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLabelHierarchyIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkLabelHierarchyCompositeIterator.

◆ NewInstance()

vtkLabelHierarchyIterator * vtkLabelHierarchyIterator::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ Begin()

virtual void vtkLabelHierarchyIterator::Begin ( vtkIdTypeArray * )

inlinevirtual

Initializes the iterator.

lastLabels is an array holding labels which should be traversed before any other labels in the hierarchy. This could include labels placed during a previous rendering or a label located under the mouse pointer. You may pass a null pointer.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 52 of file vtkLabelHierarchyIterator.h.

◆ Next()

virtual void vtkLabelHierarchyIterator::Next ( )

inlinevirtual

Advance the iterator.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 57 of file vtkLabelHierarchyIterator.h.

◆ IsAtEnd()

virtual bool vtkLabelHierarchyIterator::IsAtEnd ( )

inlinevirtual

Returns true if the iterator is at the end.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 62 of file vtkLabelHierarchyIterator.h.

◆ GetPoint()

virtual void vtkLabelHierarchyIterator::GetPoint ( double x[3] )

virtual

Retrieves the current label location.

◆ GetSize()

virtual void vtkLabelHierarchyIterator::GetSize ( double sz[2] )

virtual

Retrieves the current label size.

◆ GetBoundedSize()

virtual void vtkLabelHierarchyIterator::GetBoundedSize ( double sz[2] )

virtual

Retrieves the current label maximum width in world coordinates.

◆ GetType()

virtual int vtkLabelHierarchyIterator::GetType ( )

virtual

Retrieves the current label type.

◆ GetLabel()

virtual vtkStdString vtkLabelHierarchyIterator::GetLabel ( )

virtual

Retrieves the current label string.

◆ GetUnicodeLabel()

virtual vtkUnicodeString vtkLabelHierarchyIterator::GetUnicodeLabel ( )

virtual

Retrieves the current label as a unicode string.

◆ GetOrientation()

virtual double vtkLabelHierarchyIterator::GetOrientation ( )

virtual

Retrieves the current label orientation.

◆ GetLabelId()

virtual vtkIdType vtkLabelHierarchyIterator::GetLabelId ( )

inlinevirtual

Retrieves the current label id.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 103 of file vtkLabelHierarchyIterator.h.

◆ GetHierarchy()

virtual vtkLabelHierarchy * vtkLabelHierarchyIterator::GetHierarchy ( )

virtual

Get the label hierarchy associated with the current label.

Reimplemented in vtkLabelHierarchyCompositeIterator.

◆ SetTraversedBounds()

virtual void vtkLabelHierarchyIterator::SetTraversedBounds ( vtkPolyData * )

virtual

Sets a polydata to fill with geometry representing the bounding boxes of the traversed octree nodes.

◆ GetNodeGeometry()

virtual void vtkLabelHierarchyIterator::GetNodeGeometry	(	double	ctr[3],
		double &	size
	)

pure virtual

Retrieve the coordinates of the center of the current hierarchy node and the size of the node.

Nodes are n-cubes, so the size is the length of any edge of the cube. This is used by BoxNode().

Implemented in vtkLabelHierarchyCompositeIterator.

◆ BoxNode()

virtual void vtkLabelHierarchyIterator::BoxNode ( )

virtual

Add a representation to TraversedBounds for the current octree node.

This should be called by subclasses inside Next(). Does nothing if TraversedBounds is NULL.

Reimplemented in vtkLabelHierarchyCompositeIterator.

◆ BoxAllNodes()

virtual void vtkLabelHierarchyIterator::BoxAllNodes ( vtkPolyData * )

virtual

Add a representation for all existing octree nodes to the specified polydata.

This is equivalent to setting TraversedBounds, iterating over the entire hierarchy, and then resetting TraversedBounds to its original value.

Reimplemented in vtkLabelHierarchyCompositeIterator.

◆ SetAllBounds()

virtual void vtkLabelHierarchyIterator::SetAllBounds ( int )

virtual

Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed.

When non-zero, all nodes will be added. By default, AllBounds is 0.

◆ GetAllBounds()

virtual int vtkLabelHierarchyIterator::GetAllBounds ( )

virtual

Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed.

When non-zero, all nodes will be added. By default, AllBounds is 0.

◆ BoxNodeInternal3()

void vtkLabelHierarchyIterator::BoxNodeInternal3	(	const double *	ctr,
		double	sz
	)

protected

◆ BoxNodeInternal2()

void vtkLabelHierarchyIterator::BoxNodeInternal2	(	const double *	ctr,
		double	sz
	)

protected

◆ SetHierarchy()

virtual void vtkLabelHierarchyIterator::SetHierarchy ( vtkLabelHierarchy * h )

protectedvirtual

The hierarchy being traversed by this iterator.

Member Data Documentation

◆ Hierarchy

vtkLabelHierarchy* vtkLabelHierarchyIterator::Hierarchy

protected

Definition at line 163 of file vtkLabelHierarchyIterator.h.

◆ TraversedBounds

vtkPolyData* vtkLabelHierarchyIterator::TraversedBounds

protected

Definition at line 164 of file vtkLabelHierarchyIterator.h.

◆ BoundsFactor

double vtkLabelHierarchyIterator::BoundsFactor

protected

Definition at line 165 of file vtkLabelHierarchyIterator.h.

◆ AllBounds

int vtkLabelHierarchyIterator::AllBounds

protected

Definition at line 166 of file vtkLabelHierarchyIterator.h.

◆ AllBoundsRecorded

int vtkLabelHierarchyIterator::AllBoundsRecorded

protected

Definition at line 167 of file vtkLabelHierarchyIterator.h.

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

Rendering/Label/vtkLabelHierarchyIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkLabelHierarchyIterator()

◆ ~vtkLabelHierarchyIterator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Begin()

◆ Next()

◆ IsAtEnd()

◆ GetPoint()

◆ GetSize()

◆ GetBoundedSize()

◆ GetType()

◆ GetLabel()

◆ GetUnicodeLabel()

◆ GetOrientation()

◆ GetLabelId()

◆ GetHierarchy()

◆ SetTraversedBounds()

◆ GetNodeGeometry()

◆ BoxNode()

◆ BoxAllNodes()

◆ SetAllBounds()

◆ GetAllBounds()

◆ BoxNodeInternal3()

◆ BoxNodeInternal2()

◆ SetHierarchy()

Member Data Documentation

◆ Hierarchy

◆ TraversedBounds

◆ BoundsFactor

◆ AllBounds

◆ AllBoundsRecorded