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

Stores a ordered collection of annotation sets. More...

#include <vtkAnnotationLayers.h>

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

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
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
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned int GetNumberOfAnnotations ()
 
vtkAnnotation * GetAnnotation (unsigned int idx)
 
void AddAnnotation (vtkAnnotation *ann)
 
void RemoveAnnotation (vtkAnnotation *ann)
 
virtual void Initialize ()
 
virtual void ShallowCopy (vtkDataObject *other)
 
virtual void DeepCopy (vtkDataObject *other)
 
virtual unsigned long GetMTime ()
 
virtual void SetCurrentAnnotation (vtkAnnotation *ann)
 
virtual vtkAnnotation * GetCurrentAnnotation ()
 
virtual void SetCurrentSelection (vtkSelection *sel)
 
virtual vtkSelection * GetCurrentSelection ()
 
- Public Member Functions inherited from vtkDataObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkAlgorithmOutput * GetProducerPort ()
 
unsigned long int GetMTime ()
 
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 vtkAnnotationLayers * SafeDownCast (vtkObject *o)
 
static vtkAnnotationLayers * New ()
 
static vtkAnnotationLayers * GetData (vtkInformation *info)
 
static vtkAnnotationLayers * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (vtkObject *o)
 
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 vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObject *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

 vtkAnnotationLayers ()
 
 ~vtkAnnotationLayers ()
 
- 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

Internals * Implementation
 
vtkAnnotation * CurrentAnnotation
 
- 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 ordered collection of annotation sets.

vtkAnnotationLayers stores a vector of annotation layers. Each layer may contain any number of vtkAnnotation objects. The ordering of the layers introduces a prioritization of annotations. Annotations in higher layers may obscure annotations in lower layers.

Definition at line 40 of file vtkAnnotationLayers.h.

Member Typedef Documentation

typedef vtkDataObject vtkAnnotationLayers::Superclass

Definition at line 43 of file vtkAnnotationLayers.h.

Constructor & Destructor Documentation

vtkAnnotationLayers::vtkAnnotationLayers ( )
protected
vtkAnnotationLayers::~vtkAnnotationLayers ( )
protected

Member Function Documentation

virtual const char* vtkAnnotationLayers::GetClassName ( )
virtual

Reimplemented from vtkDataObject.

static int vtkAnnotationLayers::IsTypeOf ( const char *  type)
static
virtual int vtkAnnotationLayers::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 vtkAnnotationLayers* vtkAnnotationLayers::SafeDownCast ( vtkObject *  o)
static
void vtkAnnotationLayers::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 vtkObject.

static vtkAnnotationLayers* vtkAnnotationLayers::New ( )
static
virtual void vtkAnnotationLayers::SetCurrentAnnotation ( vtkAnnotation *  ann)
virtual

The current annotation associated with this annotation link.

virtual vtkAnnotation* vtkAnnotationLayers::GetCurrentAnnotation ( )
virtual

The current annotation associated with this annotation link.

virtual void vtkAnnotationLayers::SetCurrentSelection ( vtkSelection *  sel)
virtual

The current selection associated with this annotation link. This is simply the selection contained in the current annotation.

virtual vtkSelection* vtkAnnotationLayers::GetCurrentSelection ( )
virtual

The current selection associated with this annotation link. This is simply the selection contained in the current annotation.

unsigned int vtkAnnotationLayers::GetNumberOfAnnotations ( )

The number of annotations in a specific layer.

vtkAnnotation* vtkAnnotationLayers::GetAnnotation ( unsigned int  idx)

Retrieve an annotation from a layer.

void vtkAnnotationLayers::AddAnnotation ( vtkAnnotation *  ann)

Add an annotation to a layer.

void vtkAnnotationLayers::RemoveAnnotation ( vtkAnnotation *  ann)

Remove an annotation from a layer.

virtual void vtkAnnotationLayers::Initialize ( )
virtual

Initialize the data structure to an empty state.

Reimplemented from vtkDataObject.

virtual void vtkAnnotationLayers::ShallowCopy ( vtkDataObject *  other)
virtual

Copy data from another data object into this one which references the same member annotations.

Reimplemented from vtkDataObject.

virtual void vtkAnnotationLayers::DeepCopy ( vtkDataObject *  other)
virtual

Copy data from another data object into this one, performing a deep copy of member annotations.

Reimplemented from vtkDataObject.

static vtkAnnotationLayers* vtkAnnotationLayers::GetData ( vtkInformation *  info)
static

Retrieve a vtkAnnotationLayers stored inside an information object.

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

Retrieve a vtkAnnotationLayers stored inside an information object.

virtual unsigned long vtkAnnotationLayers::GetMTime ( )
virtual

The modified time for this object.

Reimplemented from vtkObject.

Member Data Documentation

Internals* vtkAnnotationLayers::Implementation
protected

Definition at line 97 of file vtkAnnotationLayers.h.

vtkAnnotation* vtkAnnotationLayers::CurrentAnnotation
protected

Definition at line 99 of file vtkAnnotationLayers.h.

The documentation for this class was generated from the following file:
Generated on Sat Mar 22 2014 20:44:16 for VTK by   doxygen 1.8.6