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

draw text labels at dataset points More...

#include <vtkLabeledDataMapper.h>

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

Public Types

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. More...
 
vtkLabeledDataMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetLabelFormat (const char *)
 Set/Get the format with which to print the labels. More...
 
virtual char * GetLabelFormat ()
 
virtual void SetLabeledComponent (int)
 Set/Get the component number to label if the data to print has more than one component. More...
 
virtual int GetLabeledComponent ()
 
virtual void SetComponentSeparator (char)
 Set/Get the separator between components. More...
 
virtual char GetComponentSeparator ()
 
void SetFieldDataArray (int arrayIndex)
 Set/Get the field data array to label. More...
 
virtual int GetFieldDataArray ()
 
void SetFieldDataName (const char *arrayName)
 Set/Get the name of the field data array to label. More...
 
virtual char * GetFieldDataName ()
 
virtual void SetInputData (vtkDataObject *)
 Set the input dataset to the mapper. More...
 
vtkDataSetGetInput ()
 Use GetInputDataObject() to get the input data object for composite datasets. More...
 
virtual void SetLabelMode (int)
 Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data. More...
 
virtual int GetLabelMode ()
 
void SetLabelModeToLabelIds ()
 
void SetLabelModeToLabelScalars ()
 
void SetLabelModeToLabelVectors ()
 
void SetLabelModeToLabelNormals ()
 
void SetLabelModeToLabelTCoords ()
 
void SetLabelModeToLabelTensors ()
 
void SetLabelModeToLabelFieldData ()
 
virtual void SetLabelTextProperty (vtkTextProperty *p)
 Set/Get the text property. More...
 
virtual vtkTextPropertyGetLabelTextProperty ()
 
virtual void SetLabelTextProperty (vtkTextProperty *p, int type)
 
virtual vtkTextPropertyGetLabelTextProperty (int type)
 
void RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor) override
 Draw the text to the screen at each input point. More...
 
void RenderOverlay (vtkViewport *viewport, vtkActor2D *actor) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
virtual vtkTransformGetTransform ()
 The transform to apply to the labels before mapping to 2D. More...
 
void SetTransform (vtkTransform *t)
 
virtual int GetCoordinateSystem ()
 Set/get the coordinate system used for output labels. More...
 
virtual void SetCoordinateSystem (int)
 
void CoordinateSystemWorld ()
 
void CoordinateSystemDisplay ()
 
vtkMTimeType GetMTime () override
 Return the modified time for this object. More...
 
virtual int GetNumberOfLabels ()
 Return the number of labels rendered by the mapper. More...
 
void GetLabelPosition (int label, double pos[3])
 Return the position of the requested label. More...
 
const char * GetLabelText (int label)
 Return the text for the requested label. More...
 
- Public Member Functions inherited from vtkMapper2D
vtkMapper2DNewInstance () const
 
virtual void RenderTranslucentPolygonalGeometry (vtkViewport *, vtkActor2D *)
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. More...
 
void AddClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
void RemoveClippingPlane (vtkPlane *plane)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
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. More...
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkLabeledDataMapperNew ()
 Instantiate object with %%-#6.3g label format. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLabeledDataMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkMapper2D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMapper2DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars. More...
 
static vtkAbstractArrayGetAbstractScalars (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. More...
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLabeledDataMapper ()
 
 ~vtkLabeledDataMapper () override
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
void AllocateLabels (int numLabels)
 
void BuildLabels ()
 
void BuildLabelsInternal (vtkDataSet *)
 
- Protected Member Functions inherited from vtkMapper2D
 vtkMapper2D ()
 
 ~vtkMapper2D () override
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataSetInput
 
char * LabelFormat
 
int LabelMode
 
int LabeledComponent
 
int FieldDataArray
 
char * FieldDataName
 
int CoordinateSystem
 
char ComponentSeparator
 
vtkTimeStamp BuildTime
 
int NumberOfLabels
 
int NumberOfLabelsAllocated
 
vtkTextMapper ** TextMappers
 
doubleLabelPositions
 
vtkTransformTransform
 
Internals * Implementation
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

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

Detailed Description

draw text labels at dataset points

vtkLabeledDataMapper is a mapper that renders text at dataset points. Various items can be labeled including point ids, scalars, vectors, normals, texture coordinates, tensors, and field data components.

The format with which the label is drawn is specified using a printf style format string. The font attributes of the text can be set through the vtkTextProperty associated to this mapper.

By default, all the components of multi-component data such as vectors, normals, texture coordinates, tensors, and multi-component scalars are labeled. However, you can specify a single component if you prefer. (Note: the label format specifies the format to use for a single component. The label is creating by looping over all components and using the label format to render each component.) The character separator between components can be set. By default, it is set to a single whitespace.

Warning
Use this filter in combination with vtkSelectVisiblePoints if you want to label only points that are visible. If you want to label cells rather than points, use the filter vtkCellCenters to generate points at the center of the cells. Also, you can use the class vtkIdFilter to generate ids as scalars or field data, which can then be labeled.
See also
vtkMapper2D vtkActor2D vtkTextMapper vtkTextProperty vtkSelectVisiblePoints vtkIdFilter vtkCellCenters
Examples:
vtkLabeledDataMapper (Examples)
Tests:
vtkLabeledDataMapper (Tests)

Definition at line 76 of file vtkLabeledDataMapper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 85 of file vtkLabeledDataMapper.h.

Member Enumeration Documentation

◆ Coordinates

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 212 of file vtkLabeledDataMapper.h.

Constructor & Destructor Documentation

◆ vtkLabeledDataMapper()

vtkLabeledDataMapper::vtkLabeledDataMapper ( )
protected

◆ ~vtkLabeledDataMapper()

vtkLabeledDataMapper::~vtkLabeledDataMapper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLabeledDataMapper* vtkLabeledDataMapper::New ( )
static

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

By default, point ids are labeled.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLabeledDataMapper::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkDynamic2DLabelMapper, vtkQtTreeRingLabelMapper, and vtkLabeledTreeMapDataMapper.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLabeledDataMapper::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkLabeledDataMapper* vtkLabeledDataMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkLabeledDataMapper::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 vtkMapper2D.

Reimplemented in vtkQtTreeRingLabelMapper, and vtkLabeledTreeMapDataMapper.

◆ SetLabelFormat()

virtual void vtkLabeledDataMapper::SetLabelFormat ( const char *  )
virtual

Set/Get the format with which to print the labels.

This should be a printf-style format string.

By default, the mapper will try to print each component of the tuple using a sane format: d for integers, f for floats, g for doubles, ld for longs, et cetera. If you need a different format, set it here. You can do things like limit the number of significant digits, add prefixes/suffixes, basically anything that printf can do. If you only want to print one component of a vector, see the ivar LabeledComponent.

◆ GetLabelFormat()

virtual char* vtkLabeledDataMapper::GetLabelFormat ( )
virtual

◆ SetLabeledComponent()

virtual void vtkLabeledDataMapper::SetLabeledComponent ( int  )
virtual

Set/Get the component number to label if the data to print has more than one component.

For example, all the components of scalars, vectors, normals, etc. are labeled by default (LabeledComponent=(-1)). However, if this ivar is nonnegative, then only the one component specified is labeled.

◆ GetLabeledComponent()

virtual int vtkLabeledDataMapper::GetLabeledComponent ( )
virtual

◆ SetComponentSeparator()

virtual void vtkLabeledDataMapper::SetComponentSeparator ( char  )
virtual

Set/Get the separator between components.

◆ GetComponentSeparator()

virtual char vtkLabeledDataMapper::GetComponentSeparator ( )
virtual

◆ SetFieldDataArray()

void vtkLabeledDataMapper::SetFieldDataArray ( int  arrayIndex)

Set/Get the field data array to label.

This instance variable is only applicable if field data is labeled. This will clear FieldDataName when set.

◆ GetFieldDataArray()

virtual int vtkLabeledDataMapper::GetFieldDataArray ( )
virtual

◆ SetFieldDataName()

void vtkLabeledDataMapper::SetFieldDataName ( const char *  arrayName)

Set/Get the name of the field data array to label.

This instance variable is only applicable if field data is labeled. This will override FieldDataArray when set.

◆ GetFieldDataName()

virtual char* vtkLabeledDataMapper::GetFieldDataName ( )
virtual

◆ SetInputData()

virtual void vtkLabeledDataMapper::SetInputData ( vtkDataObject )
virtual

Set the input dataset to the mapper.

This mapper handles any type of data.

◆ GetInput()

vtkDataSet* vtkLabeledDataMapper::GetInput ( )

Use GetInputDataObject() to get the input data object for composite datasets.

◆ SetLabelMode()

virtual void vtkLabeledDataMapper::SetLabelMode ( int  )
virtual

Specify which data to plot: IDs, scalars, vectors, normals, texture coords, tensors, or field data.

If the data has more than one component, use the method SetLabeledComponent to control which components to plot. The default is VTK_LABEL_IDS.

◆ GetLabelMode()

virtual int vtkLabeledDataMapper::GetLabelMode ( )
virtual

◆ SetLabelModeToLabelIds()

void vtkLabeledDataMapper::SetLabelModeToLabelIds ( )
inline

Definition at line 165 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelScalars()

void vtkLabeledDataMapper::SetLabelModeToLabelScalars ( )
inline

Definition at line 166 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelVectors()

void vtkLabeledDataMapper::SetLabelModeToLabelVectors ( )
inline

Definition at line 167 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelNormals()

void vtkLabeledDataMapper::SetLabelModeToLabelNormals ( )
inline

Definition at line 168 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelTCoords()

void vtkLabeledDataMapper::SetLabelModeToLabelTCoords ( )
inline

Definition at line 169 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelTensors()

void vtkLabeledDataMapper::SetLabelModeToLabelTensors ( )
inline

Definition at line 170 of file vtkLabeledDataMapper.h.

◆ SetLabelModeToLabelFieldData()

void vtkLabeledDataMapper::SetLabelModeToLabelFieldData ( )
inline

Definition at line 171 of file vtkLabeledDataMapper.h.

◆ SetLabelTextProperty() [1/2]

virtual void vtkLabeledDataMapper::SetLabelTextProperty ( vtkTextProperty p)
inlinevirtual

Set/Get the text property.

If an integer argument is provided, you may provide different text properties for different label types. The type is determined by an optional type input array.

Reimplemented in vtkQtTreeRingLabelMapper.

Definition at line 182 of file vtkLabeledDataMapper.h.

◆ GetLabelTextProperty() [1/2]

virtual vtkTextProperty* vtkLabeledDataMapper::GetLabelTextProperty ( )
inlinevirtual

Reimplemented in vtkQtTreeRingLabelMapper.

Definition at line 184 of file vtkLabeledDataMapper.h.

◆ SetLabelTextProperty() [2/2]

virtual void vtkLabeledDataMapper::SetLabelTextProperty ( vtkTextProperty p,
int  type 
)
virtual

Reimplemented in vtkQtTreeRingLabelMapper.

◆ GetLabelTextProperty() [2/2]

virtual vtkTextProperty* vtkLabeledDataMapper::GetLabelTextProperty ( int  type)
virtual

Reimplemented in vtkQtTreeRingLabelMapper.

◆ RenderOpaqueGeometry()

void vtkLabeledDataMapper::RenderOpaqueGeometry ( vtkViewport viewport,
vtkActor2D actor 
)
overridevirtual

Draw the text to the screen at each input point.

Reimplemented from vtkMapper2D.

Reimplemented in vtkQtTreeRingLabelMapper, and vtkLabeledTreeMapDataMapper.

◆ RenderOverlay()

void vtkLabeledDataMapper::RenderOverlay ( vtkViewport viewport,
vtkActor2D actor 
)
overridevirtual

Reimplemented from vtkMapper2D.

Reimplemented in vtkQtTreeRingLabelMapper, and vtkLabeledTreeMapDataMapper.

◆ ReleaseGraphicsResources()

void vtkLabeledDataMapper::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Release any graphics resources that are being consumed by this actor.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkLabeledTreeMapDataMapper.

◆ GetTransform()

virtual vtkTransform* vtkLabeledDataMapper::GetTransform ( )
virtual

The transform to apply to the labels before mapping to 2D.

◆ SetTransform()

void vtkLabeledDataMapper::SetTransform ( vtkTransform t)

◆ GetCoordinateSystem()

virtual int vtkLabeledDataMapper::GetCoordinateSystem ( )
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.

◆ SetCoordinateSystem()

virtual void vtkLabeledDataMapper::SetCoordinateSystem ( int  )
virtual

◆ CoordinateSystemWorld()

void vtkLabeledDataMapper::CoordinateSystemWorld ( )
inline

Definition at line 225 of file vtkLabeledDataMapper.h.

◆ CoordinateSystemDisplay()

void vtkLabeledDataMapper::CoordinateSystemDisplay ( )
inline

Definition at line 226 of file vtkLabeledDataMapper.h.

◆ GetMTime()

vtkMTimeType vtkLabeledDataMapper::GetMTime ( )
overridevirtual

Return the modified time for this object.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkQtTreeRingLabelMapper.

◆ GetNumberOfLabels()

virtual int vtkLabeledDataMapper::GetNumberOfLabels ( )
virtual

Return the number of labels rendered by the mapper.

◆ GetLabelPosition()

void vtkLabeledDataMapper::GetLabelPosition ( int  label,
double  pos[3] 
)
inline

Return the position of the requested label.

Definition at line 245 of file vtkLabeledDataMapper.h.

◆ GetLabelText()

const char* vtkLabeledDataMapper::GetLabelText ( int  label)

Return the text for the requested label.

◆ FillInputPortInformation()

int vtkLabeledDataMapper::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 vtkLabeledDataMapper::AllocateLabels ( int  numLabels)
protected

◆ BuildLabels()

void vtkLabeledDataMapper::BuildLabels ( )
protected

◆ BuildLabelsInternal()

void vtkLabeledDataMapper::BuildLabelsInternal ( vtkDataSet )
protected

Member Data Documentation

◆ Input

vtkDataSet* vtkLabeledDataMapper::Input
protected

Definition at line 263 of file vtkLabeledDataMapper.h.

◆ LabelFormat

char* vtkLabeledDataMapper::LabelFormat
protected

Definition at line 265 of file vtkLabeledDataMapper.h.

◆ LabelMode

int vtkLabeledDataMapper::LabelMode
protected

Definition at line 266 of file vtkLabeledDataMapper.h.

◆ LabeledComponent

int vtkLabeledDataMapper::LabeledComponent
protected

Definition at line 267 of file vtkLabeledDataMapper.h.

◆ FieldDataArray

int vtkLabeledDataMapper::FieldDataArray
protected

Definition at line 268 of file vtkLabeledDataMapper.h.

◆ FieldDataName

char* vtkLabeledDataMapper::FieldDataName
protected

Definition at line 269 of file vtkLabeledDataMapper.h.

◆ CoordinateSystem

int vtkLabeledDataMapper::CoordinateSystem
protected

Definition at line 270 of file vtkLabeledDataMapper.h.

◆ ComponentSeparator

char vtkLabeledDataMapper::ComponentSeparator
protected

Definition at line 272 of file vtkLabeledDataMapper.h.

◆ BuildTime

vtkTimeStamp vtkLabeledDataMapper::BuildTime
protected

Definition at line 274 of file vtkLabeledDataMapper.h.

◆ NumberOfLabels

int vtkLabeledDataMapper::NumberOfLabels
protected

Definition at line 276 of file vtkLabeledDataMapper.h.

◆ NumberOfLabelsAllocated

int vtkLabeledDataMapper::NumberOfLabelsAllocated
protected

Definition at line 277 of file vtkLabeledDataMapper.h.

◆ TextMappers

vtkTextMapper** vtkLabeledDataMapper::TextMappers
protected

Definition at line 278 of file vtkLabeledDataMapper.h.

◆ LabelPositions

double* vtkLabeledDataMapper::LabelPositions
protected

Definition at line 279 of file vtkLabeledDataMapper.h.

◆ Transform

vtkTransform* vtkLabeledDataMapper::Transform
protected

Definition at line 280 of file vtkLabeledDataMapper.h.

◆ Implementation

Internals* vtkLabeledDataMapper::Implementation
protected

Definition at line 288 of file vtkLabeledDataMapper.h.


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