Stores a collection of annotation artifacts. More...

#include <vtkAnnotation.h>

Inheritance diagram for vtkAnnotation:

Collaboration diagram for vtkAnnotation:

Public Types
typedef vtkDataObject	Superclass
Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }
enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }
enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
Public Types inherited from vtkObject

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)
Public Member Functions inherited from vtkDataObject
virtual vtkAlgorithmOutput *	GetProducerPort ()
void	ReleaseData ()
int	ShouldIReleaseData ()
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	Update ()
virtual void	UpdateInformation ()
virtual void	PropagateUpdateExtent ()
virtual void	TriggerAsynchronousUpdate ()
virtual void	UpdateData ()
virtual unsigned long	GetEstimatedMemorySize ()
virtual int	GetDataObjectType ()
unsigned long	GetUpdateTime ()
void	SetUpdateExtentToWholeExtent ()
unsigned long	GetPipelineMTime ()
virtual unsigned long	GetActualMemorySize ()
void	CopyInformation (vtkDataObject *data)
virtual void	CopyInformationFromPipeline (vtkInformation *request)
void	DataHasBeenGenerated ()
virtual void	PrepareForNewData ()
virtual int	GetExtentType ()
virtual void	Crop ()
virtual vtkDataSetAttributes *	GetAttributes (int type)
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkIdType	GetNumberOfElements (int type)
virtual vtkSource *	GetSource ()
void	SetSource (vtkSource *s)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual vtkInformation *	GetPipelineInformation ()
virtual void	SetPipelineInformation (vtkInformation *)
virtual int	GetDataReleased ()
void	SetReleaseDataFlag (int)
int	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()
virtual void	SetFieldData (vtkFieldData *)
virtual vtkFieldData *	GetFieldData ()
virtual void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces)
virtual void	SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void	SetUpdateExtent (int extent[6])
virtual int *	GetUpdateExtent ()
virtual void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetUpdateExtent (int extent[6])
virtual void	CopyTypeSpecificInformation (vtkDataObject *data)
void	SetUpdatePiece (int piece)
void	SetUpdateNumberOfPieces (int num)
virtual int	GetUpdatePiece ()
virtual int	GetUpdateNumberOfPieces ()
void	SetUpdateGhostLevel (int level)
virtual int	GetUpdateGhostLevel ()
virtual void	SetRequestExactExtent (int flag)
virtual int	GetRequestExactExtent ()
virtual void	RequestExactExtentOn ()
virtual void	RequestExactExtentOff ()
virtual void	SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void	SetWholeExtent (int extent[6])
virtual int *	GetWholeExtent ()
virtual void	GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetWholeExtent (int extent[6])
virtual void	SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	SetWholeBoundingBox (double bb[6])
virtual double *	GetWholeBoundingBox ()
virtual void	GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
virtual void	GetWholeBoundingBox (double extent[6])
virtual void	SetMaximumNumberOfPieces (int)
virtual int	GetMaximumNumberOfPieces ()
virtual void	CopyInformationToPipeline (vtkInformation request, vtkInformation input, vtkInformation *output, int forceCopy)
void	CopyInformationToPipeline (vtkInformation request, vtkInformation input)
void	SetExtentTranslator (vtkExtentTranslator *translator)
vtkExtentTranslator *	GetExtentTranslator ()
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char event, vtkCommand )
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char event, vtkCommand )
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char event, void callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

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)
Static Public Member Functions inherited from vtkDataObject
static const char *	GetAssociationTypeAsString (int associationType)
static vtkInformationStringKey *	DATA_TYPE_NAME ()
static vtkInformationDataObjectKey *	DATA_OBJECT ()
static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()
static vtkInformationIntegerPointerKey *	DATA_EXTENT ()
static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKey *	DATA_RESOLUTION ()
static vtkInformationDoubleVectorKey *	DATA_TIME_STEPS ()
static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()
static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()
static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()
static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKey *	FIELD_OPERATION ()
static vtkInformationDoubleVectorKey *	FIELD_RANGE ()
static vtkInformationDoubleVectorKey *	PIECE_FIELD_RANGE ()
static vtkInformationStringKey *	FIELD_ARRAY_NAME ()
static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()
static vtkInformationStringKey *	FIELD_NAME ()
static vtkInformationDoubleVectorKey *	ORIGIN ()
static vtkInformationDoubleVectorKey *	SPACING ()
static vtkInformationIntegerKey *	DATA_GEOMETRY_UNMODIFIED ()
static vtkInformationDataObjectKey *	SIL ()
static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
static void	SetGlobalReleaseDataFlag (int val)
static int	GetGlobalReleaseDataFlag ()
Static Public Member Functions inherited from vtkObject
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()

Protected Member Functions
	vtkAnnotation ()
	~vtkAnnotation ()
Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()
	~vtkDataObject ()
vtkExecutive *	GetExecutive ()
int	GetPortNumber ()
virtual void	ReportReferences (vtkGarbageCollector *)
vtkStreamingDemandDrivenPipeline *	TrySDDP (const char *method)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSelection *	Selection
Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData
vtkSource *	Source
int	DataReleased
vtkTimeStamp	UpdateTime
vtkInformation *	Information
vtkInformation *	PipelineInformation
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Protected Types inherited from vtkDataObject
typedef vtkStreamingDemandDrivenPipeline	SDDP
Static Protected Attributes inherited from vtkDataObject
static const char	AssociationNames [NUMBER_OF_ASSOCIATIONS][55]

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

typedef vtkDataObject vtkAnnotation::Superclass

Reimplemented from vtkDataObject.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation