osgText::Text Class Reference

Inheritance diagram for osgText::Text:

Inheritance graph
[legend]

List of all members.

Public Types

enum  CharacterSizeMode { OBJECT_COORDS, SCREEN_COORDS, OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT }
enum  AlignmentType {
  LEFT_TOP, LEFT_CENTER, LEFT_BOTTOM, CENTER_TOP,
  CENTER_CENTER, CENTER_BOTTOM, RIGHT_TOP, RIGHT_CENTER,
  RIGHT_BOTTOM, LEFT_BASE_LINE, CENTER_BASE_LINE, RIGHT_BASE_LINE,
  LEFT_BOTTOM_BASE_LINE, CENTER_BOTTOM_BASE_LINE, RIGHT_BOTTOM_BASE_LINE, BASE_LINE = LEFT_BASE_LINE
}
enum  AxisAlignment {
  XY_PLANE, REVERSED_XY_PLANE, XZ_PLANE, REVERSED_XZ_PLANE,
  YZ_PLANE, REVERSED_YZ_PLANE, SCREEN, USER_DEFINED_ROTATION
}
enum  Layout { LEFT_TO_RIGHT, RIGHT_TO_LEFT, VERTICAL }
enum  DrawModeMask { TEXT = 1, BOUNDINGBOX = 2, ALIGNMENT = 4 }
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 }
enum  ColorGradientMode { SOLID = 0, PER_CHARACTER, OVERALL }
typedef std::map
< osg::ref_ptr
< Font::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.
void setFont (Font *font=0)
 Set the Font to use to render the text.
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.
const FontgetFont () const
 Get the font.
void setFontResolution (unsigned int width, unsigned int height)
 Set the Font reference width and height resolution in texels.
unsigned int getFontWidth () const
unsigned int getFontHeight () const
void setText (const String &text)
 Set the text using a osgText::String.
void setText (const std::string &text)
 Set the text using a std::string, which is converted to an internal TextString.
void setText (const std::string &text, String::Encoding encoding)
 Set the text using a Unicode encoded std::string, which is converted to an internal TextString.
void setText (const wchar_t *text)
 Set the text using a wchar_t string, which is converted to an internal TextString.
StringgetText ()
 Get the text string.
const StringgetText () const
 Get the const text string.
void update ()
 update internal glyph respresnetation used for rendering, and bounding volume.
void setCharacterSize (float height, float aspectRatio=1.0f)
 Set the rendered character size in object coordinates.
float getCharacterHeight () const
float getCharacterAspectRatio () const
void setCharacterSizeMode (CharacterSizeMode mode)
 Set how the CharacterSize value relates to the final rendered character.
CharacterSizeMode getCharacterSizeMode () const
 Get the CharacterSizeMode.
void setMaximumWidth (float maximumWidth)
 Set the maximum width of the text box.
float getMaximumWidth () const
 Get the maximim width of the text box.
void setMaximumHeight (float maximumHeight)
 Set the maximum height of the text box.
float getMaximumHeight () const
 Get the maximum height of the text box.
void setLineSpacing (float lineSpacing)
 Set the line spacing of the text box, given as a percentage of the character height.
float getLineSpacing () const
 Get the line spacing of the text box.
void setPosition (const osg::Vec3 &pos)
 Set the position of text.
const osg::Vec3getPosition () const
 Get the position of text.
void setAlignment (AlignmentType alignment)
AlignmentType getAlignment () const
void setAxisAlignment (AxisAlignment axis)
AxisAlignment getAxisAlignment () const
void setRotation (const osg::Quat &quat)
const osg::QuatgetRotation () const
void setAutoRotateToScreen (bool autoRotateToScreen)
bool getAutoRotateToScreen () const
void setLayout (Layout layout)
Layout getLayout () const
void setColor (const osg::Vec4 &color)
const osg::Vec4getColor () const
void setDrawMode (unsigned int mode)
unsigned int getDrawMode () 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
void setKerningType (KerningType kerningType)
KerningType getKerningType () const
unsigned int getLineCount () const
 Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise.
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 interal 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 interal primtives 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 (Font::GlyphTexture *texture) const
 Direct Access to GlyphQuads.
