vtkAnnotationLink Class Reference

#include <vtkAnnotationLink.h>

Inheritance diagram for vtkAnnotationLink:

Inheritance graph
Collaboration diagram for vtkAnnotationLink:

Collaboration graph

List of all members.

Detailed Description

An algorithm for linking annotations among objects.

vtkAnnotationLink is a simple source filter which outputs the vtkAnnotationLayers object stored internally. Multiple objects may share the same annotation link filter and connect it to an internal pipeline so that if one object changes the annotation set, it will be pulled into all the other objects when their pipelines update.

The shared vtkAnnotationLayers object (a collection of annotations) is shallow copied to output port 0.

vtkAnnotationLink can also store a set of domain maps. A domain map is simply a table associating values between domains. The domain of each column is defined by the array name of the column. The domain maps are sent to a multi-block dataset in output port 1.

Output ports 0 and 1 can be set as input ports 0 and 1 to vtkConvertSelectionDomain, which can use the domain maps to convert the domains of selections in the vtkAnnotationLayers to match a particular data object (set as port 2 on vtkConvertSelectionDomain).

The shared vtkAnnotationLayers object also stores a "current selection" normally interpreted as the interactive selection of an application. As a convenience, this selection is sent to output port 2 so that it can be connected to pipelines requiring a vtkSelection.

vtkAnnotationLink (Examples)
vtkAnnotationLink (Tests)

Definition at line 64 of file vtkAnnotationLink.h.

Public Types


Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned long GetMTime ()
virtual vtkAnnotationLayersGetAnnotationLayers ()
virtual void SetAnnotationLayers (vtkAnnotationLayers *layers)
virtual void SetCurrentSelection (vtkSelection *sel)
virtual vtkSelectionGetCurrentSelection ()
void AddDomainMap (vtkTable *map)
void RemoveDomainMap (vtkTable *map)
void RemoveAllDomainMaps ()
int GetNumberOfDomainMaps ()
vtkTableGetDomainMap (int i)

Static Public Member Functions

static vtkAnnotationLinkNew ()
static int IsTypeOf (const char *type)
static vtkAnnotationLinkSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAnnotationLink ()
 ~vtkAnnotationLink ()
virtual int FillInputPortInformation (int, vtkInformation *)
virtual int FillOutputPortInformation (int, vtkInformation *)
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
void ShallowCopyToOutput (vtkAnnotationLayers *input, vtkAnnotationLayers *output, vtkSelection *sel)
virtual int RequestData (vtkInformation *info, vtkInformationVector **inVector, vtkInformationVector *outVector)

Protected Attributes



class Command

Member Typedef Documentation

Reimplemented from vtkAnnotationLayersAlgorithm.

Definition at line 68 of file vtkAnnotationLink.h.

Constructor & Destructor Documentation

vtkAnnotationLink::vtkAnnotationLink (  )  [protected]

vtkAnnotationLink::~vtkAnnotationLink (  )  [protected]

Member Function Documentation

static vtkAnnotationLink* vtkAnnotationLink::New (  )  [static]

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

Reimplemented from vtkAnnotationLayersAlgorithm.

virtual const char* vtkAnnotationLink::GetClassName (  )  [virtual]

Reimplemented from vtkAnnotationLayersAlgorithm.

static int vtkAnnotationLink::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 vtkAnnotationLayersAlgorithm.

virtual int vtkAnnotationLink::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 vtkAnnotationLayersAlgorithm.

static vtkAnnotationLink* vtkAnnotationLink::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkAnnotationLayersAlgorithm.

void vtkAnnotationLink::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 vtkAnnotationLayersAlgorithm.

virtual vtkAnnotationLayers* vtkAnnotationLink::GetAnnotationLayers (  )  [virtual]

The annotations to be shared.

virtual void vtkAnnotationLink::SetAnnotationLayers ( vtkAnnotationLayers layers  )  [virtual]

The annotations to be shared.

virtual void vtkAnnotationLink::SetCurrentSelection ( vtkSelection sel  )  [virtual]

Set or get the current selection in the annotation layers.

virtual vtkSelection* vtkAnnotationLink::GetCurrentSelection (  )  [virtual]

Set or get the current selection in the annotation layers.

void vtkAnnotationLink::AddDomainMap ( vtkTable map  ) 

The domain mappings.

void vtkAnnotationLink::RemoveDomainMap ( vtkTable map  ) 

The domain mappings.

void vtkAnnotationLink::RemoveAllDomainMaps (  ) 

The domain mappings.

int vtkAnnotationLink::GetNumberOfDomainMaps (  ) 

The domain mappings.

vtkTable* vtkAnnotationLink::GetDomainMap ( int  i  ) 

The domain mappings.

virtual unsigned long vtkAnnotationLink::GetMTime (  )  [virtual]

Get the mtime of this object.

Reimplemented from vtkObject.

virtual void vtkAnnotationLink::ProcessEvents ( vtkObject caller,
unsigned long  eventId,
void *  callData 
) [protected, virtual]

Called to process modified events from its vtkAnnotationLayers.

virtual int vtkAnnotationLink::FillInputPortInformation ( int  ,
) [protected, virtual]

Set up input ports.

Reimplemented from vtkAnnotationLayersAlgorithm.

virtual int vtkAnnotationLink::FillOutputPortInformation ( int  ,
) [protected, virtual]

Set up output ports.

Reimplemented from vtkAnnotationLayersAlgorithm.

void vtkAnnotationLink::ShallowCopyToOutput ( vtkAnnotationLayers input,
vtkAnnotationLayers output,
vtkSelection sel 
) [protected]

Copy the data to the output objects.

virtual int vtkAnnotationLink::RequestData ( vtkInformation info,
vtkInformationVector **  inVector,
vtkInformationVector outVector 
) [protected, virtual]

Shallow copy the internal selection to the output.

Reimplemented from vtkAnnotationLayersAlgorithm.

Friends And Related Function Documentation

friend class Command [friend]

Definition at line 139 of file vtkAnnotationLink.h.

Member Data Documentation

The shared selection.

Definition at line 128 of file vtkAnnotationLink.h.

The mappings between domains.

Definition at line 131 of file vtkAnnotationLink.h.

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

Generated on Wed Aug 24 11:28:41 2011 for VTK by  doxygen 1.5.6