vtkDynamic2DLabelMapper Class Reference

draw text labels at 2D dataset points More...

#include <vtkDynamic2DLabelMapper.h>

Inheritance diagram for vtkDynamic2DLabelMapper:

Collaboration diagram for vtkDynamic2DLabelMapper:

Public Member Functions
void	SetPriorityArrayName (const char *name)
	Set the points array name to use to give priority to labels.
virtual void	SetReversePriority (bool)
	Whether to reverse the priority order (i.e.
virtual bool	GetReversePriority ()
	Whether to reverse the priority order (i.e.
virtual void	ReversePriorityOn ()
	Whether to reverse the priority order (i.e.
virtual void	ReversePriorityOff ()
	Whether to reverse the priority order (i.e.
virtual void	SetLabelHeightPadding (float)
	Set the label height padding as a percentage.
virtual float	GetLabelHeightPadding ()
	Set the label height padding as a percentage.
virtual void	SetLabelWidthPadding (float)
	Set the label width padding as a percentage.
virtual float	GetLabelWidthPadding ()
	Set the label width padding as a percentage.
void	RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor) override
	Draw non-overlapping labels to the screen.
void	RenderOverlay (vtkViewport *viewport, vtkActor2D *actor) override
	Draw non-overlapping labels to the screen.
Public Member Functions inherited from vtkLabeledDataMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkLabeledDataMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetInputData (vtkDataObject *)
	Set the input dataset to the mapper.
vtkDataSet *	GetInput ()
	Use GetInputDataObject() to get the input data object for composite datasets.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
vtkMTimeType	GetMTime () override
	Return the modified time for this object.
const char *	GetLabelText (int label)
	Return the text for the requested label.
virtual void	SetLabelFormat (const char *)
	Set/Get the format with which to print the labels.
virtual char *	GetLabelFormat ()
	Set/Get the format with which to print the labels.
virtual void	SetLabeledComponent (int)
	Set/Get the component number to label if the data to print has more than one component.
virtual int	GetLabeledComponent ()
	Set/Get the component number to label if the data to print has more than one component.
virtual void	SetComponentSeparator (char)
	Set/Get the separator between components.
virtual char	GetComponentSeparator ()
	Set/Get the separator between components.
void	SetFieldDataArray (int arrayIndex)
	Set/Get the field data array to label.
virtual int	GetFieldDataArray ()
	Set/Get the field data array to label.
void	SetFieldDataName (const char *arrayName)
	Set/Get the name of the field data array to label.
virtual char *	GetFieldDataName ()
	Set/Get the name of the field data array to label.
virtual void	SetLabelMode (int)
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
virtual int	GetLabelMode ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelIds ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelScalars ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelVectors ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelNormals ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelTCoords ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelTensors ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
void	SetLabelModeToLabelFieldData ()
	Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.
virtual void	SetLabelTextProperty (vtkTextProperty *p)
	Set/Get the text property.
virtual vtkTextProperty *	GetLabelTextProperty ()
	Set/Get the text property.
virtual void	SetLabelTextProperty (vtkTextProperty *p, int type)
	Set/Get the text property.
virtual vtkTextProperty *	GetLabelTextProperty (int type)
	Set/Get the text property.
void	RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor) override
	Draw the text to the screen at each input point.
void	RenderOverlay (vtkViewport *viewport, vtkActor2D *actor) override
	Draw the text to the screen at each input point.
virtual vtkTransform *	GetTransform ()
	The transform to apply to the labels before mapping to 2D.
void	SetTransform (vtkTransform *t)
	The transform to apply to the labels before mapping to 2D.
virtual int	GetCoordinateSystem ()
	Set/get the coordinate system used for output labels.
virtual void	SetCoordinateSystem (int)
	Set/get the coordinate system used for output labels.
void	CoordinateSystemWorld ()
	Set/get the coordinate system used for output labels.
void	CoordinateSystemDisplay ()
	Set/get the coordinate system used for output labels.
virtual int	GetNumberOfLabels ()
	Return the number of labels rendered by the mapper.
void	GetLabelPosition (int label, double pos[3])
	Return the position of the requested label.
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.
int	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	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
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 int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual 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 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.
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.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) 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	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 void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	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.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Protected Member Functions
	vtkDynamic2DLabelMapper ()
	~vtkDynamic2DLabelMapper () override
double	GetCurrentScale (vtkViewport *viewport)
	Calculate the current zoom scale of the viewport.
Protected Member Functions inherited from vtkLabeledDataMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLabeledDataMapper ()
	~vtkLabeledDataMapper () override
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
void	AllocateLabels (int numLabels)
void	BuildLabels ()
void	BuildLabelsInternal (vtkDataSet *)
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
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 assocition 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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
float *	LabelWidth
float *	LabelHeight
float *	Cutoff
float	ReferenceScale
float	LabelHeightPadding
float	LabelWidthPadding
bool	ReversePriority
Protected Attributes inherited from vtkLabeledDataMapper
vtkDataSet *	Input
char *	LabelFormat
int	LabelMode
int	LabeledComponent
int	FieldDataArray
char *	FieldDataName
int	CoordinateSystem
char	ComponentSeparator
vtkTimeStamp	BuildTime
int	NumberOfLabels
int	NumberOfLabelsAllocated
vtkTextMapper **	TextMappers
double *	LabelPositions
vtkTransform *	Transform
Internals *	Implementation
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer
double	TimeToDraw
vtkWindow *	LastWindow
vtkPlaneCollection *	ClippingPlanes
Protected Attributes inherited from vtkAlgorithm
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
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkLabeledDataMapper	Superclass
	Instantiate object with %%-#6.3g label format.
static vtkDynamic2DLabelMapper *	New ()
	Instantiate object with %%-#6.3g label format.
static vtkTypeBool	IsTypeOf (const char *type)
	Instantiate object with %%-#6.3g label format.
static vtkDynamic2DLabelMapper *	SafeDownCast (vtkObjectBase *o)
	Instantiate object with %%-#6.3g label format.
virtual vtkTypeBool	IsA (const char *type)
	Instantiate object with %%-#6.3g label format.
vtkDynamic2DLabelMapper *	NewInstance () const
	Instantiate object with %%-#6.3g label format.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Instantiate object with %%-#6.3g label format.
virtual vtkObjectBase *	NewInstanceInternal () const
	Instantiate object with %%-#6.3g label format.

Additional Inherited Members
Public Types inherited from vtkLabeledDataMapper
enum	Coordinates { WORLD = 0 , DISPLAY = 1 }
	Coordinate systems that output dataset may use. More...
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
Static Public Member Functions inherited from vtkLabeledDataMapper
static vtkLabeledDataMapper *	New ()
	Instantiate object with %%-#6.3g label format.
static vtkTypeBool	IsTypeOf (const char *type)
static vtkLabeledDataMapper *	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 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 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 (int 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 int	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.
Public Attributes inherited from vtkAlgorithm
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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

draw text labels at 2D dataset points

vtkDynamic2DLabelMapper is a mapper that renders text at dataset points such that the labels do not overlap. Various items can be labeled including point ids, scalars, vectors, normals, texture coordinates, tensors, and field data components. This mapper assumes that the points are located on the x-y plane and that the camera remains perpendicular to that plane with a y-up axis (this can be constrained using vtkImageInteractor). On the first render, the mapper computes the visiblility of all labels at all scales, and queries this information on successive renders. This causes the first render to be much slower. The visibility algorithm is a greedy approach based on the point id, so the label for a point will be drawn unless the label for a point with lower id overlaps it.

Warning

Use this filter in combination with vtkSelectVisiblePoints if you want to label only points that are visible. If you want to label cells rather than points, use the filter vtkCellCenters to generate points at the center of the cells. Also, you can use the class vtkIdFilter to generate ids as scalars or field data, which can then be labeled.

See also

vtkLabeledDataMapper

Thanks:

This algorithm was developed in the paper Ken Been and Chee Yap. Dynamic Map Labeling. IEEE Transactions on Visualization and Computer Graphics, Vol. 12, No. 5, 2006. pp. 773-780.

Events:

vtkCommand::ProgressEvent

Examples:

vtkDynamic2DLabelMapper (Examples)

Tests:

vtkDynamic2DLabelMapper (Tests)

Definition at line 68 of file vtkDynamic2DLabelMapper.h.

Member Typedef Documentation

Superclass

typedef vtkLabeledDataMapper vtkDynamic2DLabelMapper::Superclass

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

Definition at line 77 of file vtkDynamic2DLabelMapper.h.

Constructor & Destructor Documentation

vtkDynamic2DLabelMapper()

vtkDynamic2DLabelMapper::vtkDynamic2DLabelMapper ( )

protected

~vtkDynamic2DLabelMapper()

vtkDynamic2DLabelMapper::~vtkDynamic2DLabelMapper ( )

overrideprotected

Member Function Documentation

New()

static vtkDynamic2DLabelMapper * vtkDynamic2DLabelMapper::New ( )

static

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

IsTypeOf()

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

static

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

IsA()

virtual vtkTypeBool vtkDynamic2DLabelMapper::IsA ( const char *  type )

virtual

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

Reimplemented from vtkLabeledDataMapper.

SafeDownCast()

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

static

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

NewInstanceInternal()

virtual vtkObjectBase * vtkDynamic2DLabelMapper::NewInstanceInternal ( ) const

protectedvirtual

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

Reimplemented from vtkLabeledDataMapper.

NewInstance()

vtkDynamic2DLabelMapper * vtkDynamic2DLabelMapper::NewInstance

(

)

const

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

PrintSelf()

void vtkDynamic2DLabelMapper::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Instantiate object with %%-#6.3g label format.

By default, point ids are labeled.

Reimplemented from vtkMapper2D.

SetPriorityArrayName()

void vtkDynamic2DLabelMapper::SetPriorityArrayName

(

const char *

name

)

Set the points array name to use to give priority to labels.

Defaults to "priority".

SetReversePriority()

virtual void vtkDynamic2DLabelMapper::SetReversePriority ( bool  )

virtual

Whether to reverse the priority order (i.e.

low values have high priority). Default is off.

GetReversePriority()

virtual bool vtkDynamic2DLabelMapper::GetReversePriority ( )

virtual

Whether to reverse the priority order (i.e.

low values have high priority). Default is off.

ReversePriorityOn()

virtual void vtkDynamic2DLabelMapper::ReversePriorityOn ( )

virtual

Whether to reverse the priority order (i.e.

low values have high priority). Default is off.

ReversePriorityOff()

virtual void vtkDynamic2DLabelMapper::ReversePriorityOff ( )

virtual

Whether to reverse the priority order (i.e.

low values have high priority). Default is off.

SetLabelHeightPadding()

virtual void vtkDynamic2DLabelMapper::SetLabelHeightPadding ( float  )

virtual

Set the label height padding as a percentage.

The percentage is a percentage of your label height. Default is 50%.

GetLabelHeightPadding()

virtual float vtkDynamic2DLabelMapper::GetLabelHeightPadding ( )

virtual

Set the label height padding as a percentage.

The percentage is a percentage of your label height. Default is 50%.

SetLabelWidthPadding()

virtual void vtkDynamic2DLabelMapper::SetLabelWidthPadding ( float  )

virtual

Set the label width padding as a percentage.

The percentage is a percentage of your label ^height^ (yes, not a typo). Default is 50%.

GetLabelWidthPadding()

virtual float vtkDynamic2DLabelMapper::GetLabelWidthPadding ( )

virtual

Set the label width padding as a percentage.

The percentage is a percentage of your label ^height^ (yes, not a typo). Default is 50%.

RenderOpaqueGeometry()

void vtkDynamic2DLabelMapper::RenderOpaqueGeometry ( vtkViewport *  viewport, vtkActor2D *  actor  )

overridevirtual

Draw non-overlapping labels to the screen.

Reimplemented from vtkMapper2D.

RenderOverlay()

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

overridevirtual

Draw non-overlapping labels to the screen.

Reimplemented from vtkMapper2D.

GetCurrentScale()

double vtkDynamic2DLabelMapper::GetCurrentScale ( vtkViewport *  viewport )

protected

Calculate the current zoom scale of the viewport.

Member Data Documentation

LabelWidth

float* vtkDynamic2DLabelMapper::LabelWidth

protected

Definition at line 134 of file vtkDynamic2DLabelMapper.h.

LabelHeight

float* vtkDynamic2DLabelMapper::LabelHeight

protected

Definition at line 135 of file vtkDynamic2DLabelMapper.h.

Cutoff

float* vtkDynamic2DLabelMapper::Cutoff

protected

Definition at line 136 of file vtkDynamic2DLabelMapper.h.

ReferenceScale

float vtkDynamic2DLabelMapper::ReferenceScale

protected

Definition at line 137 of file vtkDynamic2DLabelMapper.h.

LabelHeightPadding

float vtkDynamic2DLabelMapper::LabelHeightPadding

protected

Definition at line 138 of file vtkDynamic2DLabelMapper.h.

LabelWidthPadding

float vtkDynamic2DLabelMapper::LabelWidthPadding

protected

Definition at line 139 of file vtkDynamic2DLabelMapper.h.

ReversePriority

bool vtkDynamic2DLabelMapper::ReversePriority

protected

Definition at line 141 of file vtkDynamic2DLabelMapper.h.

---

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

• Rendering/Label/vtkDynamic2DLabelMapper.h