openscenegraph
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgText::Text Class Reference
Inheritance diagram for osgText::Text:
osgText::TextBase osg::Drawable osg::Object osg::Referenced osgText::FadeText

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 Types inherited from osgText::TextBase
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, FILLEDBOUNDINGBOX = 4, ALIGNMENT = 8 }
- Public Types inherited from osg::Drawable
enum  AttributeTypes {
  VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3,
  SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTRIBUTE_6 = 6, ATTRIBUTE_7 = 7,
  TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2,
  TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6,
  TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7
}
typedef std::vector< Node * > ParentList
typedef unsigned int AttributeType
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Text ()
 Text (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual osg::ObjectcloneType () const
virtual osg::Objectclone (const osg::CopyOp &copyop) const
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * className () const
virtual const char * libraryName () const
virtual void setFont (Font *font=0)
virtual void setFont (osg::ref_ptr< Font > font)
virtual void setFont (const std::string &fontfile)
void setEnableDepthWrites (bool enable)
bool getEnableDepthWrites () const
void setBackdropType (BackdropType type)
BackdropType getBackdropType () const
void setBackdropOffset (float offset=0.07f)
void setBackdropOffset (float horizontal, float vertical)
float getBackdropHorizontalOffset () const
float getBackdropVerticalOffset () const
void setBackdropColor (const osg::Vec4 &color)
const osg::Vec4getBackdropColor () const
void setBackdropImplementation (BackdropImplementation implementation)
BackdropImplementation getBackdropImplementation () const
void setColorGradientMode (ColorGradientMode mode)
ColorGradientMode getColorGradientMode () const
void setColorGradientCorners (const osg::Vec4 &topLeft, const osg::Vec4 &bottomLeft, const osg::Vec4 &bottomRight, const osg::Vec4 &topRight)
const osg::Vec4getColorGradientTopLeft () const
const osg::Vec4getColorGradientBottomLeft () const
const osg::Vec4getColorGradientBottomRight () const
const osg::Vec4getColorGradientTopRight () const
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
virtual bool supports (const osg::Drawable::AttributeFunctor &) const
virtual bool supports (const osg::Drawable::ConstAttributeFunctor &) const
virtual void accept (osg::Drawable::ConstAttributeFunctor &af) const
virtual bool supports (const osg::PrimitiveFunctor &) const
virtual void accept (osg::PrimitiveFunctor &pf) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *state=0) const
const GlyphQuadsgetGlyphQuads (GlyphTexture *texture) const
const TextureGlyphQuadMapgetTextureGlyphQuadMap () const
- Public Member Functions inherited from osgText::TextBase
 TextBase ()
 TextBase (const TextBase &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
void setColor (const osg::Vec4 &color)
const osg::Vec4getColor () const
const FontgetFont () const
void setStyle (Style *style)
StylegetStyle ()
const StylegetStyle () const
StylegetOrCreateStyle ()
void setFontResolution (unsigned int width, unsigned int height)
unsigned int getFontWidth () const
unsigned int getFontHeight () const
void setText (const String &text)
void setText (const std::string &text)
void setText (const std::string &text, String::Encoding encoding)
void setText (const wchar_t *text)
StringgetText ()
const StringgetText () const
void update ()
void setCharacterSize (float height)
void setCharacterSize (float height, float aspectRatio)
float getCharacterHeight () const
float getCharacterAspectRatio () const
void setCharacterSizeMode (CharacterSizeMode mode)
CharacterSizeMode getCharacterSizeMode () const
void setMaximumWidth (float maximumWidth)
float getMaximumWidth () const
void setMaximumHeight (float maximumHeight)
float getMaximumHeight () const
void setLineSpacing (float lineSpacing)
float getLineSpacing () const
void setPosition (const osg::Vec3 &pos)
const osg::Vec3getPosition () const
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 setDrawMode (unsigned int mode)
unsigned int getDrawMode () const
void setBoundingBoxMargin (float margin)
float getBoundingBoxMargin () const
void setBoundingBoxColor (const osg::Vec4 &color)
const osg::Vec4getBoundingBoxColor () const
void setKerningType (KerningType kerningType)
KerningType getKerningType () const
unsigned int getLineCount () const
virtual osg::BoundingBox computeBound () const
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual GeometryasGeometry ()
virtual const GeometryasGeometry () const
virtual void computeDataVariance ()
const ParentListgetParents () const
ParentList getParents ()
NodegetParent (unsigned int i)
const NodegetParent (unsigned int i) const
unsigned int getNumParents () const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setStateSet (StateSet *stateset)
StateSetgetStateSet ()
const StateSetgetStateSet () const
StateSetgetOrCreateStateSet ()
void setInitialBound (const osg::BoundingBox &bbox)
const BoundingBoxgetInitialBound () const
void dirtyBound ()
const BoundingBoxgetBound () const
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
void setShape (Shape *shape)
ShapegetShape ()
const ShapegetShape () const
void setSupportsDisplayList (bool flag)
bool getSupportsDisplayList () const
void setUseDisplayList (bool flag)
bool getUseDisplayList () const
GLuint & getDisplayList (unsigned int contextID) const
virtual void setUseVertexBufferObjects (bool flag)
bool getUseVertexBufferObjects () const
virtual void dirtyDisplayList ()
virtual unsigned int getGLObjectSizeHint () const
void draw (RenderInfo &renderInfo) const
virtual void compileGLObjects (RenderInfo &renderInfo) const
virtual void setUpdateCallback (UpdateCallback *ac)
UpdateCallbackgetUpdateCallback ()
const UpdateCallbackgetUpdateCallback () const
bool requiresUpdateTraversal () const
virtual void setEventCallback (EventCallback *ac)
EventCallbackgetEventCallback ()
const EventCallbackgetEventCallback () const
bool requiresEventTraversal () const
virtual void setCullCallback (CullCallback *cc)
CullCallbackgetCullCallback ()
const CullCallbackgetCullCallback () const
virtual void setDrawCallback (DrawCallback *dc)
DrawCallbackgetDrawCallback ()
const DrawCallbackgetDrawCallback () const
virtual void accept (AttributeFunctor &)
virtual bool supports (const PrimitiveIndexFunctor &) const
virtual void accept (PrimitiveIndexFunctor &) const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) 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 Member Functions inherited from osgText::TextBase
virtual ~TextBase ()
void positionCursor (const osg::Vec2 &endOfLine_coords, osg::Vec2 &cursor, unsigned int linelength)
void computePositions ()
- Protected Member Functions inherited from osg::Drawable
Drawableoperator= (const Drawable &)
virtual ~Drawable ()
void setBound (const BoundingBox &bb) const
void addParent (osg::Node *node)
void removeParent (osg::Node *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setNumChildrenRequiringEventTraversal (unsigned int num)
unsigned int getNumChildrenRequiringEventTraversal () const
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () 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
- Protected Attributes inherited from osgText::TextBase
osg::Vec4 _color
osg::ref_ptr< Font_font
osg::ref_ptr< Style_style
FontResolution _fontSize
float _characterHeight
CharacterSizeMode _characterSizeMode
float _maximumWidth
float _maximumHeight
float _lineSpacing
String _text
osg::Vec3 _position
AlignmentType _alignment
AxisAlignment _axisAlignment
osg::Quat _rotation
bool _autoRotateToScreen
Layout _layout
unsigned int _drawMode
float _textBBMargin
osg::Vec4 _textBBColor
KerningType _kerningType
unsigned int _lineCount
osg::buffered_object
< AutoTransformCache
_autoTransformCache
osg::Vec3 _offset
osg::Vec3 _normal
osg::BoundingBox _textBB
- Protected Attributes inherited from osg::Drawable
ParentList _parents
ref_ptr< StateSet_stateset
BoundingBox _initialBound
ref_ptr
< ComputeBoundingBoxCallback
_computeBoundCallback
BoundingBox _boundingBox
bool _boundingBoxComputed
ref_ptr< Shape_shape
bool _supportsDisplayList
bool _useDisplayList
bool _supportsVertexBufferObjects
bool _useVertexBufferObjects
GLObjectList _globjList
ref_ptr< UpdateCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< EventCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< CullCallback_cullCallback
ref_ptr< DrawCallback_drawCallback
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Static Public Member Functions inherited from osg::Drawable
static GLuint generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
static void flushAllDeletedDisplayLists (unsigned int contextID)
static void discardAllDeletedDisplayLists (unsigned int contextID)
static void flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
static void setExtensions (unsigned int contextID, Extensions *extensions)
- Static Public Attributes inherited from osg::Drawable
static unsigned int s_numberDrawablesReusedLastInLastFrame
static unsigned int s_numberNewDrawablesInLastFrame
static unsigned int s_numberDeletedDrawablesInLastFrame
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value
< GLuint > 
GLObjectList

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 ( )
protectedvirtual

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
inlinevirtual

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
inlinevirtual

Clone an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

virtual osg::Object* osgText::Text::cloneType ( ) const
inlinevirtual

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 ( )
protectedvirtual

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
protectedvirtual

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
inlinevirtual

Reimplemented from osgText::TextBase.

References NULL.

virtual const char* osgText::Text::libraryName ( ) const
inlinevirtual

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

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

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
inlinevirtual

return false, osgText::Text does not support accept(AttributeFunctor&).

Reimplemented from osg::Drawable.

virtual bool osgText::Text::supports ( const osg::Drawable::ConstAttributeFunctor ) const
inlinevirtual

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

Reimplemented from osg::Drawable.

virtual bool osgText::Text::supports ( const osg::PrimitiveFunctor ) const
inlinevirtual

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

Reimplemented from osg::Drawable.

Member Data Documentation

osg::Vec4 osgText::Text::_backdropColor
protected
float osgText::Text::_backdropHorizontalOffset
protected
BackdropImplementation osgText::Text::_backdropImplementation
protected
BackdropType osgText::Text::_backdropType
protected
float osgText::Text::_backdropVerticalOffset
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
bool osgText::Text::_enableDepthWrites
protected
TextureGlyphQuadMap osgText::Text::_textureGlyphQuadMap
mutableprotected

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