VTK
9.1.0
|
An actor that displays text. More...
#include <vtkTextActor.h>
Public Types | |
enum | { TEXT_SCALE_MODE_NONE = 0 , TEXT_SCALE_MODE_PROP , TEXT_SCALE_MODE_VIEWPORT } |
typedef vtkTexturedActor2D | Superclass |
Public Types inherited from vtkTexturedActor2D | |
typedef vtkActor2D | Superclass |
Public Types inherited from vtkActor2D | |
typedef vtkProp | Superclass |
Public Types inherited from vtkProp | |
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. | |
vtkTextActor * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this text actor. | |
virtual void | GetBoundingBox (vtkViewport *vport, double bbox[4]) |
Return the bounding box coordinates of the text in pixels. | |
virtual void | GetSize (vtkViewport *vport, double size[2]) |
Syntactic sugar to get the size of text instead of the entire bounding box. | |
virtual void | SetNonLinearFontScale (double exponent, int target) |
Enable non-linear scaling of font sizes. | |
void | SpecifiedToDisplay (double *pos, vtkViewport *vport, int specified) |
This is just a simple coordinate conversion method used in the render process. | |
void | DisplayToSpecified (double *pos, vtkViewport *vport, int specified) |
This is just a simple coordinate conversion method used in the render process. | |
virtual void | ComputeScaledFont (vtkViewport *viewport) |
Compute the scale the font should be given the viewport. | |
void | ReleaseGraphicsResources (vtkWindow *) override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
vtkTypeBool | HasTranslucentPolygonalGeometry () override |
Does this prop have some translucent polygonal geometry? | |
void | SetInput (const char *inputString) |
Set the text string to be displayed. | |
char * | GetInput () |
Set the text string to be displayed. | |
virtual void | SetMinimumSize (int, int) |
Set/Get the minimum size in pixels for this actor. | |
void | SetMinimumSize (int[2]) |
Set/Get the minimum size in pixels for this actor. | |
virtual int * | GetMinimumSize () |
Set/Get the minimum size in pixels for this actor. | |
virtual void | GetMinimumSize (int &, int &) |
Set/Get the minimum size in pixels for this actor. | |
virtual void | GetMinimumSize (int[2]) |
Set/Get the minimum size in pixels for this actor. | |
virtual void | SetMaximumLineHeight (float) |
Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. | |
virtual float | GetMaximumLineHeight () |
Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. | |
virtual void | SetTextScaleMode (int) |
Set how text should be scaled. | |
virtual int | GetTextScaleMode () |
Set how text should be scaled. | |
void | SetTextScaleModeToNone () |
Set how text should be scaled. | |
void | SetTextScaleModeToProp () |
Set how text should be scaled. | |
void | SetTextScaleModeToViewport () |
Set how text should be scaled. | |
virtual void | SetUseBorderAlign (vtkTypeBool) |
Turn on or off the UseBorderAlign option. | |
virtual vtkTypeBool | GetUseBorderAlign () |
Turn on or off the UseBorderAlign option. | |
virtual void | UseBorderAlignOn () |
Turn on or off the UseBorderAlign option. | |
virtual void | UseBorderAlignOff () |
Turn on or off the UseBorderAlign option. | |
void | SetAlignmentPoint (int point) |
This method is being deprecated. | |
int | GetAlignmentPoint () |
This method is being deprecated. | |
void | SetOrientation (float orientation) |
Counterclockwise rotation around the Alignment point. | |
virtual float | GetOrientation () |
Counterclockwise rotation around the Alignment point. | |
virtual void | SetTextProperty (vtkTextProperty *p) |
Set/Get the text property. | |
virtual vtkTextProperty * | GetTextProperty () |
Set/Get the text property. | |
virtual vtkTextProperty * | GetScaledTextProperty () |
Get the scaled font. | |
int | RenderOpaqueGeometry (vtkViewport *viewport) override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
int | RenderTranslucentPolygonalGeometry (vtkViewport *) override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
int | RenderOverlay (vtkViewport *viewport) override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
Public Member Functions inherited from vtkTexturedActor2D | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkTexturedActor2D * | NewInstance () const |
void | ReleaseGraphicsResources (vtkWindow *win) override |
Release any graphics resources that are being consumed by this actor. | |
vtkMTimeType | GetMTime () override |
Return this object's modified time. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this vtkTexturedActor2D. | |
virtual void | SetTexture (vtkTexture *texture) |
Set/Get the texture object to control rendering texture maps. | |
virtual vtkTexture * | GetTexture () |
Set/Get the texture object to control rendering texture maps. | |
int | RenderOverlay (vtkViewport *viewport) override |
Support the standard render methods. | |
int | RenderOpaqueGeometry (vtkViewport *viewport) override |
Support the standard render methods. | |
int | RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override |
Support the standard render methods. | |
Public Member Functions inherited from vtkActor2D | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkActor2D * | NewInstance () const |
vtkTypeBool | HasTranslucentPolygonalGeometry () override |
Does this prop have some translucent polygonal geometry? | |
vtkProperty2D * | GetProperty () |
Returns this actor's vtkProperty2D. | |
virtual void | SetProperty (vtkProperty2D *) |
Set this vtkProp's vtkProperty2D. | |
void | SetDisplayPosition (int, int) |
Set the Prop2D's position in display coordinates. | |
vtkMTimeType | GetMTime () override |
Return this objects MTime. | |
void | GetActors2D (vtkPropCollection *pc) override |
For some exporters and other other operations we must be able to collect all the actors or volumes. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this vtkActor2D. | |
void | ReleaseGraphicsResources (vtkWindow *) override |
Release any graphics resources that are being consumed by this actor. | |
virtual vtkCoordinate * | GetActualPositionCoordinate (void) |
Return the actual vtkCoordinate reference that the mapper should use to position the actor. | |
virtual vtkCoordinate * | GetActualPosition2Coordinate (void) |
Return the actual vtkCoordinate reference that the mapper should use to position the actor. | |
virtual void | SetMapper (vtkMapper2D *mapper) |
Set/Get the vtkMapper2D which defines the data to be drawn. | |
virtual vtkMapper2D * | GetMapper () |
Set/Get the vtkMapper2D which defines the data to be drawn. | |
virtual void | SetLayerNumber (int) |
Set/Get the layer number in the overlay planes into which to render. | |
virtual int | GetLayerNumber () |
Set/Get the layer number in the overlay planes into which to render. | |
virtual vtkCoordinate * | GetPositionCoordinate () |
Get the PositionCoordinate instance of vtkCoordinate. | |
virtual void | SetPosition (float x[2]) |
Get the PositionCoordinate instance of vtkCoordinate. | |
virtual void | SetPosition (float x, float y) |
Get the PositionCoordinate instance of vtkCoordinate. | |
virtual float * | GetPosition () |
Get the PositionCoordinate instance of vtkCoordinate. | |
virtual vtkCoordinate * | GetPosition2Coordinate () |
Access the Position2 instance variable. | |
virtual void | SetPosition2 (float x[2]) |
Access the Position2 instance variable. | |
virtual void | SetPosition2 (float x, float y) |
Access the Position2 instance variable. | |
virtual float * | GetPosition2 () |
Access the Position2 instance variable. | |
void | SetWidth (double w) |
Set/Get the height and width of the Actor2D. | |
double | GetWidth () |
Set/Get the height and width of the Actor2D. | |
void | SetHeight (double h) |
Set/Get the height and width of the Actor2D. | |
double | GetHeight () |
Set/Get the height and width of the Actor2D. | |
Public Member Functions inherited from vtkProp | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkProp * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | GetActors (vtkPropCollection *) |
For some exporters and other other operations we must be able to collect all the actors or volumes. | |
virtual void | GetActors2D (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | Pick () |
Method fires PickEvent if the prop is picked. | |
virtual vtkMTimeType | GetRedrawMTime () |
Return the mtime of anything that would cause the rendered image to appear differently. | |
virtual double * | GetBounds () |
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). | |
virtual void | ShallowCopy (vtkProp *prop) |
Shallow copy of this vtkProp. | |
virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. | |
virtual vtkMatrix4x4 * | GetMatrix () |
virtual bool | HasKeys (vtkInformation *requiredKeys) |
Tells if the prop has all the required keys. | |
virtual int | RenderOpaqueGeometry (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. | |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *) |
virtual int | RenderVolumetricGeometry (vtkViewport *) |
virtual int | RenderOverlay (vtkViewport *) |
virtual bool | RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the opaque geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the translucent polygonal geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the volumetric geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys) |
Render in the overlay of the viewport only if the prop has all the requiredKeys. | |
virtual vtkTypeBool | HasTranslucentPolygonalGeometry () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. | |
virtual vtkTypeBool | HasOpaqueGeometry () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. | |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. | |
virtual double | GetEstimatedRenderTime (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. | |
virtual double | GetEstimatedRenderTime () |
virtual void | SetEstimatedRenderTime (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. | |
virtual void | RestoreEstimatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. | |
virtual void | AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. | |
void | SetRenderTimeMultiplier (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. | |
virtual double | GetRenderTimeMultiplier () |
virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. | |
virtual bool | GetSupportsSelection () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. | |
virtual void | ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &) |
allows a prop to update a selections color buffers | |
virtual void | SetVisibility (vtkTypeBool) |
Set/Get visibility of this vtkProp. | |
virtual vtkTypeBool | GetVisibility () |
Set/Get visibility of this vtkProp. | |
virtual void | VisibilityOn () |
Set/Get visibility of this vtkProp. | |
virtual void | VisibilityOff () |
Set/Get visibility of this vtkProp. | |
virtual void | SetPickable (vtkTypeBool) |
Set/Get the pickable instance variable. | |
virtual vtkTypeBool | GetPickable () |
Set/Get the pickable instance variable. | |
virtual void | PickableOn () |
Set/Get the pickable instance variable. | |
virtual void | PickableOff () |
Set/Get the pickable instance variable. | |
virtual void | SetDragable (vtkTypeBool) |
Set/Get the value of the dragable instance variable. | |
virtual vtkTypeBool | GetDragable () |
Set/Get the value of the dragable instance variable. | |
virtual void | DragableOn () |
Set/Get the value of the dragable instance variable. | |
virtual void | DragableOff () |
Set/Get the value of the dragable instance variable. | |
virtual void | SetUseBounds (bool) |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual bool | GetUseBounds () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | UseBoundsOn () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | UseBoundsOff () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | InitPathTraversal () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual vtkAssemblyPath * | GetNextPath () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual int | GetNumberOfPaths () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual vtkInformation * | GetPropertyKeys () |
Set/Get property keys. | |
virtual void | SetPropertyKeys (vtkInformation *keys) |
Set/Get property keys. | |
virtual void | SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. | |
virtual double | GetAllocatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
virtual int | GetNumberOfConsumers () |
Get the number of consumers. | |
void | AddConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
void | RemoveConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
vtkObject * | GetConsumer (int i) |
Add or remove or get or check a consumer,. | |
int | IsConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
virtual void | SetShaderProperty (vtkShaderProperty *property) |
Set/Get the shader property. | |
virtual vtkShaderProperty * | GetShaderProperty () |
Set/Get the shader property. | |
virtual bool | IsRenderingTranslucentPolygonalGeometry () |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkTextActor * | SafeDownCast (vtkObjectBase *o) |
static vtkTextActor * | New () |
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95). | |
static int | SetMultipleConstrainedFontSize (vtkViewport *, int targetWidth, int targetHeight, vtkTextActor **actors, int nbOfActors, int *maxResultingSize) |
Set and return the font size required to make each element of an array of mappers fit in a given rectangle (width x height, in pixels). | |
static float | GetFontScale (vtkViewport *viewport) |
Provide a font scaling based on a viewport. | |
Static Public Member Functions inherited from vtkTexturedActor2D | |
static vtkTexturedActor2D * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkTexturedActor2D * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkActor2D | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkActor2D * | SafeDownCast (vtkObjectBase *o) |
static vtkActor2D * | New () |
Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. | |
Static Public Member Functions inherited from vtkProp | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkProp * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationIntegerKey * | GeneralTextureUnit () |
Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. | |
static vtkInformationDoubleVectorKey * | GeneralTextureTransform () |
Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
virtual bool | RenderImage (vtkTextProperty *tprop, vtkViewport *viewport) |
Render Input to Image using the supplied font property. | |
virtual bool | GetImageBoundingBox (vtkTextProperty *tprop, vtkViewport *viewport, int bbox[4]) |
Get the bounding box for Input using the supplied font property. | |
vtkTextActor () | |
~vtkTextActor () override | |
virtual void | ComputeRectangle (vtkViewport *viewport) |
virtual int | UpdateRectangle (vtkViewport *viewport) |
Ensure that Rectangle and RectanglePoints are valid and up-to-date. | |
Protected Member Functions inherited from vtkTexturedActor2D | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkTexturedActor2D () | |
~vtkTexturedActor2D () override | |
Protected Member Functions inherited from vtkActor2D | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkActor2D () | |
~vtkActor2D () override | |
Protected Member Functions inherited from vtkProp | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProp () | |
~vtkProp () override | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
An actor that displays text.
Scaled or unscaled
vtkTextActor can be used to place text annotation into a window. When TextScaleMode is NONE, the text is fixed font and operation is the same as a vtkPolyDataMapper2D/vtkActor2D pair. When TextScaleMode is VIEWPORT, the font resizes such that it maintains a consistent size relative to the viewport in which it is rendered. When TextScaleMode is PROP, the font resizes such that the text fits inside the box defined by the position 1 & 2 coordinates. This class replaces the deprecated vtkScaledTextActor and acts as a convenient wrapper for a vtkTextMapper/vtkActor2D pair. Set the text property/attributes through the vtkTextProperty associated to this actor.
Definition at line 159 of file vtkTextActor.h.
Definition at line 162 of file vtkTextActor.h.
anonymous enum |
Enumerator | |
---|---|
TEXT_SCALE_MODE_NONE | |
TEXT_SCALE_MODE_PROP | |
TEXT_SCALE_MODE_VIEWPORT |
Definition at line 226 of file vtkTextActor.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor, and vtkOpenGLTextActor.
|
static |
|
protectedvirtual |
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor, and vtkOpenGLTextActor.
vtkTextActor * vtkTextActor::NewInstance | ( | ) | const |
|
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 vtkActor2D.
Reimplemented in vtkScaledTextActor, and vtkOpenGLTextActor.
|
static |
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
|
overridevirtual |
Shallow copy of this text actor.
Overloads the virtual vtkProp method.
Reimplemented from vtkActor2D.
void vtkTextActor::SetInput | ( | const char * | inputString | ) |
Set the text string to be displayed.
"\n" is recognized as a carriage return/linefeed (line separator). The characters must be in the UTF-8 encoding. Convenience method to the underlying mapper
char * vtkTextActor::GetInput | ( | ) |
Set the text string to be displayed.
"\n" is recognized as a carriage return/linefeed (line separator). The characters must be in the UTF-8 encoding. Convenience method to the underlying mapper
|
virtual |
Set/Get the minimum size in pixels for this actor.
Defaults to 10,10. Only valid when TextScaleMode is PROP.
void vtkTextActor::SetMinimumSize | ( | int | [2] | ) |
Set/Get the minimum size in pixels for this actor.
Defaults to 10,10. Only valid when TextScaleMode is PROP.
|
virtual |
Set/Get the minimum size in pixels for this actor.
Defaults to 10,10. Only valid when TextScaleMode is PROP.
|
virtual |
Set/Get the minimum size in pixels for this actor.
Defaults to 10,10. Only valid when TextScaleMode is PROP.
|
virtual |
Set/Get the minimum size in pixels for this actor.
Defaults to 10,10. Only valid when TextScaleMode is PROP.
|
virtual |
Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.
Defaults to 1.0. Only valid when TextScaleMode is PROP.
|
virtual |
Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.
Defaults to 1.0. Only valid when TextScaleMode is PROP.
|
virtual |
Set how text should be scaled.
If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
|
virtual |
Set how text should be scaled.
If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
|
inline |
Set how text should be scaled.
If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
Definition at line 221 of file vtkTextActor.h.
|
inline |
Set how text should be scaled.
If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
Definition at line 222 of file vtkTextActor.h.
|
inline |
Set how text should be scaled.
If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
Definition at line 223 of file vtkTextActor.h.
|
virtual |
Turn on or off the UseBorderAlign option.
When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation
|
virtual |
Turn on or off the UseBorderAlign option.
When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation
|
virtual |
Turn on or off the UseBorderAlign option.
When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation
|
virtual |
Turn on or off the UseBorderAlign option.
When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation
void vtkTextActor::SetAlignmentPoint | ( | int | point | ) |
This method is being deprecated.
Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre
* 6 7 8 * 3 4 5 * 0 1 2 *
This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.
int vtkTextActor::GetAlignmentPoint | ( | ) |
This method is being deprecated.
Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre
* 6 7 8 * 3 4 5 * 0 1 2 *
This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.
void vtkTextActor::SetOrientation | ( | float | orientation | ) |
Counterclockwise rotation around the Alignment point.
Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.
|
virtual |
Counterclockwise rotation around the Alignment point.
Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.
|
virtual |
Set/Get the text property.
|
virtual |
Set/Get the text property.
|
virtual |
Return the bounding box coordinates of the text in pixels.
The bbox array is populated with [ xmin, xmax, ymin, ymax ] values in that order.
|
virtual |
Syntactic sugar to get the size of text instead of the entire bounding box.
|
virtual |
Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels).
A static version of the method is also available for convenience to other classes (e.g., widgets).
|
static |
Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels).
A static version of the method is also available for convenience to other classes (e.g., widgets).
|
static |
Set and return the font size required to make each element of an array of mappers fit in a given rectangle (width x height, in pixels).
This font size is the smallest size that was required to fit the largest mapper in this constraint.
|
virtual |
Enable non-linear scaling of font sizes.
This is useful in combination with scaled text. With small windows you want to use the entire scaled text area. With larger windows you want to reduce the font size some so that the entire area is not used. These values modify the computed font size as follows: newFontSize = pow(FontSize,exponent)*pow(target,1.0 - exponent) typically exponent should be around 0.7 and target should be around 10
void vtkTextActor::SpecifiedToDisplay | ( | double * | pos, |
vtkViewport * | vport, | ||
int | specified | ||
) |
This is just a simple coordinate conversion method used in the render process.
void vtkTextActor::DisplayToSpecified | ( | double * | pos, |
vtkViewport * | vport, | ||
int | specified | ||
) |
This is just a simple coordinate conversion method used in the render process.
|
virtual |
Compute the scale the font should be given the viewport.
The result is placed in the ScaledTextProperty ivar.
|
virtual |
Get the scaled font.
Use ComputeScaledFont to set the scale for a given viewport.
|
static |
Provide a font scaling based on a viewport.
This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
|
overridevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkActor2D.
|
overridevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
Draw the text actor to the screen.
Reimplemented from vtkActor2D.
|
inlineoverridevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
Draw the text actor to the screen.
Reimplemented from vtkActor2D.
Definition at line 377 of file vtkTextActor.h.
|
overridevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
Draw the text actor to the screen.
Reimplemented from vtkActor2D.
Reimplemented in vtkOpenGLTextActor.
|
overridevirtual |
Does this prop have some translucent polygonal geometry?
Reimplemented from vtkActor2D.
|
protectedvirtual |
Render Input to Image using the supplied font property.
|
protectedvirtual |
Get the bounding box for Input using the supplied font property.
|
protectedvirtual |
|
protectedvirtual |
Ensure that Rectangle and RectanglePoints are valid and up-to-date.
Unlike ComputeRectangle(), this may do nothing (if the rectangle is valid), or it may render the text to an image and recompute rectangle points by calling ComputeRectangle.
Returns a non-zero value upon success or zero upon failure to render the image.
This may be called with a NULL viewport when bounds are required before a rendering has occurred.
|
protected |
Definition at line 400 of file vtkTextActor.h.
|
protected |
Definition at line 401 of file vtkTextActor.h.
|
protected |
Definition at line 402 of file vtkTextActor.h.
|
protected |
Definition at line 403 of file vtkTextActor.h.
|
protected |
Definition at line 404 of file vtkTextActor.h.
|
protected |
Definition at line 405 of file vtkTextActor.h.
|
protected |
Definition at line 407 of file vtkTextActor.h.
|
protected |
Definition at line 408 of file vtkTextActor.h.
|
protected |
Definition at line 409 of file vtkTextActor.h.
|
protected |
Definition at line 410 of file vtkTextActor.h.
|
protected |
Definition at line 411 of file vtkTextActor.h.
|
protected |
Definition at line 412 of file vtkTextActor.h.
|
protected |
Definition at line 413 of file vtkTextActor.h.
|
protected |
Definition at line 414 of file vtkTextActor.h.
|
protected |
Definition at line 415 of file vtkTextActor.h.
|
protected |
Definition at line 416 of file vtkTextActor.h.
|
protected |
Definition at line 417 of file vtkTextActor.h.
|
protected |
Definition at line 419 of file vtkTextActor.h.
|
protected |
Definition at line 422 of file vtkTextActor.h.
|
protected |
Definition at line 423 of file vtkTextActor.h.