Places and renders non-overlapping labels. More...

#include <vtkLabelPlacementMapper.h>

Inheritance diagram for vtkLabelPlacementMapper:

Collaboration diagram for vtkLabelPlacementMapper:

Public Types
enum	LabelShape { NONE , RECT , ROUNDED_RECT , NUMBER_OF_LABEL_SHAPES }

enum	LabelStyle { FILLED , OUTLINE , NUMBER_OF_LABEL_STYLES }

typedef vtkMapper2D	Superclass

Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper	Superclass

Public Types inherited from vtkAbstractMapper
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.

vtkLabelPlacementMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RenderOverlay (vtkViewport viewport, vtkActor2D actor) override
	Draw non-overlapping labels to the screen.

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this mapper.


virtual void	SetRenderStrategy (vtkLabelRenderStrategy *s)
	Set the label rendering strategy.

virtual vtkLabelRenderStrategy *	GetRenderStrategy ()
	Set the label rendering strategy.


virtual void	SetMaximumLabelFraction (double)
	The maximum fraction of the screen that the labels may cover.

virtual double	GetMaximumLabelFraction ()
	The maximum fraction of the screen that the labels may cover.


virtual void	SetIteratorType (int)
	The type of iterator used when traversing the labels.

virtual int	GetIteratorType ()
	The type of iterator used when traversing the labels.


virtual bool	GetPositionsAsNormals ()
	Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera.

virtual void	SetPositionsAsNormals (bool)
	Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera.

virtual void	PositionsAsNormalsOn ()
	Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera.

virtual void	PositionsAsNormalsOff ()
	Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera.


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

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

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

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


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.

virtual void	SetUseDepthBuffer (bool)
	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.

virtual void	UseDepthBufferOn ()
	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.

virtual void	UseDepthBufferOff ()
	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.


virtual void	SetPlaceAllLabels (bool)
	Tells the placer to place every label regardless of overlap.

virtual bool	GetPlaceAllLabels ()
	Tells the placer to place every label regardless of overlap.

virtual void	PlaceAllLabelsOn ()
	Tells the placer to place every label regardless of overlap.

virtual void	PlaceAllLabelsOff ()
	Tells the placer to place every label regardless of overlap.


virtual void	SetOutputTraversedBounds (bool)
	Whether to render traversed bounds.

virtual bool	GetOutputTraversedBounds ()
	Whether to render traversed bounds.

virtual void	OutputTraversedBoundsOn ()
	Whether to render traversed bounds.

virtual void	OutputTraversedBoundsOff ()
	Whether to render traversed bounds.


virtual void	SetShape (int)
	The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual int	GetShape ()
	The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual void	SetShapeToNone ()
	The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual void	SetShapeToRect ()
	The shape of the label background, should be one of the values in the LabelShape enumeration.

virtual void	SetShapeToRoundedRect ()
	The shape of the label background, should be one of the values in the LabelShape enumeration.


virtual void	SetStyle (int)
	The style of the label background shape, should be one of the values in the LabelStyle enumeration.

virtual int	GetStyle ()
	The style of the label background shape, should be one of the values in the LabelStyle enumeration.

virtual void	SetStyleToFilled ()
	The style of the label background shape, should be one of the values in the LabelStyle enumeration.

virtual void	SetStyleToOutline ()
	The style of the label background shape, should be one of the values in the LabelStyle enumeration.


virtual void	SetMargin (double)
	The size of the margin on the label background shape.

virtual double	GetMargin ()
	The size of the margin on the label background shape.


virtual void	SetBackgroundColor (double, double, double)
	The color of the background shape.

virtual void	SetBackgroundColor (double[3])
	The color of the background shape.

virtual double *	GetBackgroundColor ()
	The color of the background shape.

virtual void	GetBackgroundColor (double &, double &, double &)
	The color of the background shape.

virtual void	GetBackgroundColor (double[3])
	The color of the background shape.


virtual void	SetBackgroundOpacity (double)
	The opacity of the background shape.

virtual double	GetBackgroundOpacity ()
	The opacity of the background shape.


virtual vtkCoordinate *	GetAnchorTransform ()
	Get the transform for the anchor points.

Public Member Functions inherited from vtkMapper2D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkMapper2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	RenderOverlay (vtkViewport , vtkActor2D )

virtual void	RenderOpaqueGeometry (vtkViewport , vtkActor2D )

virtual void	RenderTranslucentPolygonalGeometry (vtkViewport , vtkActor2D )

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkAbstractMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkMTimeType	GetMTime () override
	Override Modifiedtime as we have added Clipping planes.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this mapper.

