OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osgText::Text Class Reference
Inheritance diagram for osgText::Text:
Inheritance graph
[legend]

List of all members.

Classes

struct  GlyphQuads

Public Types

enum  BackdropType {
  DROP_SHADOW_BOTTOM_RIGHT = 0, DROP_SHADOW_CENTER_RIGHT, DROP_SHADOW_TOP_RIGHT, DROP_SHADOW_BOTTOM_CENTER,
  DROP_SHADOW_TOP_CENTER, DROP_SHADOW_BOTTOM_LEFT, DROP_SHADOW_CENTER_LEFT, DROP_SHADOW_TOP_LEFT,
  OUTLINE, NONE
}
enum  BackdropImplementation {
  POLYGON_OFFSET = 0, NO_DEPTH_BUFFER, DEPTH_RANGE, STENCIL_BUFFER,
  DELAYED_DEPTH_WRITES
}
enum  ColorGradientMode { SOLID = 0, PER_CHARACTER, OVERALL }
typedef std::map< osg::ref_ptr
< GlyphTexture >, GlyphQuads
TextureGlyphQuadMap

Public Member Functions

 Text ()
 Text (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual osg::ObjectcloneType () const
 Clone the type of an object, with Object* return type.
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * className () const
 return the name of the object's class type.
virtual const char * libraryName () const
 return the name of the object's library.
virtual void setFont (Font *font=0)
 Set the Font to use to render the text.
virtual void setFont (osg::ref_ptr< Font > font)
 Set the Font to use to render the text.
virtual void 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.
void setEnableDepthWrites (bool enable)
 Turns off writing to the depth buffer when rendering text.
bool getEnableDepthWrites () const
void setBackdropType (BackdropType type)
 BackdropType gives you a background shadow text behind your regular text.
BackdropType getBackdropType () const
void setBackdropOffset (float offset=0.07f)
 Sets the amount text is offset to create the backdrop/shadow effect.
void setBackdropOffset (float horizontal, float vertical)
 This overloaded version lets you specify the offset for the horizontal and vertical components separately.
float getBackdropHorizontalOffset () const
float getBackdropVerticalOffset () const
void setBackdropColor (const osg::Vec4 &color)
 This specifies the color of the backdrop text.
const osg::Vec4getBackdropColor () const
void setBackdropImplementation (BackdropImplementation implementation)
 This specifies the underlying backdrop rendering implementation.
BackdropImplementation getBackdropImplementation () const
void setColorGradientMode (ColorGradientMode mode)
 This sets different types of text coloring modes.
ColorGradientMode getColorGradientMode () const
void 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.
const osg::Vec4getColorGradientTopLeft () const
const osg::Vec4getColorGradientBottomLeft () const
const osg::Vec4getColorGradientBottomRight () const
const osg::Vec4getColorGradientTopRight () const
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
 Draw the text.
virtual bool supports (const osg::Drawable::AttributeFunctor &) const
 return false, osgText::Text does not support accept(AttributeFunctor&).
virtual bool supports (const osg::Drawable::ConstAttributeFunctor &) const
 return true, osgText::Text does support accept(ConstAttributeFunctor&).
virtual void accept (osg::Drawable::ConstAttributeFunctor &af) const
 accept an ConstAttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const osg::PrimitiveFunctor &) const
 return true, osgText::Text does support accept(PrimitiveFunctor&) .
virtual void accept (osg::PrimitiveFunctor &pf) const
 accept a PrimtiveFunctor and call its methods to tell it about the internal primitives that this Drawable has.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
const GlyphQuadsgetGlyphQuads (GlyphTexture *texture) const
 Direct Access to GlyphQuads.
const TextureGlyphQuadMapgetTextureGlyphQuadMap () const

Protected Member Functions