const
TextureGlyphQuadMap
getTextureGlyphQuadMap () const
virtual osg::BoundingBox computeBound () const
 Compute the bounding box around Drawables's geometry.

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
void computePositions ()
void computePositions (unsigned int contextID) const
void computeBackdropPositions (unsigned int contextID) const
void computeBackdropBoundingBox () 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 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
float bilinearInterpolate (float x1, float x2, float y1, float y2, float x, float y, float q11, float q12, float q21, float q22) const
void convertHsvToRgb (float hsv[], float rgb[]) const
void convertRgbToHsv (float rgb[], float hsv[]) const

Protected Attributes

osg::ref_ptr< Font_font
unsigned int _fontWidth
unsigned int _fontHeight
float _characterHeight
float _characterAspectRatio
CharacterSizeMode _characterSizeMode
float _maximumWidth
float _maximumHeight
float _lineSpacing
String _text
osg::Vec3 _position
AlignmentType _alignment
AxisAlignment _axisAlignment
osg::Quat _rotation
bool _autoRotateToScreen
Layout _layout
osg::Vec4 _color
unsigned int _drawMode
KerningType _kerningType
unsigned int _lineCount
TextureGlyphQuadMap _textureGlyphQuadMap
osg::buffered_object
< AutoTransformCache
_autoTransformCache
osg::Vec3 _offset
osg::Vec3 _normal
osg::BoundingBox _textBB
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

Friends

class Font

Classes

struct  AutoTransformCache
struct  GlyphQuads


Member Typedef Documentation

typedef std::map<osg::ref_ptr<Font::GlyphTexture>,GlyphQuads> osgText::Text::TextureGlyphQuadMap


Member Enumeration Documentation

enum osgText::Text::CharacterSizeMode

Enumerator:
OBJECT_COORDS 
SCREEN_COORDS  default
OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT  internally scale the characters to be constant screen size.

text that behavaves like OBJECT_COORDS sized text when a long distance way, but has its screen sized capped automatically when the viewer gets near.

enum osgText::Text::AlignmentType

Enumerator:
LEFT_TOP 
LEFT_CENTER 
LEFT_BOTTOM 
CENTER_TOP 
CENTER_CENTER 
CENTER_BOTTOM 
RIGHT_TOP 
RIGHT_CENTER 
RIGHT_BOTTOM 
LEFT_BASE_LINE 
CENTER_BASE_LINE 
RIGHT_BASE_LINE 
LEFT_BOTTOM_BASE_LINE 
CENTER_BOTTOM_BASE_LINE 
RIGHT_BOTTOM_BASE_LINE 
BASE_LINE 

enum osgText::Text::AxisAlignment

Enumerator:
XY_PLANE 
REVERSED_XY_PLANE 
XZ_PLANE 
REVERSED_XZ_PLANE 
YZ_PLANE 
REVERSED_YZ_PLANE 
SCREEN 
USER_DEFINED_ROTATION 

enum osgText::Text::Layout

Enumerator:
LEFT_TO_RIGHT 
RIGHT_TO_LEFT  default
VERTICAL 

enum osgText::Text::DrawModeMask

Enumerator:
TEXT 
BOUNDINGBOX  default
ALIGNMENT 

enum osgText::Text::BackdropType

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 

enum osgText::Text::BackdropImplementation

Enumerator:
POLYGON_OFFSET 
NO_DEPTH_BUFFER 
DEPTH_RANGE 
STENCIL_BUFFER 

enum osgText::Text::ColorGradientMode

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 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.

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 bool osgText::Text::isSameKindAs ( const osg::Object obj  )  const [inline, virtual]

Reimplemented from osg::Drawable.

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 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.

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

const Font* osgText::Text::getFont (  )  const [inline]

Get the font.

Return 0 if default is being used.

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.

unsigned int osgText::Text::getFontWidth (  )  const [inline]

unsigned int osgText::Text::getFontHeight (  )  const [inline]

void osgText::Text::setText ( const String text  ) 

Set the text using a osgText::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 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 wchar_t *  text  ) 

Set the text using a wchar_t string, which is converted to an internal TextString.

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 String& osgText::Text::getText (  )  const [inline]

Get the const text string.

