VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Member Functions

virtual int IsA (const char *type)
 
vtkAnnotationLayers * NewInstance () const
 
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
vtkDataObject * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
void ReleaseData ()
 
virtual int GetDataObjectType ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAnnotationLayers * SafeDownCast (vtkObjectBase *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 (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *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 vtkInformationDoubleKey * DATA_TIME_STEP ()
 
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
vtkInformationDoubleVectorKey * 		BOUNDING_BOX ()
 
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 ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAnnotationLayers ()
 
 ~vtkAnnotationLayers ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 

Protected Attributes

Internals * Implementation
 
vtkAnnotation * CurrentAnnotation
 
- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 

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 41 of file vtkAnnotationLayers.h.

Member Typedef Documentation

typedef vtkDataObject vtkAnnotationLayers::Superclass

Definition at line 44 of file vtkAnnotationLayers.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static int vtkAnnotationLayers::IsTypeOf ( const char *  type)
static
virtual int vtkAnnotationLayers::IsA ( const char *  type)
virtual

Reimplemented from vtkDataObject.

static vtkAnnotationLayers* vtkAnnotationLayers::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAnnotationLayers::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

vtkAnnotationLayers* vtkAnnotationLayers::NewInstance ( ) const
void vtkAnnotationLayers::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

Member Data Documentation

Internals* vtkAnnotationLayers::Implementation
protected

Definition at line 98 of file vtkAnnotationLayers.h.

vtkAnnotation* vtkAnnotationLayers::CurrentAnnotation
protected

Definition at line 100 of file vtkAnnotationLayers.h.

The documentation for this class was generated from the following file:
Generated on Sat Apr 12 2014 01:08:00 for VTK by   doxygen 1.8.6