vtkAnnotation Class Reference
#include <vtkAnnotation.h>
Detailed Description
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.
- Thanks:
- Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories contributed code to this class.
Definition at line 46 of file vtkAnnotation.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) |
| virtual void | Initialize () |
| virtual void | ShallowCopy (vtkDataObject *other) |
| virtual void | DeepCopy (vtkDataObject *other) |
| virtual unsigned long | GetMTime () |
| virtual vtkSelection * | GetSelection () |
| virtual void | SetSelection (vtkSelection *selection) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkAnnotation * | SafeDownCast (vtkObject *o) |
| static vtkAnnotation * | New () |
| static vtkInformationStringKey * | LABEL () |
| static vtkInformationDoubleVectorKey * | COLOR () |
| static vtkInformationDoubleKey * | OPACITY () |
| static vtkInformationIntegerKey * | ICON_INDEX () |
| static vtkInformationIntegerKey * | ENABLE () |
| static vtkInformationIntegerKey * | HIDE () |
| static vtkInformationDataObjectKey * | DATA () |
| static vtkAnnotation * | GetData (vtkInformation *info) |
| static vtkAnnotation * | GetData (vtkInformationVector *v, int i=0) |
Protected Member Functions | |
| vtkAnnotation () | |
| ~vtkAnnotation () | |
Protected Attributes | |
| vtkSelection * | Selection |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkAnnotation::vtkAnnotation | ( | ) | [protected] |
| vtkAnnotation::~vtkAnnotation | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkAnnotation::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObject.
| static int vtkAnnotation::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 vtkAnnotation::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 vtkAnnotation* vtkAnnotation::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataObject.
| void vtkAnnotation::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 vtkAnnotation* vtkAnnotation::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObject.
| virtual vtkSelection* vtkAnnotation::GetSelection | ( | ) | [virtual] |
The selection to which this set of annotations will apply.
| virtual void vtkAnnotation::SetSelection | ( | vtkSelection * | selection | ) | [virtual] |
The selection to which this set of annotations will apply.
| static vtkAnnotation* vtkAnnotation::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve a vtkAnnotation stored inside an information object.
Reimplemented from vtkDataObject.
| static vtkAnnotation* vtkAnnotation::GetData | ( | vtkInformationVector * | v, | |
| int | i = 0 | |||
| ) | [static] |
Retrieve a vtkAnnotation stored inside an information object.
Reimplemented from vtkDataObject.
| static vtkInformationStringKey* vtkAnnotation::LABEL | ( | ) | [static] |
The label for this annotation.
| static vtkInformationDoubleVectorKey* vtkAnnotation::COLOR | ( | ) | [static] |
The color for this annotation. This is stored as an RGB triple with values between 0 and 1.
| static vtkInformationDoubleKey* vtkAnnotation::OPACITY | ( | ) | [static] |
The color for this annotation. This is stored as a value between 0 and 1.
| static vtkInformationIntegerKey* vtkAnnotation::ICON_INDEX | ( | ) | [static] |
An icon index for this annotation.
| static vtkInformationIntegerKey* vtkAnnotation::ENABLE | ( | ) | [static] |
Whether or not this annotation is enabled. A value of 1 means enabled, 0 disabled.
| static vtkInformationIntegerKey* vtkAnnotation::HIDE | ( | ) | [static] |
Whether or not this annotation is visible.
| static vtkInformationDataObjectKey* vtkAnnotation::DATA | ( | ) | [static] |
Associate a vtkDataObject with this annotation
| virtual void vtkAnnotation::Initialize | ( | ) | [virtual] |
Initialize the annotation to an empty state.
Reimplemented from vtkDataObject.
| virtual void vtkAnnotation::ShallowCopy | ( | vtkDataObject * | other | ) | [virtual] |
Make this annotation have the same properties and have the same selection of another annotation.
Reimplemented from vtkDataObject.
| virtual void vtkAnnotation::DeepCopy | ( | vtkDataObject * | other | ) | [virtual] |
Make this annotation have the same properties and have a copy of the selection of another annotation.
Reimplemented from vtkDataObject.
| virtual unsigned long vtkAnnotation::GetMTime | ( | ) | [virtual] |
Get the modified time of this object.
Reimplemented from vtkDataObject.
Member Data Documentation
vtkSelection* vtkAnnotation::Selection [protected] |
Definition at line 108 of file vtkAnnotation.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkAnnotation.h
