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 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
 A vector of osg::Node pointers which is used to store the parent(s) of drawable.
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
 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
- 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
 Get the font.
void setStyle (Style *style)
 Set the text style.
StylegetStyle ()
 Get the text style.
const StylegetStyle () const
 Get the const text style.
StylegetOrCreateStyle ()
 Get or create the text style.
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 respresentation used for rendering, and bounding volume.
void setCharacterSize (float height)
 Set the rendered character size in object coordinates.
void setCharacterSize (float height, float aspectRatio)
 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 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
 Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise.
virtual osg::BoundingBox computeBound () const
 Compute the bounding box around Drawables's geometry.
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual GeometryasGeometry ()
 Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual const GeometryasGeometry () const
 Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
const ParentListgetParents () const
 Get the parent list of drawable.
ParentList getParents ()
 Get the a copy of parent list of node.
NodegetParent (unsigned int i)
 Get a single parent of Drawable.
const NodegetParent (unsigned int i) const
 Get a single const parent of Drawable.
unsigned int getNumParents () const
 Get the number of parents of node.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setStateSet (StateSet *stateset)
 Set the StateSet attached to the Drawable.
StateSetgetStateSet ()
 Get the attached StateSet.
const StateSetgetStateSet () const
 Get the attached const StateSet.
StateSetgetOrCreateStateSet ()
 Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it.
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Dirty the bounding box, forcing a computeBound() on the next call to getBound().
const BoundingBoxgetBound () const
 Get BoundingBox of Drawable.
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback.
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback.
void setShape (Shape *shape)
 Set the Shape of the Drawable.
ShapegetShape ()
 Get the Shape of the Drawable.
const ShapegetShape () const
 Get the const Shape of the const Drawable.
void setSupportsDisplayList (bool flag)
 Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists.
bool getSupportsDisplayList () const
 Get whether display lists are supported for this drawable instance.
void setUseDisplayList (bool flag)
 When set to true, force the draw method to use OpenGL Display List for rendering.
bool getUseDisplayList () const
 Return whether OpenGL display lists are being used for rendering.
GLuint & getDisplayList (unsigned int contextID) const
 Return OpenGL display list for specified contextID.
virtual void setUseVertexBufferObjects (bool flag)
 When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
virtual void dirtyDisplayList ()
 Force a recompile on next draw() of any OpenGL display list associated with this geoset.
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
void draw (RenderInfo &renderInfo) const
 Draw OpenGL primitives.
virtual void compileGLObjects (RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
virtual void setUpdateCallback (UpdateCallback *ac)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
UpdateCallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const UpdateCallbackgetUpdateCallback () const
 Get the const UpdateCallback.
bool requiresUpdateTraversal () const
 Return whether this Drawable has update callbacks associated with it, and therefore must be traversed.
virtual void setEventCallback (EventCallback *ac)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
EventCallbackgetEventCallback ()
 Get the non const EventCallback.
const EventCallbackgetEventCallback () const
 Get the const EventCallback.
bool requiresEventTraversal () const
 Return whether this Drawable has event callbacks associated with it, and therefore must be traversed.
virtual void setCullCallback (CullCallback *cc)
 Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.
CullCallbackgetCullCallback ()
 Get the non const CullCallback.
const CullCallbackgetCullCallback () const
 Get the const CullCallback.
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback.
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback.
virtual void accept (AttributeFunctor &)
 accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const PrimitiveIndexFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
virtual void accept (PrimitiveIndexFunctor &) const
 Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

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
 set the bounding box .
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 ()
 Object destructor.
- 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

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:

osg logo
Generated at Fri Nov 2 2012 21:42:49 for the OpenSceneGraph by doxygen 1.8.1.1.