VTK  9.1.0
vtkAnnotationLayers.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkAnnotationLayers.h
5
6-------------------------------------------------------------------------
7 Copyright 2008 Sandia Corporation.
8 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 the U.S. Government retains certain rights in this software.
10-------------------------------------------------------------------------
11
12 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13 All rights reserved.
14 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15
16 This software is distributed WITHOUT ANY WARRANTY; without even
17 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18 PURPOSE. See the above copyright notice for more information.
19
20=========================================================================*/
21
33#ifndef vtkAnnotationLayers_h
34#define vtkAnnotationLayers_h
35
36#include "vtkCommonDataModelModule.h" // For export macro
37#include "vtkDataObject.h"
38
39class vtkAnnotation;
40class vtkSelection;
41
42class VTKCOMMONDATAMODEL_EXPORT vtkAnnotationLayers : public vtkDataObject
43{
44public:
46 void PrintSelf(ostream& os, vtkIndent indent) override;
48
52 int GetDataObjectType() override { return VTK_ANNOTATION_LAYERS; }
53
55
59 vtkGetObjectMacro(CurrentAnnotation, vtkAnnotation);
61
63
70
74 unsigned int GetNumberOfAnnotations();
75
79 vtkAnnotation* GetAnnotation(unsigned int idx);
80
85
90
94 void Initialize() override;
95
100 void ShallowCopy(vtkDataObject* other) override;
101
106 void DeepCopy(vtkDataObject* other) override;
107
109
115
120
121protected:
124
125 class Internals;
126 Internals* Implementation;
128
129private:
131 void operator=(const vtkAnnotationLayers&) = delete;
132};
133
134#endif
Stores a ordered collection of annotation sets.
vtkAnnotation * CurrentAnnotation
vtkAnnotation * GetAnnotation(unsigned int idx)
Retrieve an annotation from a layer.
void Initialize() override
Initialize the data structure to an empty state.
void ShallowCopy(vtkDataObject *other) override
Copy data from another data object into this one which references the same member annotations.
virtual void SetCurrentAnnotation(vtkAnnotation *ann)
The current annotation associated with this annotation link.
static vtkAnnotationLayers * GetData(vtkInformationVector *v, int i=0)
Retrieve a vtkAnnotationLayers stored inside an information object.
void DeepCopy(vtkDataObject *other) override
Copy data from another data object into this one, performing a deep copy of member annotations.
static vtkAnnotationLayers * GetData(vtkInformation *info)
Retrieve a vtkAnnotationLayers stored inside an information object.
unsigned int GetNumberOfAnnotations()
The number of annotations in a specific layer.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkAnnotationLayers * New()
int GetDataObjectType() override
Returns VTK_ANNOTATION.
~vtkAnnotationLayers() override
void AddAnnotation(vtkAnnotation *ann)
Add an annotation to a layer.
vtkMTimeType GetMTime() override
The modified time for this object.
virtual vtkSelection * GetCurrentSelection()
The current selection associated with this annotation link.
void RemoveAnnotation(vtkAnnotation *ann)
Remove an annotation from a layer.
virtual void SetCurrentSelection(vtkSelection *sel)
The current selection associated with this annotation link.
Stores a collection of annotation artifacts.
Definition: vtkAnnotation.h:49
general representation of visualization data
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:163
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
#define VTK_ANNOTATION_LAYERS
Definition: vtkType.h:122