vtkLabelPlacer Class Reference

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

#include <vtkLabelPlacer.h>

Inheritance diagram for vtkLabelPlacer:

Collaboration diagram for vtkLabelPlacer:

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.
vtkLabelPlacer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkRenderer *	GetRenderer ()
virtual void	SetRenderer (vtkRenderer *)
virtual vtkCoordinate *	GetAnchorTransform ()
vtkMTimeType	GetMTime () override
	Return this object's modified time.
virtual void	SetGravity (int gravity)
	The placement of the label relative to the anchor point.
virtual int	GetGravity ()
	The placement of the label relative to the anchor point.
virtual void	SetMaximumLabelFraction (double)
	The maximum amount of screen space labels can take up before placement terminates.
virtual double	GetMaximumLabelFraction ()
	The maximum amount of screen space labels can take up before placement terminates.
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 void	SetUseUnicodeStrings (bool)
	Set whether, or not, to use unicode strings.
virtual bool	GetUseUnicodeStrings ()
	Set whether, or not, to use unicode strings.
virtual void	UseUnicodeStringsOn ()
	Set whether, or not, to use unicode strings.
virtual void	UseUnicodeStringsOff ()
	Set whether, or not, to use unicode strings.
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 bool	GetOutputTraversedBounds ()
	In the second output, output the geometry of the traversed octree nodes.
virtual void	SetOutputTraversedBounds (bool)
	In the second output, output the geometry of the traversed octree nodes.
virtual void	OutputTraversedBoundsOn ()
	In the second output, output the geometry of the traversed octree nodes.
virtual void	OutputTraversedBoundsOff ()
	In the second output, output the geometry of the traversed octree nodes.
virtual int	GetOutputCoordinateSystem ()
	Set/get the coordinate system used for output labels.
virtual void	SetOutputCoordinateSystem (int)
	Set/get the coordinate system used for output labels.
void	OutputCoordinateSystemWorld ()
	Set/get the coordinate system used for output labels.
void	OutputCoordinateSystemDisplay ()
	Set/get the coordinate system used for output labels.
Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPolyDataAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
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.

Static Public Member Functions
static vtkLabelPlacer *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkLabelPlacer *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLabelPlacer ()
	~vtkLabelPlacer () override
virtual void	SetAnchorTransform (vtkCoordinate *)
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	This is called by the superclass.
Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
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
Internal *	Buckets
vtkRenderer *	Renderer
vtkCoordinate *	AnchorTransform
vtkSelectVisiblePoints *	VisiblePoints
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
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

Additional Inherited Members
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

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

typedef vtkPolyDataAlgorithm vtkLabelPlacer::Superclass

Definition at line 56 of file vtkLabelPlacer.h.

Member Enumeration Documentation

LabelGravity

enum vtkLabelPlacer::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

enum vtkLabelPlacer::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

The placement of the label relative to the anchor point.

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

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

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

The type of iterator used when traversing the labels.

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

SetUseUnicodeStrings()

virtual void vtkLabelPlacer::SetUseUnicodeStrings ( bool  )

virtual

Set whether, or not, to use unicode strings.

GetUseUnicodeStrings()

virtual bool vtkLabelPlacer::GetUseUnicodeStrings ( )

virtual

Set whether, or not, to use unicode strings.

UseUnicodeStringsOn()

virtual void vtkLabelPlacer::UseUnicodeStringsOn ( )

virtual

Set whether, or not, to use unicode strings.

UseUnicodeStringsOff()

virtual void vtkLabelPlacer::UseUnicodeStringsOff ( )

virtual

Set whether, or not, to use unicode strings.

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

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 vtkLabelPlacer::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 vtkLabelPlacer::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 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

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

GeneratePerturbedLabelSpokesOn()

virtual void vtkLabelPlacer::GeneratePerturbedLabelSpokesOn ( )

virtual

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

GeneratePerturbedLabelSpokesOff()

virtual void vtkLabelPlacer::GeneratePerturbedLabelSpokesOff ( )

virtual

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

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

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

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

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

OutputTraversedBoundsOn()

virtual void vtkLabelPlacer::OutputTraversedBoundsOn ( )

virtual

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

OutputTraversedBoundsOff()

virtual void vtkLabelPlacer::OutputTraversedBoundsOff ( )

virtual

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

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

Set/get the coordinate system used for output labels.

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

OutputCoordinateSystemWorld()

void vtkLabelPlacer::OutputCoordinateSystemWorld ( )

inline

Set/get the coordinate system used for output labels.

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

Definition at line 193 of file vtkLabelPlacer.h.

OutputCoordinateSystemDisplay()

void vtkLabelPlacer::OutputCoordinateSystemDisplay ( )

inline

Set/get the coordinate system used for output labels.

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

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 208 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:

• Rendering/Label/vtkLabelPlacer.h