1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
/**
* @class vtkAnnotationLayers
* @brief 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.
*/
#ifndef vtkAnnotationLayers_h
#define vtkAnnotationLayers_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkAnnotation;
class vtkSelection;
class VTKCOMMONDATAMODEL_EXPORT vtkAnnotationLayers : public vtkDataObject
{
public:
vtkTypeMacro(vtkAnnotationLayers, vtkDataObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkAnnotationLayers* New();
/**
* Returns `VTK_ANNOTATION`.
*/
int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_ANNOTATION_LAYERS; }
///@{
/**
* The current annotation associated with this annotation link.
*/
virtual void SetCurrentAnnotation(vtkAnnotation* ann);
vtkGetObjectMacro(CurrentAnnotation, vtkAnnotation);
///@}
///@{
/**
* The current selection associated with this annotation link.
* This is simply the selection contained in the current annotation.
*/
virtual void SetCurrentSelection(vtkSelection* sel);
virtual vtkSelection* GetCurrentSelection();
///@}
/**
* The number of annotations in a specific layer.
*/
unsigned int GetNumberOfAnnotations();
/**
* Retrieve an annotation from a layer.
*/
vtkAnnotation* GetAnnotation(unsigned int idx);
/**
* Add an annotation to a layer.
*/
void AddAnnotation(vtkAnnotation* ann);
/**
* Remove an annotation from a layer.
*/
void RemoveAnnotation(vtkAnnotation* ann);
/**
* Initialize the data structure to an empty state.
*/
void Initialize() override;
/**
* Copy data from another data object into this one
* which references the same member annotations.
*/
void ShallowCopy(vtkDataObject* other) override;
/**
* Copy data from another data object into this one,
* performing a deep copy of member annotations.
*/
void DeepCopy(vtkDataObject* other) override;
///@{
/**
* Retrieve a vtkAnnotationLayers stored inside an information object.
*/
static vtkAnnotationLayers* GetData(vtkInformation* info);
static vtkAnnotationLayers* GetData(vtkInformationVector* v, int i = 0);
///@}
/**
* The modified time for this object.
*/
vtkMTimeType GetMTime() override;
protected:
vtkAnnotationLayers();
~vtkAnnotationLayers() override;
class Internals;
Internals* Implementation;
vtkAnnotation* CurrentAnnotation;
private:
vtkAnnotationLayers(const vtkAnnotationLayers&) = delete;
void operator=(const vtkAnnotationLayers&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|