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

place a prioritized hierarchy of labels in screen space More...

#include <vtkLabelPlacer.h>

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

Public Types

enum  LabelGravity {
  VerticalBottomBit = 1, VerticalBaselineBit = 2, VerticalCenterBit = 4, VerticalTopBit = 8,
  HorizontalLeftBit = 16, HorizontalCenterBit = 32, HorizontalRightBit = 64, VerticalBitMask = 15,
  HorizontalBitMask = 112, LowerLeft = 17, LowerCenter, LowerRight = 65,
  BaselineLeft = 18, BaselineCenter = 34, BaselineRight = 66, CenterLeft = 20,
  CenterCenter, CenterRight = 68, UpperLeft = 24, UpperCenter = 40,
  UpperRight = 72
}
 Specifications for the placement of the label relative to an anchor point. More...
 
enum  OutputCoordinates { WORLD = 0, DISPLAY = 1 }
 Coordinate systems that output dataset may use. More...
 
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. 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...
 
vtkLabelPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRendererGetRenderer ()
 
virtual void SetRenderer (vtkRenderer *)
 
virtual vtkCoordinateGetAnchorTransform ()
 
virtual void SetGravity (int gravity)
 The placement of the label relative to the anchor point. More...
 
virtual int GetGravity ()
 
virtual void SetMaximumLabelFraction (double)
 The maximum amount of screen space labels can take up before placement terminates. More...
 
virtual double GetMaximumLabelFraction ()
 
virtual void SetIteratorType (int)
 The type of iterator used when traversing the labels. More...
 
virtual int GetIteratorType ()
 
virtual void SetUseUnicodeStrings (bool)
 Set whether, or not, to use unicode strings. More...
 
virtual bool GetUseUnicodeStrings ()
 
virtual void UseUnicodeStringsOn ()
 
virtual void UseUnicodeStringsOff ()
 
vtkMTimeType GetMTime () override
 Return this object's modified time. More...
 
virtual bool GetPositionsAsNormals ()
 Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. More...
 
virtual void SetPositionsAsNormals (bool)
 
virtual void PositionsAsNormalsOn ()
 
virtual void PositionsAsNormalsOff ()
 
virtual bool GetGeneratePerturbedLabelSpokes ()
 Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates. More...
 
virtual void SetGeneratePerturbedLabelSpokes (bool)
 
virtual void GeneratePerturbedLabelSpokesOn ()
 
virtual void GeneratePerturbedLabelSpokesOff ()
 
virtual bool GetUseDepthBuffer ()
 Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. More...
 
virtual void SetUseDepthBuffer (bool)
 
virtual void UseDepthBufferOn ()
 
virtual void UseDepthBufferOff ()
 
virtual bool GetOutputTraversedBounds ()
 In the second output, output the geometry of the traversed octree nodes. More...
 
virtual void SetOutputTraversedBounds (bool)
 
virtual void OutputTraversedBoundsOn ()
 
virtual void OutputTraversedBoundsOff ()
 
virtual int GetOutputCoordinateSystem ()
 Set/get the coordinate system used for output labels. More...
 
virtual void SetOutputCoordinateSystem (int)
 
void OutputCoordinateSystemWorld ()
 
void OutputCoordinateSystemDisplay ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 vtkLabelPlacerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLabelPlacerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and 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
 
 vtkLabelPlacer ()
 
 ~vtkLabelPlacer () override
 
virtual void SetAnchorTransform (vtkCoordinate *)
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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

Internal * Buckets
 
vtkRendererRenderer
 
vtkCoordinateAnchorTransform
 
vtkSelectVisiblePointsVisiblePoints
 
int Gravity
 
double MaximumLabelFraction
 
bool PositionsAsNormals
 
bool OutputTraversedBounds
 
bool GeneratePerturbedLabelSpokes
 
bool UseDepthBuffer
 
bool UseUnicodeStrings
 
int LastRendererSize [2]
 
double LastCameraPosition [3]
 
double LastCameraFocalPoint [3]
 
double LastCameraViewUp [3]
 
double LastCameraParallelScale
 
int IteratorType
 
int OutputCoordinateSystem
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

place a prioritized hierarchy of labels in screen space

This class is deprecated and will be removed from VTK in a future release. Use vtkLabelPlacementMapper instead.

This should probably be a mapper unto itself (given that the polydata output could be large and will realistically always be iterated over exactly once before being tossed for the next frame of the render).

In any event, it takes as input one (or more, eventually) vtkLabelHierarchies that represent prioritized lists of labels sorted by their placement in space. As output, it provides vtkPolyData containing only VTK_QUAD cells, each representing a single label from the input. Each quadrilateral has cell data indicating what label in the input it corresponds to (via an array named "LabelId").

Definition at line 52 of file vtkLabelPlacer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkLabelPlacer.h.

Member Enumeration Documentation

◆ LabelGravity

Specifications for the placement of the label relative to an anchor point.

Enumerator
VerticalBottomBit 
VerticalBaselineBit 
VerticalCenterBit 
VerticalTopBit 
HorizontalLeftBit 
HorizontalCenterBit 
HorizontalRightBit 
VerticalBitMask 
HorizontalBitMask 
LowerLeft 

The anchor is at the lower left corner of the label's bounding box.

LowerCenter 

The anchor is centered left-to-right at the lower edge of the bounding box.

LowerRight 

The anchor is at the lower right corner of the label's bounding box.

BaselineLeft 

The anchor is on the text baseline (or bottom for images) at the left edge of the label's bounding box.

BaselineCenter 

The anchor is centered left-to-right at the text baseline of the bounding box, or the bottom for images.

BaselineRight 

The anchor is on the text baseline (or bottom for images) at the right edge of the label's bounding box.

CenterLeft 

The anchor is at the far left edge of the label at the vertical center of the bounding box.

CenterCenter 

The anchor is centered left-to-right at the vertical midpoint of the bounding box.

CenterRight 

The anchor is at the far right edge of the label at the vertical center of the bounding box.

UpperLeft 

The anchor is at the upper left corner of the label's bounding box.

UpperCenter 

The anchor is centered left-to-right at the top edge of the bounding box.

UpperRight 

The anchor is at the upper right corner of the label's bounding box.

Definition at line 65 of file vtkLabelPlacer.h.

◆ OutputCoordinates

Coordinate systems that output dataset may use.

Enumerator
WORLD 

Output 3-D world-space coordinates for each label anchor.

DISPLAY 

Output 2-D display coordinates for each label anchor (3 components but only 2 are significant).

Definition at line 102 of file vtkLabelPlacer.h.

Constructor & Destructor Documentation

◆ vtkLabelPlacer()

vtkLabelPlacer::vtkLabelPlacer ( )
protected

◆ ~vtkLabelPlacer()

vtkLabelPlacer::~vtkLabelPlacer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLabelPlacer* vtkLabelPlacer::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLabelPlacer::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 vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLabelPlacer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkLabelPlacer* vtkLabelPlacer::NewInstance ( ) const

◆ PrintSelf()

void vtkLabelPlacer::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 vtkPolyDataAlgorithm.

◆ GetRenderer()

virtual vtkRenderer* vtkLabelPlacer::GetRenderer ( )
virtual

◆ SetRenderer()

virtual void vtkLabelPlacer::SetRenderer ( vtkRenderer )
virtual

◆ GetAnchorTransform()

virtual vtkCoordinate* vtkLabelPlacer::GetAnchorTransform ( )
virtual

◆ SetGravity()

virtual void vtkLabelPlacer::SetGravity ( int  gravity)
virtual

The placement of the label relative to the anchor point.

◆ GetGravity()

virtual int vtkLabelPlacer::GetGravity ( )
virtual

◆ SetMaximumLabelFraction()

virtual void vtkLabelPlacer::SetMaximumLabelFraction ( double  )
virtual

The maximum amount of screen space labels can take up before placement terminates.

◆ GetMaximumLabelFraction()

virtual double vtkLabelPlacer::GetMaximumLabelFraction ( )
virtual

◆ SetIteratorType()

virtual void vtkLabelPlacer::SetIteratorType ( int  )
virtual

The type of iterator used when traversing the labels.

May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT.

◆ GetIteratorType()

virtual int vtkLabelPlacer::GetIteratorType ( )
virtual

◆ SetUseUnicodeStrings()

virtual void vtkLabelPlacer::SetUseUnicodeStrings ( bool  )
virtual

Set whether, or not, to use unicode strings.

◆ GetUseUnicodeStrings()

virtual bool vtkLabelPlacer::GetUseUnicodeStrings ( )
virtual

◆ UseUnicodeStringsOn()

virtual void vtkLabelPlacer::UseUnicodeStringsOn ( )
virtual

◆ UseUnicodeStringsOff()

virtual void vtkLabelPlacer::UseUnicodeStringsOff ( )
virtual

◆ GetMTime()

vtkMTimeType vtkLabelPlacer::GetMTime ( )
overridevirtual

Return this object's modified time.

Reimplemented from vtkObject.

◆ GetPositionsAsNormals()

virtual bool vtkLabelPlacer::GetPositionsAsNormals ( )
virtual

Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera.

Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default.

◆ SetPositionsAsNormals()

virtual void vtkLabelPlacer::SetPositionsAsNormals ( bool  )
virtual

◆ PositionsAsNormalsOn()

virtual void vtkLabelPlacer::PositionsAsNormalsOn ( )
virtual

◆ PositionsAsNormalsOff()

virtual void vtkLabelPlacer::PositionsAsNormalsOff ( )
virtual

◆ GetGeneratePerturbedLabelSpokes()

virtual bool vtkLabelPlacer::GetGeneratePerturbedLabelSpokes ( )
virtual

Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates.

◆ SetGeneratePerturbedLabelSpokes()

virtual void vtkLabelPlacer::SetGeneratePerturbedLabelSpokes ( bool  )
virtual

◆ GeneratePerturbedLabelSpokesOn()

virtual void vtkLabelPlacer::GeneratePerturbedLabelSpokesOn ( )
virtual

◆ GeneratePerturbedLabelSpokesOff()

