VRS::CurveText Class Reference
DEPRECATED: Node to display a text along a curve. More...
#include <vrs/text/deprecated/curvetext.h>
Public Member Functions | |
| CurveText (Font *font, Curve *curve, const std::string &text=std::string(), double size=1.0, double begin=0.0, bool runFlipGuard=false) | |
| Constructs a curve text with a given string. | |
| CurveText (Curve *curve, Text *text, double begin=0.0, bool runFlipGuard=false) | |
| Consructs a curve text with a given text shape. | |
| void | setFont (Font *font) |
| Changes the used font. | |
| Font * | getFont () const |
| Returns the used font. | |
| void | setTextString (const std::string &text) |
| Changes the displayed text. | |
| std::string | getTextString () const |
| Returns the displayed text. | |
| void | setText (Text *text) |
| Changes the displayed text. | |
| Text * | getText () const |
| Returns the displayed text as a shape. | |
| void | setCurve (Curve *curve) |
| Changes the used curve. | |
| Curve * | getCurve () const |
| Returns the used curve. | |
| void | setSize (double size) |
| Changes the used size. | |
| double | getSize () const |
| Returns the used size. | |
| void | setBegin (double begin) |
| Changes the starting point of the text. | |
| double | getBegin () const |
| Returns the starting point of the text. | |
| void | startFlipGuard () |
| Activates the flip guard. | |
| void | stopFlipGuard () |
| Deactivates the flip guard. | |
| virtual void | evaluate (Engine *engine) |
| Draws the text along the curve. | |
| virtual Bounds | boundingBox (Engine *) const |
| Returns the bounding box of the text placed along the curve. | |
| virtual void | modified () |
| Overwritten so that it sets the update bounding box flag. | |
Detailed Description
DEPRECATED: Node to display a text along a curve.Constructor & Destructor Documentation
| VRS::CurveText::CurveText | ( | Font * | font, | |
| Curve * | curve, | |||
| const std::string & | text = std::string(), |
|||
| double | size = 1.0, |
|||
| double | begin = 0.0, |
|||
| bool | runFlipGuard = false | |||
| ) |
Constructs a curve text with a given string.
It will devide the string into its letters and display them along the curve. See comments on the set/get-methods for the parameters.
| VRS::CurveText::CurveText | ( | Curve * | curve, | |
| Text * | text, | |||
| double | begin = 0.0, |
|||
| bool | runFlipGuard = false | |||
| ) |
Consructs a curve text with a given text shape.
It will also devide the string of the text shape into its letters, but keep the given modifications (scaling, positioning etc.). It will use the font given along with the text shape and size will be set to 1.0. See comments on the set/get-methods for the parameters.
Member Function Documentation
| void VRS::CurveText::setFont | ( | Font * | font | ) |
Changes the used font.
| Font* VRS::CurveText::getFont | ( | ) | const |
Returns the used font.
| void VRS::CurveText::setTextString | ( | const std::string & | text | ) |
Changes the displayed text.
| std::string VRS::CurveText::getTextString | ( | ) | const |
Returns the displayed text.
| void VRS::CurveText::setText | ( | Text * | text | ) |
Changes the displayed text.
It will also set the used font to the text's font and the size to 1.0.
| Text* VRS::CurveText::getText | ( | ) | const |
Returns the displayed text as a shape.
Mostly for internal use. Do not use this pointer to change the text! (call setText after the changes are done)
| void VRS::CurveText::setCurve | ( | Curve * | curve | ) |
Changes the used curve.
| Curve* VRS::CurveText::getCurve | ( | ) | const |
Returns the used curve.
| void VRS::CurveText::setSize | ( | double | size | ) |
Changes the used size.
Size is only applied to the glyphs, not to the curve.
| double VRS::CurveText::getSize | ( | ) | const |
Returns the used size.
| void VRS::CurveText::setBegin | ( | double | begin | ) |
Changes the starting point of the text.
begin is the beginning of the text as part of the curve length (between 0 and 1).
| double VRS::CurveText::getBegin | ( | ) | const |
Returns the starting point of the text.
Returns the beginning of the text as part of the curve length (between 0 and 1).
| void VRS::CurveText::startFlipGuard | ( | ) |
Activates the flip guard.
The flip guard will try to avoid the flipping of the letters when trying to create a smooth animation. Any data changing method except the setBegin will stop the flip guard. So if one changes the text and wants the flip guard to be active, one must explicitly start it (again).
| void VRS::CurveText::stopFlipGuard | ( | ) |
Deactivates the flip guard.
| virtual void VRS::CurveText::evaluate | ( | Engine * | engine | ) | [virtual] |
| virtual void VRS::CurveText::modified | ( | ) | [virtual] |
The documentation for this class was generated from the following file: