VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkGraphAnnotationLayersFilter Class Reference

Produce filled convex hulls around subsets of vertices in a vtkGraph. More...

#include <vtkGraphAnnotationLayersFilter.h>

Inheritance diagram for vtkGraphAnnotationLayersFilter:
Inheritance graph
[legend]
Collaboration diagram for vtkGraphAnnotationLayersFilter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetScaleFactor (double scale)
void SetHullShapeToBoundingRectangle ()
void SetHullShapeToConvexHull ()
void SetMinHullSizeInWorld (double size)
void SetMinHullSizeInDisplay (int size)
void SetRenderer (vtkRenderer *renderer)
virtual unsigned long GetMTime ()
void OutlineOn ()
void OutlineOff ()
void SetOutline (bool b)
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObject * GetInput ()
vtkDataObject * GetInput (int port)
vtkPolyData * GetPolyDataInput (int port)
vtkPolyData * GetOutput ()
vtkPolyData * GetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInputData (vtkDataObject *)
void SetInputData (int, vtkDataObject *)
void AddInputData (vtkDataObject *)
void AddInputData (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutive * GetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformation * GetInputPortInformation (int port)
vtkInformation * GetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformation * GetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObject * GetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, int idx)
virtual void RemoveAllInputConnections (int port)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput * GetInputConnection (int port, int index)
vtkAlgorithm * GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm * GetInputAlgorithm (int port, int index)
vtkExecutive * GetInputExecutive (int port, int index)
vtkInformation * GetInputInformation (int port, int index)
vtkInformation * GetOutputInformation (int port)
virtual void UpdateInformation ()
virtual void PropagateUpdateExtent ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int SetUpdateExtentToWholeExtent (int port)
int SetUpdateExtentToWholeExtent ()
void SetUpdateExtent (int port, int extent[6])
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation * GetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject * GetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutput * GetOutputPort (int index)
vtkAlgorithmOutput * GetOutputPort ()
vtkAlgorithm * GetInputAlgorithm ()
vtkExecutive * GetInputExecutive ()
vtkInformation * GetInputInformation ()
virtual void Update (int port)
virtual void Update ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int extent[6])
int * GetUpdateExtent ()
int * GetUpdateExtent (int port)
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void GetUpdateExtent (int extent[6])
void GetUpdateExtent (int port, int extent[6])
int GetUpdatePiece ()
int GetUpdatePiece (int port)
int GetUpdateNumberOfPieces ()
int GetUpdateNumberOfPieces (int port)
int GetUpdateGhostLevel ()
int GetUpdateGhostLevel (int port)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand * GetCommand (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)
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
vtkGraphAnnotationLayersFilter * 		New ()
static int IsTypeOf (const char *type)
static
vtkGraphAnnotationLayersFilter * 		SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGraphAnnotationLayersFilter ()
 ~vtkGraphAnnotationLayersFilter ()
int FillInputPortInformation (int port, vtkInformation *info)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive * CreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void SetInputDataInternal (int port, vtkDataObject *input)
void AddInputDataInternal (int port, vtkDataObject *input)
virtual void SetErrorCode (unsigned long)
- 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 &)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Detailed Description

Produce filled convex hulls around subsets of vertices in a vtkGraph.

Produces a vtkPolyData comprised of filled polygons of the convex hull of a cluster. Alternatively, you may choose to output bounding rectangles. Clusters with fewer than three vertices are artificially expanded to ensure visibility (see vtkConvexHull2D).

The first input is a vtkGraph with points, possibly set by passing the graph through vtkGraphLayout (z-values are ignored). The second input is a vtkAnnotationsLayer containing vtkSelectionNodeS of vertex ids (the 'clusters' output of vtkTulipReader for example).

Setting OutlineOn() additionally produces outlines of the clusters on output port 1.

Three arrays are added to the cells of the output: "Hull id"; "Hull name"; and "Hull color".

Note: This filter operates in the x,y-plane and as such works best with an interactor style that does not allow camera rotation, such as vtkInteractorStyleRubberBand2D.

See also:
vtkContext2D
Thanks:
Thanks to Colin Myers, University of Leeds for providing this implementation.
Tests:
vtkGraphAnnotationLayersFilter (Tests)

Definition at line 63 of file vtkGraphAnnotationLayersFilter.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkGraphAnnotationLayersFilter::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 67 of file vtkGraphAnnotationLayersFilter.h.

Constructor & Destructor Documentation

vtkGraphAnnotationLayersFilter::vtkGraphAnnotationLayersFilter ( )
protected
vtkGraphAnnotationLayersFilter::~vtkGraphAnnotationLayersFilter ( )
protected

Member Function Documentation

static vtkGraphAnnotationLayersFilter* vtkGraphAnnotationLayersFilter::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkGraphAnnotationLayersFilter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGraphAnnotationLayersFilter::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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 vtkPolyDataAlgorithm.

virtual int vtkGraphAnnotationLayersFilter::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 vtkPolyDataAlgorithm.

static vtkGraphAnnotationLayersFilter* vtkGraphAnnotationLayersFilter::SafeDownCast ( vtkObject *  o)
static

Reimplemented from vtkPolyDataAlgorithm.

void vtkGraphAnnotationLayersFilter::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 vtkPolyDataAlgorithm.

void vtkGraphAnnotationLayersFilter::OutlineOn ( )

Produce outlines of the hulls on output port 1.

void vtkGraphAnnotationLayersFilter::OutlineOff ( )

Produce outlines of the hulls on output port 1.

void vtkGraphAnnotationLayersFilter::SetOutline ( bool  b)

Produce outlines of the hulls on output port 1.

void vtkGraphAnnotationLayersFilter::SetScaleFactor ( double  scale)

Scale each hull by the amount specified. Defaults to 1.0.

void vtkGraphAnnotationLayersFilter::SetHullShapeToBoundingRectangle ( )

Set the shape of the hulls to bounding rectangle.

void vtkGraphAnnotationLayersFilter::SetHullShapeToConvexHull ( )

Set the shape of the hulls to convex hull. Default.

void vtkGraphAnnotationLayersFilter::SetMinHullSizeInWorld ( double  size)

Set the minimum x,y-dimensions of each hull in world coordinates. Defaults to 1.0. Set to 0.0 to disable.

void vtkGraphAnnotationLayersFilter::SetMinHullSizeInDisplay ( int  size)

Set the minimum x,y-dimensions of each hull in pixels. You must also set a vtkRenderer. Defaults to 1. Set to 0 to disable.

void vtkGraphAnnotationLayersFilter::SetRenderer ( vtkRenderer *  renderer)

Renderer needed for MinHullSizeInDisplay calculation. Not reference counted.

virtual unsigned long vtkGraphAnnotationLayersFilter::GetMTime ( )
virtual

The modified time of this filter.

Reimplemented from vtkObject.

int vtkGraphAnnotationLayersFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkGraphAnnotationLayersFilter::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Set the input to vtkGraph and vtkAnnotationLayers.

Reimplemented from vtkPolyDataAlgorithm.

The documentation for this class was generated from the following file:
Generated on Wed May 23 2012 22:22:25 for VTK by   doxygen 1.8.1