VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkAnnotationLink Class Reference

An algorithm for linking annotations among objects. More...

#include <vtkAnnotationLink.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkAnnotationLinkNewInstance () const
 
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)
 
- Public Member Functions inherited from vtkAnnotationLayersAlgorithm
vtkAnnotationLayersAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkAnnotationLayersGetOutput ()
 
vtkAnnotationLayersGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (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)
 
vtkDataObjectGetInputDataObject (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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
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)
 

Static Public Member Functions

static vtkAnnotationLinkNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAnnotationLinkSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAnnotationLayersAlgorithm
static
vtkAnnotationLayersAlgorithm
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkAnnotationLayersAlgorithm
SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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 Member Functions inherited from vtkAnnotationLayersAlgorithm
 vtkAnnotationLayersAlgorithm ()
 
 ~vtkAnnotationLayersAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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 Attributes

vtkAnnotationLayersAnnotationLayers
 
vtkDataObjectCollectionDomainMaps
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Friends

class Command
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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.

Events:
vtkCommand::AnnotationChangedEvent
Examples:
vtkAnnotationLink (Examples)
Tests:
vtkAnnotationLink (Tests)

Definition at line 65 of file vtkAnnotationLink.h.

Member Typedef Documentation

Definition at line 69 of file vtkAnnotationLink.h.

Constructor & Destructor Documentation

vtkAnnotationLink::vtkAnnotationLink ( )
protected
vtkAnnotationLink::~vtkAnnotationLink ( )
protected

Member Function Documentation

static vtkAnnotationLink* vtkAnnotationLink::New ( )
static
static int vtkAnnotationLink::IsTypeOf ( const char *  type)
static
virtual int vtkAnnotationLink::IsA ( const char *  type)
virtual

Reimplemented from vtkAnnotationLayersAlgorithm.

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

Reimplemented from vtkAnnotationLayersAlgorithm.

vtkAnnotationLink* vtkAnnotationLink::NewInstance ( ) const
void vtkAnnotationLink::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

virtual void vtkAnnotationLink::ProcessEvents ( vtkObject *  caller,
unsigned long  eventId,
void *  callData 
)
protectedvirtual

Called to process modified events from its vtkAnnotationLayers.

virtual int vtkAnnotationLink::FillInputPortInformation ( int  ,
vtkInformation *   
)
protectedvirtual

Set up input ports.

Reimplemented from vtkAnnotationLayersAlgorithm.

virtual int vtkAnnotationLink::FillOutputPortInformation ( int  ,
vtkInformation *   
)
protectedvirtual

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

Shallow copy the internal selection to the output.

Reimplemented from vtkAnnotationLayersAlgorithm.

Friends And Related Function Documentation

friend class Command
friend

Definition at line 140 of file vtkAnnotationLink.h.

Member Data Documentation

vtkAnnotationLayers* vtkAnnotationLink::AnnotationLayers
protected

The shared selection.

Definition at line 129 of file vtkAnnotationLink.h.

vtkDataObjectCollection* vtkAnnotationLink::DomainMaps
protected

The mappings between domains.

Definition at line 132 of file vtkAnnotationLink.h.


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