VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkLabelHierarchy Class Reference

contains an octree of labels More...

#include <vtkLabelHierarchy.h>

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

Classes

class  Implementation
 

Public Types

enum  IteratorType { FULL_SORT, QUEUE, DEPTH_FIRST, FRUSTUM }
 Enumeration of iterator types. More...
 
typedef vtkPointSet Superclass
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 Standard methdos for type information and printing. More...
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }
 
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
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkLabelHierarchyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetPoints (vtkPoints *) override
 Override SetPoints so we can reset the hierarchy when the points change. More...
 
virtual void ComputeHierarchy ()
 Fill the hierarchy with the input labels. More...
 
virtual void SetTargetLabelCount (int)
 The number of labels that is ideally present at any octree node. More...
 
virtual int GetTargetLabelCount ()
 
virtual void SetMaximumDepth (int)
 The maximum depth of the octree. More...
 
virtual int GetMaximumDepth ()
 
virtual void SetTextProperty (vtkTextProperty *tprop)
 The default text property assigned to labels in this hierarchy. More...
 
virtual vtkTextPropertyGetTextProperty ()
 
virtual void SetPriorities (vtkDataArray *arr)
 Set/get the array specifying the importance (priority) of each label. More...
 
virtual vtkDataArrayGetPriorities ()
 
virtual void SetLabels (vtkAbstractArray *arr)
 Set/get the array specifying the text of each label. More...
 
virtual vtkAbstractArrayGetLabels ()
 
virtual void SetOrientations (vtkDataArray *arr)
 Set/get the array specifying the orientation of each label. More...
 
virtual vtkDataArrayGetOrientations ()
 
virtual void SetIconIndices (vtkIntArray *arr)
 Set/get the array specifying the icon index of each label. More...
 
virtual vtkIntArrayGetIconIndices ()
 
virtual void SetSizes (vtkDataArray *arr)
 Set/get the array specifying the size of each label. More...
 
virtual vtkDataArrayGetSizes ()
 
virtual void SetBoundedSizes (vtkDataArray *arr)
 Set/get the array specifying the maximum width and height in world coordinates of each label. More...
 
virtual vtkDataArrayGetBoundedSizes ()
 
vtkLabelHierarchyIteratorNewIterator (int type, vtkRenderer *ren, vtkCamera *cam, double frustumPlanes[24], bool positionsAsNormals, float bucketSize[2])
 Returns an iterator for this data object. More...
 
void GetDiscreteNodeCoordinatesFromWorldPoint (int ijk[3], double pt[3], int level)
 Given a depth in the hierarchy (level) and a point pt in world space, compute ijk. More...
 
vtkIdType GetNumberOfCells () override
 Inherited members (from vtkDataSet) More...
 
vtkCellGetCell (vtkIdType) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCell (vtkIdType, vtkGenericCell *) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
int GetCellType (vtkIdType) override
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCellPoints (vtkIdType, vtkIdList *) override
 Topological inquiry to get points defining cell. More...
 
void GetPointCells (vtkIdType, vtkIdList *) override
 Topological inquiry to get cells using point. More...
 
vtkIdType FindCell (double *, vtkCell *, vtkIdType, double, int &, double *, double *) override
 
vtkIdType FindCell (double *, vtkCell *, vtkGenericCell *, vtkIdType, double, int &, double *, double *) override
 
int GetMaxCellSize () override
 Convenience method returns largest cell size in dataset. More...
 
ImplementationGetImplementation ()
 
virtual vtkPointsGetCenterPts ()
 Provide access to original coordinates of sets of coincident points. More...
 
virtual vtkCoincidentPointsGetCoincidentPoints ()
 Provide access to the set of coincident points that have been perturbed by the hierarchy in order to render labels for each without overlap. More...
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
- Public Member Functions inherited from vtkPointSet
vtkPointSetNewInstance () const
 
virtual void SetEditable (bool)
 Specify whether this dataset is editable after creation. More...
 
virtual bool GetEditable ()
 
virtual void EditableOn ()
 
virtual void EditableOff ()
 
void Initialize () override
 Reset to an empty state and free any memory. More...
 
void CopyStructure (vtkDataSet *pd) override
 Copy the geometric structure of an input point set object. More...
 
vtkIdType GetNumberOfPoints () override
 See vtkDataSet for additional information. More...
 
void GetPoint (vtkIdType ptId, double x[3]) override
 Copy point coordinates into user provided array x[3] for specified point id. More...
 
vtkIdType FindPoint (double x[3]) override
 
vtkIdType FindPoint (double x, double y, double z)
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate cell based on global coordinate x and tolerance squared. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 This is a version of the above method that can be used with multithreaded applications. More...
 
doubleGetPoint (vtkIdType ptId) override
 See vtkDataSet for additional information. More...
 
vtkCellIteratorNewCellIterator () override
 Return an iterator that traverses the cells in this data set. More...
 
void BuildPointLocator ()
 Build the internal point locator . More...
 
void BuildLocator ()
 
void BuildCellLocator ()
 Build the cell locator. More...
 
virtual void SetPointLocator (vtkAbstractPointLocator *)
 Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. More...
 
virtual vtkAbstractPointLocatorGetPointLocator ()
 
virtual void SetCellLocator (vtkAbstractCellLocator *)
 Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation. More...
 
virtual vtkAbstractCellLocatorGetCellLocator ()
 
vtkMTimeType GetMTime () override
 Get MTime which also considers its vtkPoints MTime. More...
 
void ComputeBounds () override
 Compute the (X, Y, Z) bounds of the data. More...
 
void Squeeze () override
 Reclaim any unused memory. More...
 
