An actor that displays text. Scaled or unscaled. More...
#include <vtkTextActor.h>
Detailed Description
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.
- Examples:
- vtkTextActor (Examples)
- Tests:
- vtkTextActor (Tests)
Definition at line 54 of file vtkTextActor.h.
Member Typedef Documentation
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
Definition at line 57 of file vtkTextActor.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 111 of file vtkTextActor.h.
Constructor & Destructor Documentation
| vtkTextActor::vtkTextActor | ( | ) | [protected] |
| vtkTextActor::~vtkTextActor | ( | ) | [protected] |
Member Function Documentation
| static int vtkTextActor::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| virtual int vtkTextActor::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 vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| static vtkTextActor* vtkTextActor::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| virtual vtkObjectBase* vtkTextActor::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| vtkTextActor* vtkTextActor::NewInstance | ( | ) | const |
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| void vtkTextActor::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| static vtkTextActor* vtkTextActor::New | ( | ) | [static] |
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
Reimplemented from vtkTexturedActor2D.
Reimplemented in vtkScaledTextActor.
| void vtkTextActor::ShallowCopy | ( | vtkProp * | prop | ) | [virtual] |
Shallow copy of this text actor. Overloads the virtual vtkProp method.
Reimplemented from vtkTexturedActor2D.
| 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 void vtkTextActor::SetMinimumSize | ( | int | , |
| int | |||
| ) | [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 int* vtkTextActor::GetMinimumSize | ( | ) | [virtual] |
Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
| virtual void vtkTextActor::GetMinimumSize | ( | int & | , |
| int & | |||
| ) | [virtual] |
Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
| virtual void vtkTextActor::GetMinimumSize | ( | int | [2] | ) | [virtual] |
Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
| virtual void vtkTextActor::SetMaximumLineHeight | ( | float | ) | [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 float vtkTextActor::GetMaximumLineHeight | ( | ) | [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 void vtkTextActor::SetTextScaleMode | ( | int | ) | [virtual] |
Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the 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 int vtkTextActor::GetTextScaleMode | ( | ) | [virtual] |
Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the 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.
| void vtkTextActor::SetTextScaleModeToNone | ( | ) | [inline] |
Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the 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 102 of file vtkTextActor.h.
| void vtkTextActor::SetTextScaleModeToProp | ( | ) | [inline] |
Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the 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 104 of file vtkTextActor.h.
| void vtkTextActor::SetTextScaleModeToViewport | ( | ) | [inline] |
Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the 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 106 of file vtkTextActor.h.
| virtual void vtkTextActor::SetUseBorderAlign | ( | int | ) | [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 int vtkTextActor::GetUseBorderAlign | ( | ) | [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 void vtkTextActor::UseBorderAlignOn | ( | ) | [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 void vtkTextActor::UseBorderAlignOff | ( | ) | [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 depricated. 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.
This method is being depricated. 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 float vtkTextActor::GetOrientation | ( | ) | [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 void vtkTextActor::SetTextProperty | ( | vtkTextProperty * | p | ) | [virtual] |
Set/Get the text property.
| virtual vtkTextProperty* vtkTextActor::GetTextProperty | ( | ) | [virtual] |
Set/Get the text property.
| virtual void vtkTextActor::GetBoundingBox | ( | vtkViewport * | vport, |
| double | bbox[4] | ||
| ) | [virtual] |
Return the bounding box coordinates of the text in viewport coordinates. The bbox array is populated with [ xmin, xmax, ymin, ymax ] values in that order.
| virtual void vtkTextActor::GetSize | ( | vtkViewport * | vport, |
| double | size[2] | ||
| ) | [virtual] |
Syntactic sugar to get the size of text instead of the entire bounding box.
| virtual int vtkTextActor::SetConstrainedFontSize | ( | vtkViewport * | , |
| int | targetWidth, | ||
| int | targetHeight | ||
| ) | [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 int vtkTextActor::SetConstrainedFontSize | ( | vtkTextActor * | , |
| vtkViewport * | , | ||
| int | targetWidth, | ||
| int | targetHeight | ||
| ) | [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 int vtkTextActor::SetMultipleConstrainedFontSize | ( | vtkViewport * | , |
| int | targetWidth, | ||
| int | targetHeight, | ||
| vtkTextActor ** | actors, | ||
| int | nbOfActors, | ||
| int * | maxResultingSize | ||
| ) | [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 void vtkTextActor::SetNonLinearFontScale | ( | double | exponent, |
| int | target | ||
| ) | [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 void vtkTextActor::ComputeScaledFont | ( | vtkViewport * | viewport | ) | [virtual] |
Compute the scale the font should be given the viewport. The result is placed in the ScaledTextProperty ivar.
| virtual vtkTextProperty* vtkTextActor::GetScaledTextProperty | ( | ) | [virtual] |
Get the scaled font. Use ComputeScaledFont to set the scale for a given viewport.
| static float vtkTextActor::GetFontScale | ( | vtkViewport * | 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.
| virtual void vtkTextActor::ReleaseGraphicsResources | ( | vtkWindow * | ) | [virtual] |
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 vtkTexturedActor2D.
| virtual int vtkTextActor::RenderOpaqueGeometry | ( | vtkViewport * | viewport | ) | [virtual] |
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 vtkTexturedActor2D.
| virtual int vtkTextActor::RenderTranslucentPolygonalGeometry | ( | vtkViewport * | ) | [inline, virtual] |
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 vtkTexturedActor2D.
Definition at line 232 of file vtkTextActor.h.
| virtual int vtkTextActor::RenderOverlay | ( | vtkViewport * | viewport | ) | [virtual] |
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 vtkTexturedActor2D.
| virtual int vtkTextActor::HasTranslucentPolygonalGeometry | ( | ) | [virtual] |
Does this prop have some translucent polygonal geometry?
Reimplemented from vtkActor2D.
| virtual bool vtkTextActor::RenderImage | ( | vtkTextProperty * | tprop, |
| vtkViewport * | viewport | ||
| ) | [protected, virtual] |
Render Input to Image using the supplied font property.
| virtual bool vtkTextActor::GetImageBoundingBox | ( | vtkTextProperty * | tprop, |
| vtkViewport * | viewport, | ||
| int | bbox[4] | ||
| ) | [protected, virtual] |
Get the bounding box for Input using the supplied font property.
| virtual void vtkTextActor::ComputeRectangle | ( | vtkViewport * | viewport | ) | [protected, virtual] |
| virtual int vtkTextActor::UpdateRectangle | ( | vtkViewport * | viewport | ) | [protected, virtual] |
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.
Member Data Documentation
int vtkTextActor::MinimumSize[2] [protected] |
Definition at line 255 of file vtkTextActor.h.
float vtkTextActor::MaximumLineHeight [protected] |
Definition at line 256 of file vtkTextActor.h.
double vtkTextActor::FontScaleExponent [protected] |
Definition at line 257 of file vtkTextActor.h.
int vtkTextActor::TextScaleMode [protected] |
Definition at line 258 of file vtkTextActor.h.
float vtkTextActor::Orientation [protected] |
Definition at line 259 of file vtkTextActor.h.
int vtkTextActor::UseBorderAlign [protected] |
Definition at line 260 of file vtkTextActor.h.
vtkTextProperty* vtkTextActor::TextProperty [protected] |
Definition at line 262 of file vtkTextActor.h.
vtkImageData* vtkTextActor::ImageData [protected] |
Definition at line 263 of file vtkTextActor.h.
vtkTextRenderer* vtkTextActor::TextRenderer [protected] |
Definition at line 264 of file vtkTextActor.h.
vtkTimeStamp vtkTextActor::BuildTime [protected] |
Definition at line 265 of file vtkTextActor.h.
vtkTransform* vtkTextActor::Transform [protected] |
Definition at line 266 of file vtkTextActor.h.
int vtkTextActor::LastSize[2] [protected] |
Definition at line 267 of file vtkTextActor.h.
int vtkTextActor::LastOrigin[2] [protected] |
Definition at line 268 of file vtkTextActor.h.
char* vtkTextActor::Input [protected] |
Definition at line 269 of file vtkTextActor.h.
bool vtkTextActor::InputRendered [protected] |
Definition at line 270 of file vtkTextActor.h.
double vtkTextActor::FormerOrientation [protected] |
Definition at line 271 of file vtkTextActor.h.
vtkTextProperty* vtkTextActor::ScaledTextProperty [protected] |
Definition at line 273 of file vtkTextActor.h.
vtkPolyData* vtkTextActor::Rectangle [protected] |
Definition at line 276 of file vtkTextActor.h.
vtkPoints* vtkTextActor::RectanglePoints [protected] |
Definition at line 277 of file vtkTextActor.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/Core/vtkTextActor.h