void osgText::Text::update (  )  [inline]

update internal glyph respresnetation used for rendering, and bounding volume.

void osgText::Text::setCharacterSize ( float  height,
float  aspectRatio = 1.0f 
)

Set the rendered character size in object coordinates.

float osgText::Text::getCharacterHeight (  )  const [inline]

float osgText::Text::getCharacterAspectRatio (  )  const [inline]

void osgText::Text::setCharacterSizeMode ( CharacterSizeMode  mode  )  [inline]

Set how the CharacterSize value relates to the final rendered character.

CharacterSizeMode osgText::Text::getCharacterSizeMode (  )  const [inline]

Get the CharacterSizeMode.

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

float osgText::Text::getMaximumWidth (  )  const [inline]

Get the maximim width of the text box.

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 the required text

float osgText::Text::getMaximumHeight (  )  const [inline]

Get the maximum height of the text box.

void osgText::Text::setLineSpacing ( float  lineSpacing  ) 

Set the line spacing of the text box, given as a percentage of the character height.

The default value is 0 for backward compatibility. For longer paragraphs of text, a value of at least 25% (i.e. set line spacing to 0.25) is recommended.

float osgText::Text::getLineSpacing (  )  const [inline]

Get the line spacing of the text box.

void osgText::Text::setPosition ( const osg::Vec3 pos  ) 

Set the position of text.

const osg::Vec3& osgText::Text::getPosition (  )  const [inline]

Get the position of text.

void osgText::Text::setAlignment ( AlignmentType  alignment  ) 

AlignmentType osgText::Text::getAlignment (  )  const [inline]

void osgText::Text::setAxisAlignment ( AxisAlignment  axis  ) 

AxisAlignment osgText::Text::getAxisAlignment (  )  const [inline]

void osgText::Text::setRotation ( const osg::Quat quat  ) 

const osg::Quat& osgText::Text::getRotation (  )  const [inline]

void osgText::Text::setAutoRotateToScreen ( bool  autoRotateToScreen  ) 

bool osgText::Text::getAutoRotateToScreen (  )  const [inline]

void osgText::Text::setLayout ( Layout  layout  ) 

Layout osgText::Text::getLayout (  )  const [inline]

void osgText::Text::setColor ( const osg::Vec4 color  ) 

const osg::Vec4& osgText::Text::getColor (  )  const [inline]

void osgText::Text::setDrawMode ( unsigned int  mode  ) 

unsigned int osgText::Text::getDrawMode (  )  const [inline]

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.

BackdropType osgText::Text::getBackdropType (  )  const [inline]

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.

float osgText::Text::getBackdropHorizontalOffset (  )  const [inline]

float osgText::Text::getBackdropVerticalOffset (  )  const [inline]

void osgText::Text::setBackdropColor ( const osg::Vec4 color  ) 

This specifies the color of the backdrop text.

The default is black.

const osg::Vec4& osgText::Text::getBackdropColor (  )  const [inline]

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.

BackdropImplementation osgText::Text::getBackdropImplementation (  )  const [inline]

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).

ColorGradientMode osgText::Text::getColorGradientMode (  )  const [inline]

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.

const osg::Vec4& osgText::Text::getColorGradientTopLeft (  )  const [inline]

const osg::Vec4& osgText::Text::getColorGradientBottomLeft (  )  const [inline]

const osg::Vec4& osgText::Text::getColorGradientBottomRight (  )  const [inline]

const osg::Vec4& osgText::Text::getColorGradientTopRight (  )  const [inline]

void osgText::Text::setKerningType ( KerningType  kerningType  )  [inline]

KerningType osgText::Text::getKerningType (  )  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.

virtual void osgText::Text::drawImplementation ( osg::RenderInfo renderInfo  )  const [virtual]

Draw the text.

Implements osg::Drawable.

Reimplemented in osgText::FadeText.

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 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.

virtual bool osgText::Text::supports ( const osg::PrimitiveFunctor  )  const [inline, virtual]

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

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 interal primtives that this Drawable has.

Reimplemented from osg::Drawable.

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

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

Reimplemented from osg::Drawable.

virtual void osgText::Text::resizeGLObjectBuffers ( unsigned int  maxSize  )  [virtual]

