VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAnnotation Class Reference

Stores a collection of annotation artifacts. More...

#include <vtkAnnotation.h>

Inheritance diagram for vtkAnnotation:
[legend]
Collaboration diagram for vtkAnnotation:
[legend]

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 vtkSelectionGetSelection ()
 
virtual void SetSelection (vtkSelection *selection)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAnnotationSafeDownCast (vtkObject *o)
 
static vtkAnnotationNew ()
 
static vtkInformationStringKeyLABEL ()
 
static
vtkInformationDoubleVectorKey
COLOR ()
 
static vtkInformationDoubleKeyOPACITY ()
 
static vtkInformationIntegerKeyICON_INDEX ()
 
static vtkInformationIntegerKeyENABLE ()
 
static vtkInformationIntegerKeyHIDE ()
 
static
vtkInformationDataObjectKey
DATA ()
 
static vtkAnnotationGetData (vtkInformation *info)
 
static vtkAnnotationGetData (vtkInformationVector *v, int i=0)
 

Protected Member Functions

 vtkAnnotation ()
 
 ~vtkAnnotation ()
 

Protected Attributes

vtkSelectionSelection
 

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 (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories contributed code to this class.

Definition at line 46 of file vtkAnnotation.h.

Member Typedef Documentation

Definition at line 49 of file vtkAnnotation.h.

Constructor & Destructor Documentation

vtkAnnotation::vtkAnnotation ( )
protected
vtkAnnotation::~vtkAnnotation ( )
protected

Member Function Documentation

virtual const char* vtkAnnotation::GetClassName ( )
virtual
static int vtkAnnotation::IsTypeOf ( const char *  type)
static
virtual int vtkAnnotation::IsA ( const char *  type)
virtual
static vtkAnnotation* vtkAnnotation::SafeDownCast ( vtkObject o)
static
void vtkAnnotation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkAnnotation* vtkAnnotation::New ( )
static
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.

static vtkAnnotation* vtkAnnotation::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve a vtkAnnotation stored inside an information object.

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.

virtual void vtkAnnotation::ShallowCopy ( vtkDataObject other)
virtual

Make this annotation have the same properties and have the same selection of another annotation.

virtual void vtkAnnotation::DeepCopy ( vtkDataObject other)
virtual

Make this annotation have the same properties and have a copy of the selection of another annotation.

virtual unsigned long vtkAnnotation::GetMTime ( )
virtual

Get the modified time of this object.

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: