draw text labels at dataset points using batch rendering More...

#include <vtkBatchedLabeledDataMapper.h>

Inheritance diagram for vtkBatchedLabeledDataMapper:

Collaboration diagram for vtkBatchedLabeledDataMapper:

Public Types
typedef vtkLabeledDataMapper	Superclass


enum	TextAnchorTypes { LowerLeft = 0 , LowerRight = 1 , UpperLeft = 2 , UpperRight = 3 , LowerEdge = 4 , RightEdge = 5 , LeftEdge = 6 , UpperEdge = 7 , Center = 8 }
	Anchor option for labels. More...

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

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.

vtkBatchedLabeledDataMapper *	NewInstance () const

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

virtual void	SetFrameColorsName (const char *)
	Override TextProperty frame colors with a named, point-aligned color array.

virtual char *	GetFrameColorsName ()

vtkMTimeType	GetMTime () override
	Overridden to take into account LabelTextProperty's mtime.

void	RenderOpaqueGeometry (vtkViewport , vtkActor2D ) override
	No-op: backend subclasses override this to drive the render pipeline.

void	RenderOverlay (vtkViewport , vtkActor2D ) override
	No-op: all label drawing happens in RenderOpaqueGeometry.

void	ReleaseGraphicsResources (vtkWindow *) override
	Releases any GPU resources held by backend subclasses.


void	SetLabelTextProperty (vtkTextProperty *p) override
	Set/Get the text property.

vtkTextProperty *	GetLabelTextProperty () override
	Set/Get the text property.

void	SetLabelTextProperty (vtkTextProperty *p, int type) override
	Set/Get the text property.

vtkTextProperty *	GetLabelTextProperty (int type) override
	Set/Get the text property.


virtual void	SetTextAnchor (int)
	Set/Get the anchor point for label placement.

virtual int	GetTextAnchor ()
	Set/Get the anchor point for label placement.


virtual void	SetDisplayOffset (int, int)
	Set/Get a pixel offset applied to every label in display space.

void	SetDisplayOffset (int[2])
	Set/Get a pixel offset applied to every label in display space.

virtual int *	GetDisplayOffset ()
	Set/Get a pixel offset applied to every label in display space.

virtual void	GetDisplayOffset (int &, int &)
	Set/Get a pixel offset applied to every label in display space.

virtual void	GetDisplayOffset (int[2])
	Set/Get a pixel offset applied to every label in display space.

Public Member Functions inherited from vtkLabeledDataMapper
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 std::format or printf style format with which to print the labels.

virtual char *	GetLabelFormat ()
	Set/Get the std::format or printf style 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.

virtual void	SetFieldDataArray (int)
	Set/Get the field data array to label.

virtual int	GetFieldDataArray ()
	Set/Get the field data array to label.

virtual void	SetFieldDataName (const char *)
	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.

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
vtkMapper2D *	NewInstance () const

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

virtual void	RenderTranslucentPolygonalGeometry (vtkViewport , vtkActor2D )

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper *	NewInstance () const

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
vtkAlgorithm *	NewInstance () const

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

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

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

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

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

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

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

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

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

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

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

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

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

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

int	GetNumberOfInputArraySpecifications ()
	Get the number of input array indices that have already been set.

bool	ResetInputArraySpecifications ()
	Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).

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 bool	UpdateInformation ()
	Bring the algorithm's information up-to-date.

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

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

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

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

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

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

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
	Set the input data arrays that this algorithm will process.

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, const char *name, int component)
	This method variant also accepts a component to consider rather than the entire tuple.

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, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
	This method variant also accepts a component to consider rather than the entire tuple.

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

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName, const char *component)
	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 bool	Update (int port)
	Bring this algorithm's outputs up-to-date.

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

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

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

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

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

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

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

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

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

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

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Static Public Member Functions
static vtkBatchedLabeledDataMapper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkBatchedLabeledDataMapper *	SafeDownCast (vtkObjectBase *o)

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 vtkUnsignedCharArray *	GetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
	Returns the ghost array associated with the corresponding scalar mode, if present.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

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

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

static vtkInformationIntegerKey *	ABORTED ()

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

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

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

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

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

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

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

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

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

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

Static Public Attributes

static constexpr int	MaxTextProperties = 128
	Compile-time limits shared by the base class and both backend shaders.

static constexpr int	GlyphAtlasPadding = 5
	Compile-time limits shared by the base class and both backend shaders.

static constexpr int	GlyphAtlasColumnSize = 10
	Compile-time limits shared by the base class and both backend shaders.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBatchedLabeledDataMapper ()

	~vtkBatchedLabeledDataMapper () override

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

void	AllocateLabels (int numLabels) override
	Tracks the high-water mark of labels seen so far; no per-label allocation is needed.

void	BuildLabels () override
	Calls the superclass pipeline, then refreshes text-property attribute arrays.

void	BuildLabelsInternal (vtkDataSet *) override
	Formats labels for one dataset and populates the glyph atlas and shader arrays.

void	MakeShaderArrays (int numCurLabels, const std::vector< std::string > &, vtkIntArray , vtkFloatArray , const std::vector< bool > &visible)
	Converts formatted label strings into per-glyph vertex attributes (glyph extents, character offsets, point IDs, property IDs, frame colors) and appends them to the internal polydata.

virtual void	UploadGlyphAtlas (vtkImageData *atlas)
	Called by BuildLabels when the glyph atlas image has been rebuilt or updated.

virtual void	ActivateGlyphTexture ()
	Called before and after the helper renders to bind/unbind the atlas texture.

virtual void	DeactivateGlyphTexture ()

void	UpdateRenderWindowDPI (int dpi)
	Called by backend subclasses from RenderOpaqueGeometry to propagate the render window DPI before BuildLabels.


vtkImageData *	GetGlyphAtlas () const
	Accessors for backend helper use in SetMapperShaderParameters.

vtkPolyData *	GetPreparedPolyData () const
	Accessors for backend helper use in SetMapperShaderParameters.

const float *	GetBackgroundColors () const
	Accessors for backend helper use in SetMapperShaderParameters.

const int *	GetFrameWidths () const
	Accessors for backend helper use in SetMapperShaderParameters.

const int *	GetMaxGlyphHeights () const
	Accessors for backend helper use in SetMapperShaderParameters.

const int *	GetDescenders () const
	Accessors for backend helper use in SetMapperShaderParameters.

Protected Member Functions inherited from vtkLabeledDataMapper
	vtkLabeledDataMapper ()

	~vtkLabeledDataMapper () override

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

vtkLabeledFormatterInput	ResolveLabeledFormatterInput (vtkDataSetAttributes pd, int numItems, vtkDataObject inputObj)
	Resolve which data to label and build the format string.

Protected Member Functions inherited from vtkMapper2D
	vtkMapper2D ()=default

	~vtkMapper2D () override=default

Protected Member Functions inherited from vtkAbstractMapper
	vtkAbstractMapper ()

	~vtkAbstractMapper () override

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

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

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

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

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

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

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

int	GetInputArrayComponent (int idx)
	Get the component to process 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.

vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.

vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.

template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType >	GetInputArrayAs (Params &&... params)
	Get an array from the input at index idx.

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

std::vector< vtkSmartPointer< vtkTextMapper > >	TextMappers

std::vector< double >	LabelPositions

vtkTransform *	Transform

std::unique_ptr< Internals >	Implementation

Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer

double	TimeToDraw

vtkWindow *	LastWindow

vtkPlaneCollection *	ClippingPlanes

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

draw text labels at dataset points using batch rendering

vtkBatchedLabeledDataMapper is a mapper that renders text at dataset points. It inherits the full API of vtkLabeledDataMapper (coordinate systems, transform, label mode, text properties) but replaces the one-draw-call-per-label rendering with a glyph atlas batch approach so that all labels are drawn in a single pass.

This is an abstract base class. Use a backend-specific subclass such as vtkOpenGLBatchedLabeledDataMapper to perform actual rendering.

See also: vtkLabeledDataMapper vtkOpenGLBatchedLabeledDataMapper vtkWebGPUBatchedLabeledDataMapper

Tests:: vtkBatchedLabeledDataMapper (Tests)

Definition at line 43 of file vtkBatchedLabeledDataMapper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkLabeledDataMapper vtkBatchedLabeledDataMapper::Superclass

Definition at line 48 of file vtkBatchedLabeledDataMapper.h.

Member Enumeration Documentation

◆ TextAnchorTypes

enum vtkBatchedLabeledDataMapper::TextAnchorTypes

Anchor option for labels.

Default is Center.

Enumerator
LowerLeft	Uses the lower left corner.
LowerRight	Uses the lower right corner.
UpperLeft	Uses the upper left corner.
UpperRight	Uses the upper right corner.
LowerEdge	Uses the lower edge center.
RightEdge	Uses the right edge center.
LeftEdge	Uses the left edge center.
UpperEdge	Uses the upper edge center.
Center	Uses the exact center.

Definition at line 86 of file vtkBatchedLabeledDataMapper.h.

Constructor & Destructor Documentation

◆ vtkBatchedLabeledDataMapper()

vtkBatchedLabeledDataMapper::vtkBatchedLabeledDataMapper ( )

protected

◆ ~vtkBatchedLabeledDataMapper()

vtkBatchedLabeledDataMapper::~vtkBatchedLabeledDataMapper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkBatchedLabeledDataMapper * vtkBatchedLabeledDataMapper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkBatchedLabeledDataMapper::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 vtkLabeledDataMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBatchedLabeledDataMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkLabeledDataMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ NewInstance()

vtkBatchedLabeledDataMapper * vtkBatchedLabeledDataMapper::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ SetLabelTextProperty() [1/2]

void vtkBatchedLabeledDataMapper::SetLabelTextProperty ( vtkTextProperty * p )

inlineoverridevirtual

Set/Get the text property.

An integer type argument selects among multiple properties for different label types driven by an optional type input array. Overridden to maintain the glyph atlas cache.

Reimplemented from vtkLabeledDataMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

Definition at line 70 of file vtkBatchedLabeledDataMapper.h.

◆ GetLabelTextProperty() [1/2]

vtkTextProperty * vtkBatchedLabeledDataMapper::GetLabelTextProperty ( )

inlineoverridevirtual

Set/Get the text property.

An integer type argument selects among multiple properties for different label types driven by an optional type input array. Overridden to maintain the glyph atlas cache.

Reimplemented from vtkLabeledDataMapper.

Definition at line 71 of file vtkBatchedLabeledDataMapper.h.

◆ SetLabelTextProperty() [2/2]

void vtkBatchedLabeledDataMapper::SetLabelTextProperty	(	vtkTextProperty *	p,
		int	type )

overridevirtual

Set/Get the text property.

An integer type argument selects among multiple properties for different label types driven by an optional type input array. Overridden to maintain the glyph atlas cache.

Reimplemented from vtkLabeledDataMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ GetLabelTextProperty() [2/2]

vtkTextProperty * vtkBatchedLabeledDataMapper::GetLabelTextProperty ( int type )

overridevirtual

Set/Get the text property.

An integer type argument selects among multiple properties for different label types driven by an optional type input array. Overridden to maintain the glyph atlas cache.

Reimplemented from vtkLabeledDataMapper.

◆ SetFrameColorsName()

virtual void vtkBatchedLabeledDataMapper::SetFrameColorsName ( const char * )

virtual

Override TextProperty frame colors with a named, point-aligned color array.

◆ GetFrameColorsName()

virtual char * vtkBatchedLabeledDataMapper::GetFrameColorsName ( )

virtual

◆ SetTextAnchor()

virtual void vtkBatchedLabeledDataMapper::SetTextAnchor ( int )

virtual

Set/Get the anchor point for label placement.

See also: TextAnchor

◆ GetTextAnchor()

virtual int vtkBatchedLabeledDataMapper::GetTextAnchor ( )

virtual

Set/Get the anchor point for label placement.

See also: TextAnchor

◆ SetDisplayOffset() [1/2]

virtual void vtkBatchedLabeledDataMapper::SetDisplayOffset	(	int	,
		int	)

virtual

Set/Get a pixel offset applied to every label in display space.

Useful to nudge labels away from their anchor point. Default is [0, 0].

◆ SetDisplayOffset() [2/2]

void vtkBatchedLabeledDataMapper::SetDisplayOffset ( int [2] )

Set/Get a pixel offset applied to every label in display space.