virtual vtkPointsGetPoints ()
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 
void Register (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
doubleGetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
doubleGetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int GetDataObjectType () override
 Return the type of data object. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise. More...
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. More...
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkLabelHierarchyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLabelHierarchySafeDownCast (vtkObjectBase *o)
 
static bool GetPathForNodalCoordinates (int *path, int ijk[3], int level)
 Given a level of the tree and ijk coordinates in a lattice, compute a path down the tree to reach the corresponding lattice node. More...
 
static void GetAnchorFrustumPlanes (double frustumPlanes[24], vtkRenderer *ren, vtkCoordinate *anchorTransform)
 Compute frustum for quickly excluding labels from rendering that are outside the visible region. More...
 
- Static Public Member Functions inherited from vtkPointSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPointSetSafeDownCast (vtkObjectBase *o)
 
static vtkPointSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLabelHierarchy ()
 
 ~vtkLabelHierarchy () override
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int TargetLabelCount
 
int MaximumDepth
 
vtkDataArrayPriorities
 
vtkAbstractArrayLabels
 
vtkDataArrayOrientations
 
vtkIntArrayIconIndices
 
vtkDataArraySizes
 
vtkDataArrayBoundedSizes
 
vtkCoincidentPointsCoincidentPoints
 
vtkPointsCenterPts
 
vtkTextPropertyTextProperty
 
ImplementationImpl
 
- Protected Attributes inherited from vtkPointSet
bool Editable
 
vtkPointsPoints
 
vtkAbstractPointLocatorPointLocator
 
vtkAbstractCellLocatorCellLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
vtkUnsignedCharArrayCellGhostArray
 
bool PointGhostArrayCached
 
bool CellGhostArrayCached
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkLabelHierarchyFrustumIterator
 
class vtkLabelHierarchyFullSortIterator
 
class implementation
 

Detailed Description

contains an octree of labels

This class represents labels in a hierarchy used to denote rendering priority. A binary tree of labels is maintained that subdivides the bounds of the of the label anchors spatially. Which level of the tree a label occupies determines its priority; those at higher levels of the tree will be more likely to render than those at lower levels of the tree.

Pass vtkLabelHierarchy objects to a vtkLabelPlacementMapper filter for dynamic, non-overlapping, per-frame placement of labels.

Note that if we have a d-dimensional binary tree and we want a fixed number $n$ of labels in each node (all nodes, not just leaves), we can compute the depth of tree required assuming a uniform distribution of points. Given a total of $N$ points we know that $\frac{N}{|T|} = n$, where $|T|$ is the cardinality of the tree (i.e., the number of nodes it contains). Because we have a uniform distribution, the tree will be uniformly subdivided and thus $|T| = 1 + 2^d + \left(2^d\right)^2 + \cdots + \left(2^d\right)^k$, where $d$ is the dimensionality of the input points (fixed at 3 for now). As $k$ becomes large, $|T|\approx 2 \left(2^d\right)^k$. Using this approximation, we can solve for $k$:

\[ k = \frac{\log{\frac{N}{2n}}}{\log{2^d}} \]

Given a set of $N$ input label anchors, we'll compute $k$ and then bin the anchors into tree nodes at level $k$ of the tree. After this, all the nodes will be in the leaves of the tree and those leaves will be at the $k$-th level; no anchors will be in levels $1, 2, \ldots, k-1$. To fix that, we'll choose to move some anchors upwards. The exact number to move upwards depends on TargetLabelCount. We'll move as many up as required to have TargetLabelCount at each node.

You should avoid situations where MaximumDepth does not allow for TargetLabelCount or fewer entries at each node. The MaximumDepth is a hard limit while TargetLabelCount is a suggested optimum. You will end up with many more than TargetLabelCount entries per node and things will be sloooow.

Tests:
vtkLabelHierarchy (Tests)

Definition at line 82 of file vtkLabelHierarchy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 86 of file vtkLabelHierarchy.h.

Member Enumeration Documentation

◆ IteratorType

Enumeration of iterator types.

Enumerator
FULL_SORT 
QUEUE 
DEPTH_FIRST 
FRUSTUM 

Definition at line 119 of file vtkLabelHierarchy.h.

Constructor & Destructor Documentation

◆ vtkLabelHierarchy()

vtkLabelHierarchy::vtkLabelHierarchy ( )
protected

◆ ~vtkLabelHierarchy()

vtkLabelHierarchy::~vtkLabelHierarchy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLabelHierarchy* vtkLabelHierarchy::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkLabelHierarchy::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkLabelHierarchy::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 vtkPointSet.

◆ SafeDownCast()

static vtkLabelHierarchy* vtkLabelHierarchy::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLabelHierarchy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointSet.

◆ NewInstance()

vtkLabelHierarchy* vtkLabelHierarchy::NewInstance ( ) const

◆ PrintSelf()

void vtkLabelHierarchy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkPointSet.

◆ SetPoints()

void vtkLabelHierarchy::SetPoints ( vtkPoints )
overridevirtual

Override SetPoints so we can reset the hierarchy when the points change.

Reimplemented from vtkPointSet.

◆ ComputeHierarchy()

virtual void vtkLabelHierarchy::ComputeHierarchy ( )
virtual

Fill the hierarchy with the input labels.

◆ SetTargetLabelCount()

virtual void vtkLabelHierarchy::SetTargetLabelCount ( int  )
virtual

The number of labels that is ideally present at any octree node.

It is best if this is a multiple of $2^d$.

◆ GetTargetLabelCount()

virtual int vtkLabelHierarchy::GetTargetLabelCount ( )
virtual

◆ SetMaximumDepth()

virtual void vtkLabelHierarchy::SetMaximumDepth ( int  )
virtual

The maximum depth of the octree.

◆ GetMaximumDepth()

virtual int vtkLabelHierarchy::GetMaximumDepth ( )
virtual

◆ SetTextProperty()

virtual void vtkLabelHierarchy::SetTextProperty ( vtkTextProperty tprop)
virtual

The default text property assigned to labels in this hierarchy.

◆ GetTextProperty()

virtual vtkTextProperty* vtkLabelHierarchy::GetTextProperty ( )
virtual

◆ SetPriorities()

virtual void vtkLabelHierarchy::SetPriorities ( vtkDataArray arr)
virtual

Set/get the array specifying the importance (priority) of each label.

◆ GetPriorities()

virtual vtkDataArray* vtkLabelHierarchy::GetPriorities ( )
virtual

◆ SetLabels()

virtual void vtkLabelHierarchy::SetLabels ( vtkAbstractArray arr)
virtual

Set/get the array specifying the text of each label.

◆ GetLabels()

virtual vtkAbstractArray* vtkLabelHierarchy::GetLabels ( )
virtual

◆ SetOrientations()

virtual void vtkLabelHierarchy::SetOrientations ( vtkDataArray arr)
virtual

Set/get the array specifying the orientation of each label.

◆ GetOrientations()

virtual vtkDataArray* vtkLabelHierarchy::GetOrientations ( )
virtual

◆ SetIconIndices()

virtual void vtkLabelHierarchy::SetIconIndices ( vtkIntArray arr)
virtual

Set/get the array specifying the icon index of each label.

◆ GetIconIndices()

virtual vtkIntArray* vtkLabelHierarchy::GetIconIndices ( )
virtual

◆ SetSizes()

virtual void vtkLabelHierarchy::SetSizes ( vtkDataArray arr)
virtual

Set/get the array specifying the size of each label.

◆ GetSizes()

virtual vtkDataArray* vtkLabelHierarchy::GetSizes ( )
virtual

◆ SetBoundedSizes()

virtual void vtkLabelHierarchy::SetBoundedSizes ( vtkDataArray arr)
virtual

Set/get the array specifying the maximum width and height in world coordinates of each label.

◆ GetBoundedSizes()

virtual vtkDataArray* vtkLabelHierarchy::GetBoundedSizes ( )
virtual

◆ NewIterator()

vtkLabelHierarchyIterator* vtkLabelHierarchy::NewIterator ( int  type,
vtkRenderer ren,
vtkCamera cam,
double  frustumPlanes[24],
bool  positionsAsNormals,
float  bucketSize[2] 
)

Returns an iterator for this data object.

positionsAsNormals should only be true when labels are on a sphere centered at the origin (3D world).

Parameters
type- the type should be one of FULL_SORT, QUEUE, DEPTH_FIRST, or FRUSTUM.
ren- the current renderer (used for viewport information)
cam- the current camera.
frustumPlanes- should be the output of the camera's frustum planes.
positionsAsNormals- throws out octree nodes on the opposite side of the origin.
bucketSize- an array of 2 integers describing the width and height of label placer buckets.

◆ GetDiscreteNodeCoordinatesFromWorldPoint()

void vtkLabelHierarchy::GetDiscreteNodeCoordinatesFromWorldPoint ( int  ijk[3],
double  pt[3],
int  level 
)

Given a depth in the hierarchy (level) and a point pt in world space, compute ijk.

This is used to find other octree nodes at the same level that are within the search radius for candidate labels to be placed. It is called with pt set to the camera eye point and pythagorean quadruples increasingly distant from the origin are added to ijk to identify octree nodes whose labels should be placed.

Parameters
[out]ijk- discrete coordinates of the octree node at level containing pt.
[in]pt- input world point coordinates
[in]level- input octree level to be considered

◆ GetPathForNodalCoordinates()

static bool vtkLabelHierarchy::GetPathForNodalCoordinates ( int path,
int  ijk[3],
int  level 
)
static

Given a level of the tree and ijk coordinates in a lattice, compute a path down the tree to reach the corresponding lattice node.

If the lattice coordinates are outside the tree, this returns false. Otherwise it returns true. This does not guarantee that the path exists in the hierarchy.

Parameters
[out]path- a vector of level integers specifying which child to descend at each level to reach ijk
[in]ijk- discrete coordinates of the octree node at level
[in]level- input octree level to be considered

◆ GetNumberOfCells()

vtkIdType vtkLabelHierarchy::GetNumberOfCells ( )
overridevirtual

Inherited members (from vtkDataSet)

Implements vtkDataSet.

◆ GetCell() [1/5]

vtkCell* vtkLabelHierarchy::GetCell ( vtkIdType  cellId)
overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

◆ GetCell() [2/5]

void vtkLabelHierarchy::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellType()

int vtkLabelHierarchy::GetCellType ( vtkIdType  cellId)
overridevirtual

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellPoints()

void vtkLabelHierarchy::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
overridevirtual

Topological inquiry to get points defining cell.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetPointCells()

void vtkLabelHierarchy::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
overridevirtual

Topological inquiry to get cells using point.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ FindCell() [1/2]

vtkIdType vtkLabelHierarchy::FindCell ( double ,
vtkCell ,
vtkIdType  ,
double  ,
int ,
double ,
double  
)
override

◆ FindCell() [2/2]

vtkIdType vtkLabelHierarchy::FindCell ( double ,
vtkCell ,
vtkGenericCell ,
vtkIdType  ,
double  ,
int ,
double ,
double  
)
override

◆ GetMaxCellSize()

int vtkLabelHierarchy::GetMaxCellSize ( )
overridevirtual

Convenience method returns largest cell size in dataset.

This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

Implements vtkDataSet.

◆ GetImplementation()

Implementation* vtkLabelHierarchy::GetImplementation ( )
inline

Definition at line 237 of file vtkLabelHierarchy.h.

◆ GetCenterPts()

virtual vtkPoints* vtkLabelHierarchy::GetCenterPts ( )
virtual

Provide access to original coordinates of sets of coincident points.

◆ GetCoincidentPoints()

virtual vtkCoincidentPoints* vtkLabelHierarchy::GetCoincidentPoints ( )
virtual

Provide access to the set of coincident points that have been perturbed by the hierarchy in order to render labels for each without overlap.

◆ GetAnchorFrustumPlanes()

static void vtkLabelHierarchy::GetAnchorFrustumPlanes ( double  frustumPlanes[24],
vtkRenderer ren,
vtkCoordinate anchorTransform 
)
static

Compute frustum for quickly excluding labels from rendering that are outside the visible region.

This is a shared utility function.

◆ GetCell() [3/5]

virtual vtkCell* vtkDataSet::GetCell

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS NOT THREAD SAFE.

◆ GetCell() [4/5]

virtual vtkCell* vtkDataSet::GetCell
inline

Definition at line 120 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Friends And Related Function Documentation

◆ vtkLabelHierarchyFrustumIterator

friend class vtkLabelHierarchyFrustumIterator
friend

Definition at line 282 of file vtkLabelHierarchy.h.

◆ vtkLabelHierarchyFullSortIterator

friend class vtkLabelHierarchyFullSortIterator
friend

Definition at line 283 of file vtkLabelHierarchy.h.

◆ implementation

friend class implementation
friend

Definition at line 284 of file vtkLabelHierarchy.h.

Member Data Documentation

◆ TargetLabelCount

int vtkLabelHierarchy::TargetLabelCount
protected

Definition at line 268 of file vtkLabelHierarchy.h.

◆ MaximumDepth

int vtkLabelHierarchy::MaximumDepth
protected

Definition at line 269 of file vtkLabelHierarchy.h.

◆ Priorities

vtkDataArray* vtkLabelHierarchy::Priorities
protected

Definition at line 270 of file vtkLabelHierarchy.h.

◆ Labels

vtkAbstractArray* vtkLabelHierarchy::Labels
protected

Definition at line 271 of file vtkLabelHierarchy.h.

◆ Orientations

vtkDataArray* vtkLabelHierarchy::Orientations
protected

Definition at line 272 of file vtkLabelHierarchy.h.

◆ IconIndices

vtkIntArray* vtkLabelHierarchy::IconIndices
protected

Definition at line 273 of file vtkLabelHierarchy.h.

◆ Sizes

vtkDataArray* vtkLabelHierarchy::Sizes
protected

Definition at line 274 of file vtkLabelHierarchy.h.

◆ BoundedSizes

vtkDataArray* vtkLabelHierarchy::BoundedSizes
protected

Definition at line 275 of file vtkLabelHierarchy.h.

◆ CoincidentPoints

vtkCoincidentPoints* vtkLabelHierarchy::CoincidentPoints
protected

Definition at line 276 of file vtkLabelHierarchy.h.

◆ CenterPts

vtkPoints* vtkLabelHierarchy::CenterPts
protected

Definition at line 277 of file vtkLabelHierarchy.h.

◆ TextProperty

vtkTextProperty* vtkLabelHierarchy::TextProperty
protected

Definition at line 278 of file vtkLabelHierarchy.h.

◆ Impl

Implementation* vtkLabelHierarchy::Impl
protected

Definition at line 280 of file vtkLabelHierarchy.h.


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