Inheritance diagram for osgText::Text:
| typedef std::map<osg::ref_ptr<Font::GlyphTexture>,GlyphQuads> osgText::Text::TextureGlyphQuadMap |
| osgText::Text::Text | ( | ) |
| osgText::Text::Text | ( | const Text & | text, | |
| const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY | |||
| ) |
| virtual osgText::Text::~Text | ( | ) | [protected, virtual] |
| virtual void osgText::Text::accept | ( | osg::PrimitiveFunctor & | pf | ) | const [virtual] |
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has.
Reimplemented from osg::Drawable.
| virtual void osgText::Text::accept | ( | osg::Drawable::ConstAttributeFunctor & | af | ) | const [virtual] |
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.
Reimplemented from osg::Drawable.
| float osgText::Text::bilinearInterpolate | ( | float | x1, | |
| float | x2, | |||
| float | y1, | |||
| float | y2, | |||
| float | x, | |||
| float | y, | |||
| float | q11, | |||
| float | q12, | |||
| float | q21, | |||
| float | q22 | |||
| ) | const [protected] |
| virtual const char* osgText::Text::className | ( | ) | const [inline, virtual] |
return the name of the object's class type. Must be defined by derived classes.
Reimplemented from osg::Drawable.
| virtual osg::Object* osgText::Text::clone | ( | const osg::CopyOp & | copyop | ) | const [inline, virtual] |
Clone an object, with Object* return type. Must be defined by derived classes.
Implements osg::Object.
| virtual osg::Object* osgText::Text::cloneType | ( | ) | const [inline, virtual] |
Clone the type of an object, with Object* return type. Must be defined by derived classes.
Implements osg::Object.
| bool osgText::Text::computeAverageGlypthWidthAndHeight | ( | float & | avg_width, | |
| float & | avg_height | |||
| ) | const [protected] |
| void osgText::Text::computeBackdropBoundingBox | ( | ) | const [protected] |
| void osgText::Text::computeBackdropPositions | ( | unsigned int | contextID | ) | const [protected] |
| virtual osg::BoundingBox osgText::Text::computeBound | ( | ) | const [virtual] |
Compute the bounding box around Drawables's geometry.
Reimplemented from osg::Drawable.
| void osgText::Text::computeColorGradients | ( | ) | const [protected] |
| void osgText::Text::computeColorGradientsOverall | ( | ) | const [protected] |
| void osgText::Text::computeColorGradientsPerCharacter | ( | ) | const [protected] |
| void osgText::Text::computeGlyphRepresentation | ( | ) | [protected] |
| String::iterator osgText::Text::computeLastCharacterOnLine | ( | osg::Vec2 & | cursor, | |
| String::iterator | first, | |||
| String::iterator | last | |||
| ) | [protected] |
| void osgText::Text::computePositions | ( | unsigned int | contextID | ) | const [protected] |
| void osgText::Text::computePositions | ( | ) | [protected] |
| void osgText::Text::convertHsvToRgb | ( | float | hsv[], | |
| float | rgb[] | |||
| ) | const [protected] |
| void osgText::Text::convertRgbToHsv | ( | float | rgb[], | |
| float | hsv[] | |||
| ) | const [protected] |
| void osgText::Text::drawForegroundText | ( | osg::State & | state, | |
| const GlyphQuads & | glyphquad | |||
| ) | const [protected] |
| virtual void osgText::Text::drawImplementation | ( | osg::State & | state | ) | const [virtual] |
Draw the text.
Implements osg::Drawable.
| const Font* osgText::Text::getActiveFont | ( | ) | const [protected] |
| Font* osgText::Text::getActiveFont | ( | ) | [protected] |
| AlignmentType osgText::Text::getAlignment | ( | ) | const [inline] |
| bool osgText::Text::getAutoRotateToScreen | ( | ) | const [inline] |
| const osg::Vec4& osgText::Text::getBackdropColor | ( | ) | const [inline] |
| float osgText::Text::getBackdropHorizontalOffet | ( | ) | const [inline] |
| BackdropImplementation osgText::Text::getBackdropImplementation | ( | ) | const [inline] |
| BackdropType osgText::Text::getBackdropType | ( | ) | const [inline] |
| float osgText::Text::getBackdropVerticalOffset | ( | ) | const [inline] |
| float osgText::Text::getCharacterAspectRatio | ( | ) | const [inline] |
| float osgText::Text::getCharacterHeight | ( | ) | const [inline] |
| CharacterSizeMode osgText::Text::getCharacterSizeMode | ( | ) | const [inline] |
Get the CharacterSizeMode.
| const osg::Vec4& osgText::Text::getColor | ( | ) | const [inline] |
| const osg::Vec4& osgText::Text::getColorGradientBottomLeft | ( | ) | const [inline] |
| const osg::Vec4& osgText::Text::getColorGradientBottomRight | ( | ) | const [inline] |
| ColorGradientMode osgText::Text::getColorGradientMode | ( | ) | const [inline] |
| const osg::Vec4& osgText::Text::getColorGradientTopLeft | ( | ) | const [inline] |
| const osg::Vec4& osgText::Text::getColorGradientTopRight | ( | ) | const [inline] |
| unsigned int osgText::Text::getDrawMode | ( | ) | const [inline] |
| const Font* osgText::Text::getFont | ( | ) | const [inline] |
Get the font. Return 0 if default is being used.
| unsigned int osgText::Text::getFontHeight | ( | ) | const [inline] |
| unsigned int osgText::Text::getFontWidth | ( | ) | const [inline] |
| const GlyphQuads* osgText::Text::getGlyphQuads | ( | Font::GlyphTexture * | texture | ) | const [inline] |
Direct Access to GlyphQuads
| KerningType osgText::Text::getKerningType | ( | ) | const [inline] |
| Layout osgText::Text::getLayout | ( | ) | const [inline] |
| unsigned int osgText::Text::getLineCount | ( | ) | const [inline] |
Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise
| float osgText::Text::getMaximumHeight | ( | ) | const [inline] |
Get the maximum height of the text box.
| float osgText::Text::getMaximumWidth | ( | ) | const [inline] |
Get the maximim width of the text box.
| const osg::Vec3& osgText::Text::getPosition | ( | ) | const [inline] |
Get the position of text.
| const osg::Quat& osgText::Text::getRotation | ( | ) | const [inline] |
| const String& osgText::Text::getText | ( | ) | const [inline] |
Get the const text string.
| String& osgText::Text::getText | ( | ) | [inline] |
Get the text string. Note, if you modify the string you must call Text::update() for the internal glyph reprentation to be updated.
| const TextureGlyphQuadMap& osgText::Text::getTextureGlyphQuadMap | ( | ) | const [inline] |
| virtual bool osgText::Text::isSameKindAs | ( | const osg::Object * | obj | ) | const [inline, virtual] |
Reimplemented from osg::Drawable.
| virtual const char* osgText::Text::libraryName | ( | ) | const [inline, virtual] |
return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.
Reimplemented from osg::Drawable.
| virtual void osgText::Text::releaseGLObjects | ( | osg::State * | state = 0 |
) | const [virtual] |
If State is non-zero, this function releases OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts.
Reimplemented from osg::Drawable.
| void osgText::Text::renderOnlyForegroundText | ( | osg::State & | state | ) | const [protected] |
| void osgText::Text::renderWithDepthRange | ( | osg::State & | state | ) | const [protected] |
| void osgText::Text::renderWithNoDepthBuffer | ( | osg::State & | state | ) | const [protected] |
| void osgText::Text::renderWithPolygonOffset | ( | osg::State & | state | ) | const [protected] |
| void osgText::Text::renderWithStencilBuffer | ( | osg::State & | state | ) | const [protected] |
| void osgText::Text::setAlignment | ( | AlignmentType | alignment | ) |
| void osgText::Text::setAutoRotateToScreen | ( | bool | autoRotateToScreen | ) |
| void osgText::Text::setAxisAlignment | ( | AxisAlignment | axis | ) |
| void osgText::Text::setBackdropColor | ( | const osg::Vec4 & | color | ) |
This specifies the color of the backdrop text. The default is black.
| void osgText::Text::setBackdropImplementation | ( | BackdropImplementation | implementation | ) |
This specifies the underlying backdrop rendering implementation. Unfortunately, at this time, there is no "perfect" rendering solution so this function is provided to let you 'pick your poison'. Each implementation has trade-offs.
POLYGON_OFFSET: This uses glPolygonOffset to draw the text multiple times to create the drop-shadow and outline effects. glPolygonOffset is used to prevent z-fighting of the overlapping text. This probably should have been the best option, but all the ATI cards we have encountered so far have serious problems with this. We see little white holes/artifacts in the rendered glyph textures which move around depending on the viewing angle. For moving text, the moving holes give an extremely unpleasant flickering effect. Pumping up the "units" parameter in glPolygonOffset can minimize this problem, but two other bad side-effects occur if you do this. First, high values will cause problems with clipping, particularly when there are objects behind the text. The drop-shadows or outline may be culled because their computed offset is behind the object or z-far plane. Second, there is an additional problem associated with the Z-slope. High values can make large chunks of the backdrop suddenly disappear. This can be reduced by the "factor" parameter. Making the "factor" value small, can help, but experimentally, we've found that it creates a new, different kind of z-fighting problem. So there is no perfect solution. With units, you trade off the 'holes' for the large-section clipping. Experimentally, we have found units values from 150-512 to be tolerable to acceptable with respect to the 'holes'. A factor of .1 seems to bring down the large clipping problem without creating a new z-fighting problem. (You can experiment with these numbers by playing with the osg:PolygonOffset multipliers which this backend tries to respect.)
If ATI ever fixes their cards/drivers, then this might become the best option.
NO_DEPTH_BUFFER Instead of using glPolygonOffset to prevent z-fighting, this mode just disables the depth buffer when rendering the text. This allows the text to be rendered without any z-fighting. The downside to this mode is that render order begins to matter and the text will not necessarily correctly appear above or behind other objects in the scene based on depth values. This mode is best for text that only needs to be ontop and not obscured by any objects.
DEPTH_RANGE This mode is inspired by Paul Martz's OpenGL FAQ, item 13.050. This uses glDepthRange as a substitute for glPolygonOffset. Strangely, experiments on ATI cards seem to produce cleaner results than when using glPolygonOffset. The trade-off for this is that the backdrop still may be placed too far back and might be culled by objects directly behind the object or by the far z-plane. If ATI ever fixes the glPolygonOffset problem, polygon offset is probably a slightly better solution because you can use smaller offsets. But with the current ATI problem, this option may be preferable.
STENCIL_BUFFER (Assuming the backend is written correctly,) the Stencil Buffer is the most "correct" and reliable way of producing backdrop text. The stencil buffer is a multipass system that allows writing to the same z-values without needing to resort to offsets. This implementation should not have any of the problems associated with the 3 previous implementations. But the trade-off for this mode is that without hardware acceleration for the stencil buffer, rendering will be extremely slow. (There is also potentially more overhead for this algorithm so it could be slower than the other implementations. Benchmarking would be required to determine if the speed differences are significant on your particular hardware.) This mode is best for when quality is important and stencil buffer hardware acceleration is available.
| void osgText::Text::setBackdropOffset | ( | float | horizontal, | |
| float | vertical | |||
| ) |
This overloaded version lets you specify the offset for the horizontal and vertical components separately.
| void osgText::Text::setBackdropOffset | ( | float | offset = 0.07f |
) |
Sets the amount text is offset to create the backdrop/shadow effect. Set the value too high and for example, in OUTLINE mode you will get a "Brady Bunch" effect where you see duplicates of the text in a 3x3 grid. Set the value too small and you won't see anything. The values represent percentages. 1.0 means 100% so a value of 1.0 in DROW_SHADOW_LEFT_CENTER mode would cause each glyph to be echoed next to it self. So the letter 'e' might look like 'ee'. Good values tend to be in the 0.03 to 0.10 range (but will be subject to your specific font and display characteristics). Note that the text bounding boxes are updated to include backdrop offsets. However, other metric information such as getCharacterHeight() are unaffected by this. This means that individual glyph spacing (kerning?) are unchanged even when this mode is used. The default is 0.07 (7% offset).
| void osgText::Text::setBackdropType | ( | BackdropType | type | ) |
BackdropType gives you a background shadow text behind your regular text. This helps give text extra contrast which can be useful when placing text against noisy backgrounds. The color of the background shadow text is specified by setBackdropColor(). DROP_SHADOW_BOTTOM_RIGHT will draw backdrop text to the right and down of the normal text. Other DROW_SHADOW_* modes do the same for their repective directions. OUTLINE will draw backdrop text so that it appears the text has an outline or border around the normal text. This mode is particularly useful against really noisy backgrounds that may put text on top of things that have all types of colors which you don't have control over. Some real world examples of this general technique in use that I know of are Google Earth, Sid Meier's Pirates (2004 Remake), and Star Control 2 (PC 1993). The default is NONE.
| void osgText::Text::setCharacterSize | ( | float | height, | |
| float | aspectRatio = 1.0f | |||
| ) |
Set the rendered character size in object coordinates.
| void osgText::Text::setCharacterSizeMode | ( | CharacterSizeMode | mode | ) | [inline] |
Set how the CharacterSize value relates to the final rendered character.
| void osgText::Text::setColor | ( | const osg::Vec4 & | color | ) |
| void osgText::Text::setColorGradientCorners | ( | const osg::Vec4 & | topLeft, | |
| const osg::Vec4 & | bottomLeft, | |||
| const osg::Vec4 & | bottomRight, | |||
| const osg::Vec4 & | topRight | |||
| ) |
Used only for gradient mode, let's you specify the colors of the 4 corners. If ColorGradients are off, these values are ignored (and the value from setColor() is the only one that is relevant.
| void osgText::Text::setColorGradientMode | ( | ColorGradientMode | mode | ) |
This sets different types of text coloring modes. When the coloring mode is not set to SOLID, the colors specified in setColorGradientCorners() determine the colors for the text. When the gradient mode is OVERALL, the coloring scheme attempts to approximate the effect as if the entire text box/region were a single polygon and you had applied colors to each of the four corners with GL_SMOOTH enabled. In this mode, OpenGL interpolates the colors across the polygon, and this is what OVERALL tries to emulate. This can be used to give nice embellishments on things like logos and names. PER_CHARACTER is similar to OVERALL except that it applies the color interpolation to the four corners of each character instead of across the overall text box. The default is SOLID (a.k.a. off).
| void osgText::Text::setDrawMode | ( | unsigned int | mode | ) |
| void osgText::Text::setFont | ( | const std::string & | fontfile | ) |
Set the font, loaded from the specified front file, to use to render the text, setFont("") sets the use of the default font. See the osgText::readFontFile function for how the font file will be located.
| void osgText::Text::setFont | ( | Font * | font = 0 |
) |
Set the Font to use to render the text. setFont(0) sets the use of the default font.
| void osgText::Text::setFontResolution | ( | unsigned int | width, | |
| unsigned int | height | |||
| ) |
Set the Font reference width and height resolution in texels. Note, the size may not be supported by current font, the closest supported font size will be selected.
| void osgText::Text::setKerningType | ( | KerningType | kerningType | ) | [inline] |
| void osgText::Text::setLayout | ( | Layout | layout | ) |
| void osgText::Text::setMaximumHeight | ( | float | maximumHeight | ) |
Set the maximum height of the text box. With horizontal layouts any characters which do not fit are wrapped around. 0 or negative values indicate that no maximum height is set, lines can be as long as they need be to fit thre required text
| void osgText::Text::setMaximumWidth | ( | float | maximumWidth | ) |
Set the maximum width of the text box. With horizontal layouts any characters which do not fit are wrapped around. 0 or negative values indicate that no maximum width is set, lines can be as long as they need be to fit thre required text
| void osgText::Text::setPosition | ( | const osg::Vec3 & | pos | ) |
Set the position of text.
| void osgText::Text::setRotation | ( | const osg::Quat & | quat | ) |
| void osgText::Text::setText | ( | const wchar_t * | text | ) |
Set the text using a wchar_t string, which is converted to an internal TextString.
| void osgText::Text::setText | ( | const std::string & | text, | |
| String::Encoding | encoding | |||
| ) |
Set the text using a Unicode encoded std::string, which is converted to an internal TextString. The encoding parameter specificies which Unicode encodeding is used in the std::string.
| void osgText::Text::setText | ( | const std::string & | text | ) |
Set the text using a std::string, which is converted to an internal TextString.
| void osgText::Text::setText | ( | const String & | text | ) |
Set the text using a osgText::String.
| virtual bool osgText::Text::supports | ( | const osg::PrimitiveFunctor & | ) | const [inline, virtual] |
return true, osgText::Text does support accept(PrimitiveFunctor&) .
Reimplemented from osg::Drawable.
| virtual bool osgText::Text::supports | ( | const osg::Drawable::ConstAttributeFunctor & | ) | const [inline, virtual] |
return true, osgText::Text does support accept(ConstAttributeFunctor&).
Reimplemented from osg::Drawable.
| virtual bool osgText::Text::supports | ( | const osg::Drawable::AttributeFunctor & | ) | const [inline, virtual] |
return false, osgText::Text does not support accept(AttributeFunctor&).
Reimplemented from osg::Drawable.
| void osgText::Text::update | ( | ) | [inline] |
update internal glyph respresnetation used for rendering, and bounding volume.
friend class Font [friend] |
AlignmentType osgText::Text::_alignment [protected] |
bool osgText::Text::_autoRotateToScreen [protected] |
osg::buffered_object<AutoTransformCache> osgText::Text::_autoTransformCache [mutable, protected] |
osg::Vec4 osgText::Text::_backdropColor [protected] |
float osgText::Text::_backdropHorizontalOffset [protected] |
BackdropType osgText::Text::_backdropType [protected] |
float osgText::Text::_backdropVerticalOffset [protected] |
float osgText::Text::_characterAspectRatio [protected] |
float osgText::Text::_characterHeight [protected] |
CharacterSizeMode osgText::Text::_characterSizeMode [protected] |
osg::Vec4 osgText::Text::_color [protected] |
osg::Vec4 osgText::Text::_colorGradientBottomLeft [protected] |
osg::Vec4 osgText::Text::_colorGradientBottomRight [protected] |
ColorGradientMode osgText::Text::_colorGradientMode [protected] |
osg::Vec4 osgText::Text::_colorGradientTopLeft [protected] |
osg::Vec4 osgText::Text::_colorGradientTopRight [protected] |
unsigned int osgText::Text::_drawMode [protected] |
osg::ref_ptr<Font> osgText::Text::_font [protected] |
unsigned int osgText::Text::_fontHeight [protected] |
unsigned int osgText::Text::_fontWidth [protected] |
KerningType osgText::Text::_kerningType [protected] |
Layout osgText::Text::_layout [protected] |
unsigned int osgText::Text::_lineCount [protected] |
float osgText::Text::_maximumHeight [protected] |
float osgText::Text::_maximumWidth [protected] |
osg::Vec3 osgText::Text::_normal [mutable, protected] |
osg::Vec3 osgText::Text::_offset [mutable, protected] |
osg::Vec3 osgText::Text::_position [protected] |
osg::Quat osgText::Text::_rotation [protected] |
String osgText::Text::_text [protected] |
osg::BoundingBox osgText::Text::_textBB [mutable, protected] |
TextureGlyphQuadMap osgText::Text::_textureGlyphQuadMap [mutable, protected] |
1.4.7