You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
143 lines
3.7 KiB
C++
143 lines
3.7 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkAnnotation.h
|
|
|
|
-------------------------------------------------------------------------
|
|
Copyright 2008 Sandia Corporation.
|
|
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
the U.S. Government retains certain rights in this software.
|
|
-------------------------------------------------------------------------
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
|
|
/**
|
|
* @class vtkAnnotation
|
|
* @brief Stores a collection of annotation artifacts.
|
|
*
|
|
*
|
|
* vtkAnnotation is a collection of annotation properties along with
|
|
* an associated selection indicating the portion of data the annotation
|
|
* refers to.
|
|
*
|
|
* @par Thanks:
|
|
* Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories
|
|
* contributed code to this class.
|
|
*/
|
|
|
|
#ifndef vtkAnnotation_h
|
|
#define vtkAnnotation_h
|
|
|
|
#include "vtkCommonDataModelModule.h" // For export macro
|
|
#include "vtkDataObject.h"
|
|
|
|
class vtkInformationStringKey;
|
|
class vtkInformationDoubleVectorKey;
|
|
class vtkInformationIntegerVectorKey;
|
|
class vtkInformationDataObjectKey;
|
|
class vtkSelection;
|
|
|
|
class VTKCOMMONDATAMODEL_EXPORT vtkAnnotation : public vtkDataObject
|
|
{
|
|
public:
|
|
vtkTypeMacro(vtkAnnotation, vtkDataObject);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
static vtkAnnotation* New();
|
|
|
|
//@{
|
|
/**
|
|
* The selection to which this set of annotations will apply.
|
|
*/
|
|
vtkGetObjectMacro(Selection, vtkSelection);
|
|
virtual void SetSelection(vtkSelection* selection);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* Retrieve a vtkAnnotation stored inside an information object.
|
|
*/
|
|
static vtkAnnotation* GetData(vtkInformation* info);
|
|
static vtkAnnotation* GetData(vtkInformationVector* v, int i = 0);
|
|
//@}
|
|
|
|
/**
|
|
* The label for this annotation.
|
|
*/
|
|
static vtkInformationStringKey* LABEL();
|
|
|
|
/**
|
|
* The color for this annotation.
|
|
* This is stored as an RGB triple with values between 0 and 1.
|
|
*/
|
|
static vtkInformationDoubleVectorKey* COLOR();
|
|
|
|
/**
|
|
* The color for this annotation.
|
|
* This is stored as a value between 0 and 1.
|
|
*/
|
|
static vtkInformationDoubleKey* OPACITY();
|
|
|
|
/**
|
|
* An icon index for this annotation.
|
|
*/
|
|
static vtkInformationIntegerKey* ICON_INDEX();
|
|
|
|
/**
|
|
* Whether or not this annotation is enabled.
|
|
* A value of 1 means enabled, 0 disabled.
|
|
*/
|
|
static vtkInformationIntegerKey* ENABLE();
|
|
|
|
/**
|
|
* Whether or not this annotation is visible.
|
|
*/
|
|
static vtkInformationIntegerKey* HIDE();
|
|
|
|
/**
|
|
* Associate a vtkDataObject with this annotation
|
|
*/
|
|
static vtkInformationDataObjectKey* DATA();
|
|
|
|
/**
|
|
* Initialize the annotation to an empty state.
|
|
*/
|
|
void Initialize() override;
|
|
|
|
/**
|
|
* Make this annotation have the same properties and have
|
|
* the same selection of another annotation.
|
|
*/
|
|
void ShallowCopy(vtkDataObject* other) override;
|
|
|
|
/**
|
|
* Make this annotation have the same properties and have
|
|
* a copy of the selection of another annotation.
|
|
*/
|
|
void DeepCopy(vtkDataObject* other) override;
|
|
|
|
/**
|
|
* Get the modified time of this object.
|
|
*/
|
|
vtkMTimeType GetMTime() override;
|
|
|
|
protected:
|
|
vtkAnnotation();
|
|
~vtkAnnotation() override;
|
|
|
|
vtkSelection* Selection;
|
|
|
|
private:
|
|
vtkAnnotation(const vtkAnnotation&) = delete;
|
|
void operator=(const vtkAnnotation&) = delete;
|
|
};
|
|
|
|
#endif
|