Resize any per context GLObject buffers to specified size.

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.

const GlyphQuads* osgText::Text::getGlyphQuads ( Font::GlyphTexture texture  )  const [inline]

Direct Access to GlyphQuads.

const TextureGlyphQuadMap& osgText::Text::getTextureGlyphQuadMap (  )  const [inline]

virtual osg::BoundingBox osgText::Text::computeBound (  )  const [virtual]

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

Font* osgText::Text::getActiveFont (  )  [protected]

const Font* osgText::Text::getActiveFont (  )  const [protected]

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

void osgText::Text::computeGlyphRepresentation (  )  [protected]

bool osgText::Text::computeAverageGlyphWidthAndHeight ( float &  avg_width,
float &  avg_height 
) const [protected]

void osgText::Text::computePositions (  )  [protected]

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

void osgText::Text::computeBackdropPositions ( unsigned int  contextID  )  const [protected]

void osgText::Text::computeBackdropBoundingBox (  )  const [protected]

void osgText::Text::computeColorGradients (  )  const [protected]

void osgText::Text::computeColorGradientsOverall (  )  const [protected]

void osgText::Text::computeColorGradientsPerCharacter (  )  const [protected]

void osgText::Text::drawImplementation ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]

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

void osgText::Text::renderOnlyForegroundText ( 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::renderWithNoDepthBuffer ( 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::renderWithStencilBuffer ( osg::State state,
const osg::Vec4 colorMultiplier 
) const [protected]

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]

void osgText::Text::convertHsvToRgb ( float  hsv[],
float  rgb[] 
) const [protected]

void osgText::Text::convertRgbToHsv ( float  rgb[],
float  hsv[] 
) const [protected]


Friends And Related Function Documentation

friend class Font [friend]


Member Data Documentation

osg::ref_ptr<Font> osgText::Text::_font [protected]

unsigned int osgText::Text::_fontWidth [protected]

unsigned int osgText::Text::_fontHeight [protected]

float osgText::Text::_characterHeight [protected]

float osgText::Text::_characterAspectRatio [protected]

CharacterSizeMode osgText::Text::_characterSizeMode [protected]

float osgText::Text::_maximumWidth [protected]

float osgText::Text::_maximumHeight [protected]

float osgText::Text::_lineSpacing [protected]

String osgText::Text::_text [protected]

osg::Vec3 osgText::Text::_position [protected]

AlignmentType osgText::Text::_alignment [protected]

AxisAlignment osgText::Text::_axisAlignment [protected]

osg::Quat osgText::Text::_rotation [protected]

bool osgText::Text::_autoRotateToScreen [protected]

Layout osgText::Text::_layout [protected]

osg::Vec4 osgText::Text::_color [protected]

unsigned int osgText::Text::_drawMode [protected]

KerningType osgText::Text::_kerningType [protected]

unsigned int osgText::Text::_lineCount [protected]

TextureGlyphQuadMap osgText::Text::_textureGlyphQuadMap [mutable, protected]

osg::buffered_object<AutoTransformCache> osgText::Text::_autoTransformCache [mutable, protected]

osg::Vec3 osgText::Text::_offset [mutable, protected]

osg::Vec3 osgText::Text::_normal [mutable, protected]

osg::BoundingBox osgText::Text::_textBB [mutable, protected]

BackdropType osgText::Text::_backdropType [protected]

BackdropImplementation osgText::Text::_backdropImplementation [protected]

float osgText::Text::_backdropHorizontalOffset [protected]

float osgText::Text::_backdropVerticalOffset [protected]

osg::Vec4 osgText::Text::_backdropColor [protected]

ColorGradientMode osgText::Text::_colorGradientMode [protected]

osg::Vec4 osgText::Text::_colorGradientTopLeft [protected]

osg::Vec4 osgText::Text::_colorGradientBottomLeft [protected]

osg::Vec4 osgText::Text::_colorGradientBottomRight [protected]

osg::Vec4 osgText::Text::_colorGradientTopRight [protected]


The documentation for this class was generated from the following file:
Generated at Sun Oct 14 02:12:49 2007 for the OpenSceneGraph by doxygen 1.5.3.