vtkAnnotationLayers Class Reference

#include <vtkAnnotationLayers.h>

Inheritance diagram for vtkAnnotationLayers:

Inheritance graph
[legend]
Collaboration diagram for vtkAnnotationLayers:

Collaboration graph
[legend]

List of all members.


Detailed Description

Stores a ordered collection of annotation sets.

vtkAnnotationLayers stores a vector of annotation layers. Each layer may contain any number of vtkAnnotation objects. The ordering of the layers introduces a prioritization of annotations. Annotations in higher layers may obscure annotations in lower layers.

Definition at line 40 of file vtkAnnotationLayers.h.


Public Types

typedef vtkDataObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned int GetNumberOfAnnotations ()
vtkAnnotationGetAnnotation (unsigned int idx)
void AddAnnotation (vtkAnnotation *ann)
void RemoveAnnotation (vtkAnnotation *ann)
virtual void Initialize ()
virtual void ShallowCopy (vtkDataObject *other)
virtual void DeepCopy (vtkDataObject *other)
virtual unsigned long GetMTime ()
virtual void SetCurrentAnnotation (vtkAnnotation *ann)
virtual vtkAnnotationGetCurrentAnnotation ()
virtual void SetCurrentSelection (vtkSelection *sel)
virtual vtkSelectionGetCurrentSelection ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkAnnotationLayersSafeDownCast (vtkObject *o)
static vtkAnnotationLayersNew ()
static vtkAnnotationLayersGetData (vtkInformation *info)
static vtkAnnotationLayersGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

 vtkAnnotationLayers ()
 ~vtkAnnotationLayers ()

Protected Attributes

Internals * Implementation
vtkAnnotationCurrentAnnotation

Member Typedef Documentation

Reimplemented from vtkDataObject.

Definition at line 43 of file vtkAnnotationLayers.h.


Constructor & Destructor Documentation

vtkAnnotationLayers::vtkAnnotationLayers (  )  [protected]

vtkAnnotationLayers::~vtkAnnotationLayers (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkDataObject.

static int vtkAnnotationLayers::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 vtkDataObject.

virtual int vtkAnnotationLayers::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 vtkDataObject.

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

Reimplemented from vtkDataObject.

void vtkAnnotationLayers::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 vtkDataObject.

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

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

Reimplemented from vtkDataObject.

virtual void vtkAnnotationLayers::SetCurrentAnnotation ( vtkAnnotation ann  )  [virtual]

The current annotation associated with this annotation link.

virtual vtkAnnotation* vtkAnnotationLayers::GetCurrentAnnotation (  )  [virtual]

The current annotation associated with this annotation link.

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

The current selection associated with this annotation link. This is simply the selection contained in the current annotation.

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

The current selection associated with this annotation link. This is simply the selection contained in the current annotation.

unsigned int vtkAnnotationLayers::GetNumberOfAnnotations (  ) 

The number of annotations in a specific layer.

vtkAnnotation* vtkAnnotationLayers::GetAnnotation ( unsigned int  idx  ) 

Retrieve an annotation from a layer.

void vtkAnnotationLayers::AddAnnotation ( vtkAnnotation ann  ) 

Add an annotation to a layer.

void vtkAnnotationLayers::RemoveAnnotation ( vtkAnnotation ann  ) 

Remove an annotation from a layer.

virtual void vtkAnnotationLayers::Initialize (  )  [virtual]

Initialize the data structure to an empty state.

Reimplemented from vtkDataObject.

virtual void vtkAnnotationLayers::ShallowCopy ( vtkDataObject other  )  [virtual]

Copy data from another data object into this one which references the same member annotations.

Reimplemented from vtkDataObject.

virtual void vtkAnnotationLayers::DeepCopy ( vtkDataObject other  )  [virtual]

Copy data from another data object into this one, performing a deep copy of member annotations.

Reimplemented from vtkDataObject.

static vtkAnnotationLayers* vtkAnnotationLayers::GetData ( vtkInformation info  )  [static]

Retrieve a vtkAnnotationLayers stored inside an information object.

Reimplemented from vtkDataObject.

static vtkAnnotationLayers* vtkAnnotationLayers::GetData ( vtkInformationVector v,
int  i = 0 
) [static]

Retrieve a vtkAnnotationLayers stored inside an information object.

Reimplemented from vtkDataObject.

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

The modified time for this object.

Reimplemented from vtkDataObject.


Member Data Documentation

Internals* vtkAnnotationLayers::Implementation [protected]

Definition at line 97 of file vtkAnnotationLayers.h.

Definition at line 99 of file vtkAnnotationLayers.h.


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

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