virtual ~Text ()
FontgetActiveFont ()
const FontgetActiveFont () const
String::iterator computeLastCharacterOnLine (osg::Vec2 &cursor, String::iterator first, String::iterator last)
void computeGlyphRepresentation ()
bool computeAverageGlyphWidthAndHeight (float &avg_width, float &avg_height) const
virtual void computePositions (unsigned int contextID) const
void computeBackdropPositions (unsigned int contextID) const
void computeBackdropBoundingBox () const
void computeBoundingBoxMargin () const
void computeColorGradients () const
void computeColorGradientsOverall () const
void computeColorGradientsPerCharacter () const
void drawImplementation (osg::State &state, const osg::Vec4 &colorMultiplier) const
void drawForegroundText (osg::State &state, const GlyphQuads &glyphquad, const osg::Vec4 &colorMultiplier) const
void drawTextWithBackdrop (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderOnlyForegroundText (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderWithPolygonOffset (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderWithNoDepthBuffer (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderWithDepthRange (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderWithStencilBuffer (osg::State &state, const osg::Vec4 &colorMultiplier) const
void renderWithDelayedDepthWrites (osg::State &state, const osg::Vec4 &colorMultiplier) const
float bilinearInterpolate (float x1, float x2, float y1, float y2, float x, float y, float q11, float q12, float q21, float q22) const

Protected Attributes

TextureGlyphQuadMap _textureGlyphQuadMap
bool _enableDepthWrites
BackdropType _backdropType
BackdropImplementation _backdropImplementation
float _backdropHorizontalOffset
float _backdropVerticalOffset
osg::Vec4 _backdropColor
ColorGradientMode _colorGradientMode
osg::Vec4 _colorGradientTopLeft
osg::Vec4 _colorGradientBottomLeft
osg::Vec4 _colorGradientBottomRight
osg::Vec4 _colorGradientTopRight

Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
POLYGON_OFFSET 
NO_DEPTH_BUFFER 
DEPTH_RANGE 
STENCIL_BUFFER 
DELAYED_DEPTH_WRITES 
Enumerator:
DROP_SHADOW_BOTTOM_RIGHT 
DROP_SHADOW_CENTER_RIGHT 
DROP_SHADOW_TOP_RIGHT 
DROP_SHADOW_BOTTOM_CENTER 
DROP_SHADOW_TOP_CENTER 
DROP_SHADOW_BOTTOM_LEFT 
DROP_SHADOW_CENTER_LEFT 
DROP_SHADOW_TOP_LEFT 
OUTLINE 
NONE 
Enumerator:
SOLID 
PER_CHARACTER 
OVERALL 

Constructor & Destructor Documentation

osgText::Text::Text ( )
osgText::Text::Text ( const Text text,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgText::Text::~Text ( ) [protected, virtual]

Member Function Documentation

virtual void osgText::Text::accept ( osg::Drawable::ConstAttributeFunctor af) const [virtual]

accept an ConstAttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.

Reimplemented from osg::Drawable.

virtual void osgText::Text::accept ( osg::PrimitiveFunctor pf) const [virtual]

accept a PrimtiveFunctor and call its methods to tell it about the internal primitives 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 osgText::TextBase.

virtual osg::Object* osgText::Text::clone ( const osg::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::computeAverageGlyphWidthAndHeight ( float &  avg_width,
float &  avg_height 
) const [protected]
void osgText::Text::computeBackdropBoundingBox ( ) const [protected]
void osgText::Text::computeBackdropPositions ( unsigned int  contextID) const [protected]
void osgText::Text::computeBoundingBoxMargin ( ) const [protected]
void osgText::Text::computeColorGradients ( ) const [protected]
void osgText::Text::computeColorGradientsOverall ( ) const [protected]
void osgText::Text::computeColorGradientsPerCharacter ( ) const [protected]
void osgText::Text::computeGlyphRepresentation ( ) [protected, virtual]

Implements osgText::TextBase.

String::iterator osgText::Text::computeLastCharacterOnLine ( osg::Vec2 cursor,
String::iterator  first,
String::iterator  last 
) [protected]

Reimplemented from osgText::TextBase.

virtual void osgText::Text::computePositions ( unsigned int  contextID) const [protected, virtual]

Implements osgText::TextBase.

void osgText::Text::drawForegroundText ( osg::State state,
const GlyphQuads glyphquad,
const osg::Vec4 colorMultiplier 
) const [protected]
virtual void osgText::Text::drawImplementation ( osg::RenderInfo renderInfo) const [virtual]

Draw the text.

Implements osg::Drawable.

Reimplemented in osgText::FadeText.

void osgText::Text::drawImplementation ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::drawTextWithBackdrop ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
Font* osgText::Text::getActiveFont ( ) [protected]
const Font* osgText::Text::getActiveFont ( ) const [protected]
const osg::Vec4& osgText::Text::getBackdropColor ( ) const [inline]
float osgText::Text::getBackdropHorizontalOffset ( ) const [inline]
BackdropImplementation osgText::Text::getBackdropImplementation ( ) const [inline]
BackdropType osgText::Text::getBackdropType ( ) const [inline]
float osgText::Text::getBackdropVerticalOffset ( ) 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]
bool osgText::Text::getEnableDepthWrites ( ) const [inline]
const GlyphQuads* osgText::Text::getGlyphQuads ( GlyphTexture texture) const [inline]

Direct Access to GlyphQuads.

References NULL.

const TextureGlyphQuadMap& osgText::Text::getTextureGlyphQuadMap ( ) const [inline]
virtual bool osgText::Text::isSameKindAs ( const osg::Object obj) const [inline, virtual]

Reimplemented from osgText::TextBase.

References NULL.

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 osgText::TextBase.

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 osgText::TextBase.

void osgText::Text::renderOnlyForegroundText ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::renderWithDelayedDepthWrites ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::renderWithDepthRange ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::renderWithNoDepthBuffer ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::renderWithPolygonOffset ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
void osgText::Text::renderWithStencilBuffer ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]
virtual void osgText::Text::resizeGLObjectBuffers ( unsigned int  maxSize) [virtual]

Resize any per context GLObject buffers to specified size.

Reimplemented from osgText::TextBase.

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. See BackdropImplementation enum docs for details.

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::setBackdropOffset ( float  horizontal,
float  vertical 
)

This overloaded version lets you specify the offset for the horizontal and vertical components separately.

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::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::setEnableDepthWrites ( bool  enable) [inline]

Turns off writing to the depth buffer when rendering text.

This only affects text with no backdrop or text using the DELAYED_DEPTH_WRITES implementation, since the other backdrop implementations are really only useful for backwards compatibility and are not worth updating to utilize this flag.

virtual void osgText::Text::setFont ( Font font = 0) [inline, virtual]

Set the Font to use to render the text.

setFont(0) sets the use of the default font.

Reimplemented from osgText::TextBase.

References setFont().

Referenced by setFont().

virtual void osgText::Text::setFont ( osg::ref_ptr< Font font) [virtual]

Set the Font to use to render the text.

Reimplemented from osgText::TextBase.

virtual void osgText::Text::setFont ( const std::string &  fontfile) [inline, virtual]

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.

Reimplemented from osgText::TextBase.

References osgText::TextBase::setFont().

virtual void osgText::Text::setThreadSafeRefUnref ( bool  threadSafe) [virtual]

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osgText::TextBase.

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.

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::PrimitiveFunctor ) const [inline, virtual]

return true, osgText::Text does support accept(PrimitiveFunctor&) .

Reimplemented from osg::Drawable.


Member Data Documentation


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

osg logo
Generated at Mon Oct 3 2011 12:39:49 for the OpenSceneGraph by doxygen 1.7.5.