virtual void vtkLabelPlacer::GeneratePerturbedLabelSpokesOff ( )
virtual

◆ GetUseDepthBuffer()

virtual bool vtkLabelPlacer::GetUseDepthBuffer ( )
virtual

Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene.

Off by default.

◆ SetUseDepthBuffer()

virtual void vtkLabelPlacer::SetUseDepthBuffer ( bool  )
virtual

◆ UseDepthBufferOn()

virtual void vtkLabelPlacer::UseDepthBufferOn ( )
virtual

◆ UseDepthBufferOff()

virtual void vtkLabelPlacer::UseDepthBufferOff ( )
virtual

◆ GetOutputTraversedBounds()

virtual bool vtkLabelPlacer::GetOutputTraversedBounds ( )
virtual

In the second output, output the geometry of the traversed octree nodes.

◆ SetOutputTraversedBounds()

virtual void vtkLabelPlacer::SetOutputTraversedBounds ( bool  )
virtual

◆ OutputTraversedBoundsOn()

virtual void vtkLabelPlacer::OutputTraversedBoundsOn ( )
virtual

◆ OutputTraversedBoundsOff()

virtual void vtkLabelPlacer::OutputTraversedBoundsOff ( )
virtual

◆ GetOutputCoordinateSystem()

virtual int vtkLabelPlacer::GetOutputCoordinateSystem ( )
virtual

Set/get the coordinate system used for output labels.

The output datasets may have point coordinates reported in the world space or display space.

◆ SetOutputCoordinateSystem()

virtual void vtkLabelPlacer::SetOutputCoordinateSystem ( int  )
virtual

◆ OutputCoordinateSystemWorld()

void vtkLabelPlacer::OutputCoordinateSystemWorld ( )
inline

Definition at line 193 of file vtkLabelPlacer.h.

◆ OutputCoordinateSystemDisplay()

void vtkLabelPlacer::OutputCoordinateSystemDisplay ( )
inline

Definition at line 194 of file vtkLabelPlacer.h.

◆ SetAnchorTransform()

virtual void vtkLabelPlacer::SetAnchorTransform ( vtkCoordinate )
protectedvirtual

◆ FillInputPortInformation()

int vtkLabelPlacer::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestData()

int vtkLabelPlacer::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

◆ Buckets

Internal* vtkLabelPlacer::Buckets
protected

Definition at line 207 of file vtkLabelPlacer.h.

◆ Renderer

vtkRenderer* vtkLabelPlacer::Renderer
protected

Definition at line 210 of file vtkLabelPlacer.h.

◆ AnchorTransform

vtkCoordinate* vtkLabelPlacer::AnchorTransform
protected

Definition at line 211 of file vtkLabelPlacer.h.

◆ VisiblePoints

vtkSelectVisiblePoints* vtkLabelPlacer::VisiblePoints
protected

Definition at line 212 of file vtkLabelPlacer.h.

◆ Gravity

int vtkLabelPlacer::Gravity
protected

Definition at line 213 of file vtkLabelPlacer.h.

◆ MaximumLabelFraction

double vtkLabelPlacer::MaximumLabelFraction
protected

Definition at line 214 of file vtkLabelPlacer.h.

◆ PositionsAsNormals

bool vtkLabelPlacer::PositionsAsNormals
protected

Definition at line 215 of file vtkLabelPlacer.h.

◆ OutputTraversedBounds

bool vtkLabelPlacer::OutputTraversedBounds
protected

Definition at line 216 of file vtkLabelPlacer.h.

◆ GeneratePerturbedLabelSpokes

bool vtkLabelPlacer::GeneratePerturbedLabelSpokes
protected

Definition at line 217 of file vtkLabelPlacer.h.

◆ UseDepthBuffer

bool vtkLabelPlacer::UseDepthBuffer
protected

Definition at line 218 of file vtkLabelPlacer.h.

◆ UseUnicodeStrings

bool vtkLabelPlacer::UseUnicodeStrings
protected

Definition at line 219 of file vtkLabelPlacer.h.

◆ LastRendererSize

int vtkLabelPlacer::LastRendererSize[2]
protected

Definition at line 221 of file vtkLabelPlacer.h.

◆ LastCameraPosition

double vtkLabelPlacer::LastCameraPosition[3]
protected

Definition at line 222 of file vtkLabelPlacer.h.

◆ LastCameraFocalPoint

double vtkLabelPlacer::LastCameraFocalPoint[3]
protected

Definition at line 223 of file vtkLabelPlacer.h.

◆ LastCameraViewUp

double vtkLabelPlacer::LastCameraViewUp[3]
protected

Definition at line 224 of file vtkLabelPlacer.h.

◆ LastCameraParallelScale

double vtkLabelPlacer::LastCameraParallelScale
protected

Definition at line 225 of file vtkLabelPlacer.h.

◆ IteratorType

int vtkLabelPlacer::IteratorType
protected

Definition at line 226 of file vtkLabelPlacer.h.

◆ OutputCoordinateSystem

int vtkLabelPlacer::OutputCoordinateSystem
protected

Definition at line 227 of file vtkLabelPlacer.h.


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