VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkLabelHierarchyIterator Class Referenceabstract

iterator over vtkLabelHierarchy More...

#include <vtkLabelHierarchyIterator.h>

Inheritance diagram for vtkLabelHierarchyIterator:
[legend]
Collaboration diagram for vtkLabelHierarchyIterator:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkLabelHierarchyIteratorNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Begin (vtkIdTypeArray *)
 
virtual void Next ()
 
virtual bool IsAtEnd ()
 
virtual void GetPoint (double x[3])
 
virtual void GetSize (double sz[2])
 
virtual void GetBoundedSize (double sz[2])
 
virtual int GetType ()
 
virtual vtkStdString GetLabel ()
 
virtual vtkUnicodeString GetUnicodeLabel ()
 
virtual double GetOrientation ()
 
virtual vtkIdType GetLabelId ()
 
virtual void SetTraversedBounds (vtkPolyData *)
 
virtual void GetNodeGeometry (double ctr[3], double &size)=0
 
virtual void BoxNode ()
 
virtual void BoxAllNodes (vtkPolyData *)
 
virtual vtkLabelHierarchyGetHierarchy ()
 
virtual void SetAllBounds (int)
 
virtual int GetAllBounds ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkLabelHierarchyIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLabelHierarchyIterator ()
 
virtual ~vtkLabelHierarchyIterator ()
 
void BoxNodeInternal3 (const double *ctr, double sz)
 
void BoxNodeInternal2 (const double *ctr, double sz)
 
virtual void SetHierarchy (vtkLabelHierarchy *h)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkLabelHierarchyHierarchy
 
vtkPolyDataTraversedBounds
 
double BoundsFactor
 
int AllBounds
 
int AllBoundsRecorded
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

iterator over vtkLabelHierarchy

Abstract superclass for iterators over vtkLabelHierarchy.

Definition at line 39 of file vtkLabelHierarchyIterator.h.

Member Typedef Documentation

Definition at line 42 of file vtkLabelHierarchyIterator.h.

Constructor & Destructor Documentation

vtkLabelHierarchyIterator::vtkLabelHierarchyIterator ( )
protected
virtual vtkLabelHierarchyIterator::~vtkLabelHierarchyIterator ( )
protectedvirtual

Member Function Documentation

static int vtkLabelHierarchyIterator::IsTypeOf ( const char *  type)
static
virtual int 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 vtkObject.

Reimplemented in vtkLabelHierarchyCompositeIterator.

static vtkLabelHierarchyIterator* vtkLabelHierarchyIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkLabelHierarchyIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkLabelHierarchyCompositeIterator.

vtkLabelHierarchyIterator* vtkLabelHierarchyIterator::NewInstance ( ) const
virtual void vtkLabelHierarchyIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

Reimplemented in vtkLabelHierarchyCompositeIterator.

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 49 of file vtkLabelHierarchyIterator.h.

virtual void vtkLabelHierarchyIterator::Next ( )
inlinevirtual

Advance the iterator.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 52 of file vtkLabelHierarchyIterator.h.

virtual bool vtkLabelHierarchyIterator::IsAtEnd ( )
inlinevirtual

Returns true if the iterator is at the end.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 55 of file vtkLabelHierarchyIterator.h.

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

Retrieves the current label location.

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

Retrieves the current label size.

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

Retrieves the current label maximum width in world coordinates.

virtual int vtkLabelHierarchyIterator::GetType ( )
virtual

Retrieves the current label type.

virtual vtkStdString vtkLabelHierarchyIterator::GetLabel ( )
virtual

Retrieves the current label string.

virtual vtkUnicodeString vtkLabelHierarchyIterator::GetUnicodeLabel ( )
virtual

Retrieves the current label as a unicode string.

virtual double vtkLabelHierarchyIterator::GetOrientation ( )
virtual

Retrieves the current label orientation.

virtual vtkIdType vtkLabelHierarchyIterator::GetLabelId ( )
inlinevirtual

Retrieves the current label id.

Reimplemented in vtkLabelHierarchyCompositeIterator.

Definition at line 79 of file vtkLabelHierarchyIterator.h.

virtual vtkLabelHierarchy* vtkLabelHierarchyIterator::GetHierarchy ( )
virtual

Get the label hierarchy associated with the current label.

Reimplemented in vtkLabelHierarchyCompositeIterator.

virtual void vtkLabelHierarchyIterator::SetTraversedBounds ( vtkPolyData )
virtual

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

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.

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.

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.

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.

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.

void vtkLabelHierarchyIterator::BoxNodeInternal3 ( const double ctr,
double  sz 
)
protected
void vtkLabelHierarchyIterator::BoxNodeInternal2 ( const double ctr,
double  sz 
)
protected
virtual void vtkLabelHierarchyIterator::SetHierarchy ( vtkLabelHierarchy h)
protectedvirtual

The hierarchy being traversed by this iterator.

Member Data Documentation

vtkLabelHierarchy* vtkLabelHierarchyIterator::Hierarchy
protected

Definition at line 124 of file vtkLabelHierarchyIterator.h.

vtkPolyData* vtkLabelHierarchyIterator::TraversedBounds
protected

Definition at line 125 of file vtkLabelHierarchyIterator.h.

double vtkLabelHierarchyIterator::BoundsFactor
protected

Definition at line 126 of file vtkLabelHierarchyIterator.h.

int vtkLabelHierarchyIterator::AllBounds
protected

Definition at line 127 of file vtkLabelHierarchyIterator.h.

int vtkLabelHierarchyIterator::AllBoundsRecorded
protected

Definition at line 128 of file vtkLabelHierarchyIterator.h.


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