void	SetClippingPlanes (vtkPlanes *planes)
	An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes.

virtual void	ShallowCopy (vtkAbstractMapper *m)
	Make a shallow copy of this mapper.

int	GetNumberOfClippingPlanes ()
	Get the number of clipping planes.

virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered.

void	AddClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

void	RemoveClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

void	RemoveAllClippingPlanes ()
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

virtual void	SetClippingPlanes (vtkPlaneCollection *)
	Get/Set the vtkPlaneCollection which specifies the clipping planes.

virtual vtkPlaneCollection *	GetClippingPlanes ()
	Get/Set the vtkPlaneCollection which specifies the clipping planes.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

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.

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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

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

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

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.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS 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.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

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.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	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.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given 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).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkLabelPlacementMapper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkLabelPlacementMapper *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkMapper2D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkMapper2D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractMapper *	SafeDownCast (vtkObjectBase *o)

static vtkDataArray *	GetScalars (vtkDataSet input, int scalarMode, int arrayAccessMode, int arrayId, const char arrayName, int &cellFlag)
	Internal helper function for getting the active scalars.

static vtkAbstractArray *	GetAbstractScalars (vtkDataSet input, int scalarMode, int arrayAccessMode, int arrayId, const char arrayName, int &cellFlag)
	Internal helper function for getting the active scalars as an abstract array.

static vtkUnsignedCharArray *	GetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
	Returns the ghost array associated with the corresponding scalar mode, if present.

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLabelPlacementMapper ()

	~vtkLabelPlacementMapper () override

virtual void	SetAnchorTransform (vtkCoordinate *)

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

Protected Member Functions inherited from vtkMapper2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMapper2D ()=default

	~vtkMapper2D () override=default

Protected Member Functions inherited from vtkAbstractMapper
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractMapper ()

	~vtkAbstractMapper () override

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
Internal *	Buckets

vtkLabelRenderStrategy *	RenderStrategy

vtkCoordinate *	AnchorTransform

vtkSelectVisiblePoints *	VisiblePoints

double	MaximumLabelFraction

bool	PositionsAsNormals

bool	GeneratePerturbedLabelSpokes

bool	UseDepthBuffer

bool	PlaceAllLabels

bool	OutputTraversedBounds

int	LastRendererSize [2]

double	LastCameraPosition [3]

double	LastCameraFocalPoint [3]

double	LastCameraViewUp [3]

double	LastCameraParallelScale

int	IteratorType

int	Style

int	Shape

double	Margin

double	BackgroundOpacity

double	BackgroundColor [3]

Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer

double	TimeToDraw

vtkWindow *	LastWindow

vtkPlaneCollection *	ClippingPlanes

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Places and renders non-overlapping labels.

To use this mapper, first send your data through vtkPointSetToLabelHierarchy, which takes a set of points, associates special arrays to the points (label, priority, etc.), and produces a prioritized spatial tree of labels.

This mapper then takes that hierarchy (or hierarchies) as input, and every frame will decide which labels and/or icons to place in order of priority, and will render only those labels/icons. A label render strategy is used to render the labels, and can use e.g. FreeType or Qt for rendering.

Online Examples:

LabelPlacementMapper

Tests:: vtkLabelPlacementMapper (Tests)

Definition at line 53 of file vtkLabelPlacementMapper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMapper2D vtkLabelPlacementMapper::Superclass

Definition at line 57 of file vtkLabelPlacementMapper.h.

Member Enumeration Documentation

◆ LabelShape

enum vtkLabelPlacementMapper::LabelShape

Enumerator
NONE
RECT
ROUNDED_RECT
NUMBER_OF_LABEL_SHAPES

Definition at line 141 of file vtkLabelPlacementMapper.h.

◆ LabelStyle

enum vtkLabelPlacementMapper::LabelStyle

Enumerator
FILLED
OUTLINE
NUMBER_OF_LABEL_STYLES

Definition at line 161 of file vtkLabelPlacementMapper.h.

Constructor & Destructor Documentation

◆ vtkLabelPlacementMapper()

vtkLabelPlacementMapper::vtkLabelPlacementMapper ( )

protected

◆ ~vtkLabelPlacementMapper()

vtkLabelPlacementMapper::~vtkLabelPlacementMapper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkLabelPlacementMapper * vtkLabelPlacementMapper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkLabelPlacementMapper::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 vtkMapper2D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLabelPlacementMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMapper2D.

◆ NewInstance()

vtkLabelPlacementMapper * vtkLabelPlacementMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkLabelPlacementMapper::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 vtkAbstractMapper.

◆ RenderOverlay()

void vtkLabelPlacementMapper::RenderOverlay	(	vtkViewport *	viewport,
		vtkActor2D *	actor
	)

overridevirtual

Draw non-overlapping labels to the screen.

Reimplemented from vtkMapper2D.

◆ SetRenderStrategy()

virtual void vtkLabelPlacementMapper::SetRenderStrategy ( vtkLabelRenderStrategy * s )

virtual

Set the label rendering strategy.

◆ GetRenderStrategy()

virtual vtkLabelRenderStrategy * vtkLabelPlacementMapper::GetRenderStrategy ( )

virtual

Set the label rendering strategy.

◆ SetMaximumLabelFraction()

virtual void vtkLabelPlacementMapper::SetMaximumLabelFraction ( double )

virtual

The maximum fraction of the screen that the labels may cover.

Label placement stops when this fraction is reached.

◆ GetMaximumLabelFraction()

virtual double vtkLabelPlacementMapper::GetMaximumLabelFraction ( )

virtual

The maximum fraction of the screen that the labels may cover.

Label placement stops when this fraction is reached.

◆ SetIteratorType()

virtual void vtkLabelPlacementMapper::SetIteratorType ( int )

virtual

The type of iterator used when traversing the labels.

May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT

◆ GetIteratorType()

virtual int vtkLabelPlacementMapper::GetIteratorType ( )

virtual

The type of iterator used when traversing the labels.

May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT

◆ GetPositionsAsNormals()

virtual bool vtkLabelPlacementMapper::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 vtkLabelPlacementMapper::SetPositionsAsNormals ( bool )

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.

◆ PositionsAsNormalsOn()

virtual void vtkLabelPlacementMapper::PositionsAsNormalsOn ( )

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.

◆ PositionsAsNormalsOff()

virtual void vtkLabelPlacementMapper::PositionsAsNormalsOff ( )

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.

◆ GetGeneratePerturbedLabelSpokes()

virtual bool vtkLabelPlacementMapper::GetGeneratePerturbedLabelSpokes ( )

virtual

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

◆ SetGeneratePerturbedLabelSpokes()

virtual void vtkLabelPlacementMapper::SetGeneratePerturbedLabelSpokes ( bool )

virtual

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

◆ GeneratePerturbedLabelSpokesOn()

virtual void vtkLabelPlacementMapper::GeneratePerturbedLabelSpokesOn ( )

virtual

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

◆ GeneratePerturbedLabelSpokesOff()

virtual void vtkLabelPlacementMapper::GeneratePerturbedLabelSpokesOff ( )

virtual

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

◆ GetUseDepthBuffer()

virtual bool vtkLabelPlacementMapper::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 vtkLabelPlacementMapper::SetUseDepthBuffer ( bool )

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.

◆ UseDepthBufferOn()

virtual void vtkLabelPlacementMapper::UseDepthBufferOn ( )

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.

◆ UseDepthBufferOff()

virtual void vtkLabelPlacementMapper::UseDepthBufferOff ( )

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.

◆ SetPlaceAllLabels()

virtual void vtkLabelPlacementMapper::SetPlaceAllLabels ( bool )

virtual

Tells the placer to place every label regardless of overlap.

Off by default.

◆ GetPlaceAllLabels()

virtual bool vtkLabelPlacementMapper::GetPlaceAllLabels ( )

virtual

Tells the placer to place every label regardless of overlap.

Off by default.

◆ PlaceAllLabelsOn()

virtual void vtkLabelPlacementMapper::PlaceAllLabelsOn ( )

virtual

Tells the placer to place every label regardless of overlap.

Off by default.

◆ PlaceAllLabelsOff()

virtual void vtkLabelPlacementMapper::PlaceAllLabelsOff ( )

virtual

Tells the placer to place every label regardless of overlap.

Off by default.

◆ SetOutputTraversedBounds()

virtual void vtkLabelPlacementMapper::SetOutputTraversedBounds ( bool )

virtual

Whether to render traversed bounds.

Off by default.

◆ GetOutputTraversedBounds()

virtual bool vtkLabelPlacementMapper::GetOutputTraversedBounds ( )

virtual

Whether to render traversed bounds.

Off by default.

◆ OutputTraversedBoundsOn()

virtual void vtkLabelPlacementMapper::OutputTraversedBoundsOn ( )

virtual

Whether to render traversed bounds.

Off by default.

◆ OutputTraversedBoundsOff()

virtual void vtkLabelPlacementMapper::OutputTraversedBoundsOff ( )

virtual

Whether to render traversed bounds.

Off by default.