Useful to nudge labels away from their anchor point. Default is [0, 0].

◆ GetDisplayOffset() [1/3]

virtual int * vtkBatchedLabeledDataMapper::GetDisplayOffset ( )

virtual

Set/Get a pixel offset applied to every label in display space.

Useful to nudge labels away from their anchor point. Default is [0, 0].

◆ GetDisplayOffset() [2/3]

virtual void vtkBatchedLabeledDataMapper::GetDisplayOffset	(	int &	,
		int &	)

virtual

Set/Get a pixel offset applied to every label in display space.

Useful to nudge labels away from their anchor point. Default is [0, 0].

◆ GetDisplayOffset() [3/3]

virtual void vtkBatchedLabeledDataMapper::GetDisplayOffset ( int [2] )

virtual

Set/Get a pixel offset applied to every label in display space.

Useful to nudge labels away from their anchor point. Default is [0, 0].

◆ GetMTime()

vtkMTimeType vtkBatchedLabeledDataMapper::GetMTime ( )

overridevirtual

Overridden to take into account LabelTextProperty's mtime.

Reimplemented from vtkAbstractMapper.

◆ RenderOpaqueGeometry()

void vtkBatchedLabeledDataMapper::RenderOpaqueGeometry	(	vtkViewport *	,
		vtkActor2D *	)

inlineoverridevirtual

No-op: backend subclasses override this to drive the render pipeline.

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

Definition at line 125 of file vtkBatchedLabeledDataMapper.h.

◆ RenderOverlay()

void vtkBatchedLabeledDataMapper::RenderOverlay	(	vtkViewport *	,
		vtkActor2D *	)

inlineoverridevirtual

No-op: all label drawing happens in RenderOpaqueGeometry.

Reimplemented from vtkMapper2D.

Definition at line 127 of file vtkBatchedLabeledDataMapper.h.

◆ ReleaseGraphicsResources()

void vtkBatchedLabeledDataMapper::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Releases any GPU resources held by backend subclasses.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ FillInputPortInformation()

int vtkBatchedLabeledDataMapper::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 vtkAlgorithm.

◆ AllocateLabels()

void vtkBatchedLabeledDataMapper::AllocateLabels ( int numLabels )

overrideprotectedvirtual

Tracks the high-water mark of labels seen so far; no per-label allocation is needed.

Reimplemented from vtkLabeledDataMapper.

◆ BuildLabels()

void vtkBatchedLabeledDataMapper::BuildLabels ( )

overrideprotectedvirtual

Calls the superclass pipeline, then refreshes text-property attribute arrays.

Reimplemented from vtkLabeledDataMapper.

◆ BuildLabelsInternal()

void vtkBatchedLabeledDataMapper::BuildLabelsInternal ( vtkDataSet * )

overrideprotectedvirtual

Formats labels for one dataset and populates the glyph atlas and shader arrays.

Reimplemented from vtkLabeledDataMapper.

◆ MakeShaderArrays()

void vtkBatchedLabeledDataMapper::MakeShaderArrays	(	int	numCurLabels,
		const std::vector< std::string > &	,
		vtkIntArray *	,
		vtkFloatArray *	,
		const std::vector< bool > &	visible )

protected

Converts formatted label strings into per-glyph vertex attributes (glyph extents, character offsets, point IDs, property IDs, frame colors) and appends them to the internal polydata.

Only glyphs whose visible entry is true are emitted.

◆ UploadGlyphAtlas()

virtual void vtkBatchedLabeledDataMapper::UploadGlyphAtlas ( vtkImageData * atlas )

protectedvirtual

Called by BuildLabels when the glyph atlas image has been rebuilt or updated.

Backend subclasses must upload the image to the GPU.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper.

◆ ActivateGlyphTexture()

virtual void vtkBatchedLabeledDataMapper::ActivateGlyphTexture ( )

protectedvirtual

Called before and after the helper renders to bind/unbind the atlas texture.

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.

◆ DeactivateGlyphTexture()

virtual void vtkBatchedLabeledDataMapper::DeactivateGlyphTexture ( )

protectedvirtual

Reimplemented in vtkOpenGLBatchedLabeledDataMapper, and vtkWebGPUBatchedLabeledDataMapper.