VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkAnnotation Class Reference

Stores a collection of annotation artifacts. More...

#include <vtkAnnotation.h>

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

List of all members.

Public Types

typedef vtkDataObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkAnnotationNewInstance () const
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 (vtkObjectBase *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

virtual vtkObjectBaseNewInstanceInternal () const
 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 47 of file vtkAnnotation.h.


Member Typedef Documentation

Reimplemented from vtkDataObject.

Definition at line 50 of file vtkAnnotation.h.


Constructor & Destructor Documentation


Member Function Documentation

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.

Reimplemented from vtkDataObject.

virtual vtkObjectBase* vtkAnnotation::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataObject.

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.

The label for this annotation.

The color for this annotation. This is stored as an RGB triple with values between 0 and 1.

The color for this annotation. This is stored as a value between 0 and 1.

An icon index for this annotation.

Whether or not this annotation is enabled. A value of 1 means enabled, 0 disabled.

Whether or not this annotation is visible.

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

Definition at line 109 of file vtkAnnotation.h.


The documentation for this class was generated from the following file: