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:
Inheritance graph
[legend]

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  ColorGradientMode { SOLID = 0, PER_CHARACTER, OVERALL }
 
enum  BackdropImplementation {
  POLYGON_OFFSET = 0, NO_DEPTH_BUFFER, DEPTH_RANGE, STENCIL_BUFFER,
  DELAYED_DEPTH_WRITES
}
 deprecated, value ignored. More...
 
typedef std::map< osg::ref_ptr< GlyphTexture >, GlyphQuadsTextureGlyphQuadMap
 
- 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 }
 
typedef osg::ref_ptr< osg::Vec3ArrayCoords
 
- 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 DrawableUpdateCallback UpdateCallback
 
typedef DrawableEventCallback EventCallback
 
typedef DrawableCullCallback CullCallback
 
typedef unsigned int AttributeType
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node. More...
 
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node. More...
 
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object. More...
 
- 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 an object of the same type as the node. More...
 
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 return a clone of a node, with Object* return type. More...
 
virtual bool isSameKindAs (const osg::Object *obj) const
 return true if this and obj are of the same kind of object. More...
 
virtual const char * className () const
 return the name of the node's class type. More...
 
virtual const char * libraryName () const
 return the name of the node's library. More...
 
void setShaderTechnique (ShaderTechnique technique)
 Set the ShaderTechnique hint to specify what fatures in the text shaders to enable. More...
 
ShaderTechnique getShaderTechnique ()
 Get the ShaderTechnique hint. More...
 
void setEnableDepthWrites (bool enable)
 Turns off writing to the depth buffer when rendering text. More...
 
bool getEnableDepthWrites () const
 
void setBackdropType (BackdropType type)
 BackdropType gives you a background shadow text behind your regular text. More...
 
BackdropType getBackdropType () const
 
void setBackdropOffset (float offset=0.07f)
 Sets the amount text is offset to create the backdrop/shadow effect. More...
 
void setBackdropOffset (float horizontal, float vertical)
 This overloaded version lets you specify the offset for the horizontal and vertical components separately. More...
 
float getBackdropHorizontalOffset () const
 
float getBackdropVerticalOffset () const
 
void setBackdropColor (const osg::Vec4 &color)
 This specifies the color of the backdrop text. More...
 
const osg::Vec4getBackdropColor () const
 
void setColorGradientMode (ColorGradientMode mode)
 This sets different types of text coloring modes. More...
 
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. More...
 
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. More...
 
virtual bool supports (const osg::Drawable::AttributeFunctor &) const
 return false, osgText::Text does not support accept(AttributeFunctor&). More...
 
virtual bool supports (const osg::Drawable::ConstAttributeFunctor &) const
 return true, osgText::Text does support accept(ConstAttributeFunctor&). More...
 
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. More...
 
virtual bool supports (const osg::PrimitiveFunctor &) const
 return true, osgText::Text does support accept(PrimitiveFunctor&) . More...
 
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. More...
 
bool getCharacterCorners (unsigned int index, osg::Vec3 &bottomLeft, osg::Vec3 &bottomRight, osg::Vec3 &topLeft, osg::Vec3 &topRight) const
 Get the coordinates of the character corners in local coordinates. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
void setBackdropImplementation (BackdropImplementation)
 deprecated, value ignored. More...
 
BackdropImplementation getBackdropImplementation () const
 deprecated, value should be ignored. More...
 
const GlyphQuadsgetGlyphQuads (GlyphTexture *texture) const
 Direct Access to GlyphQuads. More...
 
const TextureGlyphQuadMapgetTextureGlyphQuadMap () const
 
void addGlyphQuad (Glyph *glyph, const osg::Vec2 &minc, const osg::Vec2 &maxc, const osg::Vec2 &mintc, const osg::Vec2 &maxtc)
 
- 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
 
virtual void setFont (Font *font=0)
 Set the Font to use to render the text. More...
 
virtual void setFont (osg::ref_ptr< Font > font)
 Set the Font to use to render the text. More...
 
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. More...
 
FontgetFont ()
 Get the font. More...
 
const FontgetFont () const
 Get the const font. More...
 
void setStyle (Style *style)
 Set the text style. More...
 
StylegetStyle ()
 Get the text style. More...
 
const StylegetStyle () const
 Get the const text style. More...
 
StylegetOrCreateStyle ()
 Get or create the text style. More...
 
void setFontResolution (unsigned int width, unsigned int height)
 Set the Font reference width and height resolution in texels. More...
 
unsigned int getFontWidth () const
 
unsigned int getFontHeight () const
 
void setText (const String &text)
 Set the text using a osgText::String. More...
 
void setText (const std::string &text)
 Set the text using a std::string, which is converted to an internal TextString. More...
 
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. More...
 
void setText (const wchar_t *text)
 Set the text using a wchar_t string, which is converted to an internal TextString. More...
 
StringgetText ()
 Get the text string. More...
 
const StringgetText () const
 Get the const text string. More...
 
void update ()
 update internal glyph respresentation used for rendering, and bounding volume. More...
 
void setCharacterSize (float height)
 Set the rendered character size in object coordinates. More...
 
void setCharacterSize (float height, float aspectRatio)
 Set the rendered character size in object coordinates. More...
 
float getCharacterHeight () const
 
float getCharacterAspectRatio () const
 
void setCharacterSizeMode (CharacterSizeMode mode)
 Set how the CharacterSize value relates to the final rendered character. More...
 
CharacterSizeMode getCharacterSizeMode () const
 Get the CharacterSizeMode. More...
 
void setMaximumWidth (float maximumWidth)
 Set the maximum width of the text box. More...
 
float getMaximumWidth () const
 Get the maximim width of the text box. More...
 
void setMaximumHeight (float maximumHeight)
 Set the maximum height of the text box. More...
 
float getMaximumHeight () const
 Get the maximum height of the text box. More...
 
void setLineSpacing (float lineSpacing)
 Set the line spacing of the text box, given as a percentage of the character height. More...
 
float getLineSpacing () const
 Get the line spacing of the text box. More...
 
void setPosition (const osg::Vec3 &pos)
 Set the position of text. More...
 
const osg::Vec3getPosition () const
 Get the position of text. More...
 
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. More...
 
virtual void compileGLObjects (osg::RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects. More...
 
virtual osg::BoundingBox computeBoundingBox () const
 Compute the bounding box around Drawables's geometry. More...
 
CoordsgetCoords ()
 
const CoordsgetCoords () const
 
void getCoord (unsigned int i, osg::Vec2 &c) const
 
void getCoord (unsigned int i, osg::Vec3 &c) const
 
const osg::MatrixgetMatrix () const
 Get the cached internal matrix used to provide positioning of text. More...
 
bool computeMatrix (osg::Matrix &matrix, osg::State *state=0) const
 compute the matrix that positions the text in model space for the given viewpoint. More...
 
- 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. More...
 
 META_Node (osg, Drawable)
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates. More...
 
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingSpheregetBound () const
 
const BoundingBoxgetBoundingBox () const
 Get BoundingBox of Drawable. More...
 
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Drawables's geometry. More...
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound. More...
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback. More...
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback. More...
 
virtual void setShape (Shape *shape)
 Set the Shape of the Drawable. More...
 
template<class T >
void setShape (const ref_ptr< T > &shape)
 
ShapegetShape ()
 Get the Shape of the Drawable. More...
 
const ShapegetShape () const
 Get the const Shape of the const Drawable. More...
 
void setSupportsDisplayList (bool flag)
 Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists. More...
 
bool getSupportsDisplayList () const
 Get whether display lists are supported for this drawable instance. More...
 
void setUseDisplayList (bool flag)
 When set to true, force the draw method to use OpenGL Display List for rendering. More...
 
bool getUseDisplayList () const
 Return whether OpenGL display lists are being used for rendering. More...
 
GLuint & getDisplayList (unsigned int contextID) const
 Return OpenGL display list for specified contextID. More...
 
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. More...
 
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver. More...
 
void setUseVertexArrayObject (bool flag)
 Set whether to use a local VertexArrayObject for this Drawable. More...
 
bool getUseVertexArrayObject () const
 Return whether to use a local VertexArrayObject for this Drawable. More...
 
virtual void dirtyGLObjects ()
 Force a recompile on next draw() of any OpenGL objects associated with this geoset. More...
 
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable. More...
 
void draw (RenderInfo &renderInfo) const
 Draw OpenGL primitives. More...
 
void drawInner (RenderInfo &renderInfo) const
 
void setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
 Set the callback to override the default Drawable::createCreateVertexArrayStateImplementation(). More...
 
CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback ()
 Get the callback that overrides the default Drawable::createCreateVertexArrayStateImplementation(). More...
 
const CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback () const
 Get the const callback that overrides the default Drawable::createCreateVertexArrayStateImplementation(). More...
 
VertexArrayStatecreateVertexArrayState (RenderInfo &renderInfo) const
 Create the VertexArrayState object used to track vertex array and vertex array object state. More...
 
void setVertexArrayStateList (VertexArrayStateList &vasl)
 
VertexArrayStateListgetVertexArrayStateList ()
 
const VertexArrayStateListgetVertexArrayStateList () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object. More...
 
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback. More...
 
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback. More...
 
virtual void accept (AttributeFunctor &)
 accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. More...
 
virtual bool supports (const PrimitiveIndexFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&). More...
 
virtual void accept (PrimitiveIndexFunctor &) const
 Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has. More...
 
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node. More...
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual GeometryasGeometry ()
 convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. More...
 
virtual const GeometryasGeometry () const
 convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. More...
 
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...
 
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...
 
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual OccluderNodeasOccluderNode ()
 Convert 'this' into an OccluderNode pointer if Node is an OccluderNode, otherwise return 0. More...
 
virtual const OccluderNodeasOccluderNode () const
 Convert 'const this' into a const OccluderNode pointer if Node is an OccluderNode, otherwise return 0. More...
 
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...
 
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...
 
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...
 
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor. More...
 
virtual void traverse (NodeVisitor &)
 Traverse downwards : calls children's accept method with NodeVisitor. More...
 
const ParentListgetParents () const
 Get the parent list of node. More...
 
ParentList getParents ()
 Get the a copy of parent list of node. More...
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 Get a single const parent of node. More...
 
unsigned int getNumParents () const
 Get the number of parents of node. More...
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths. More...
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates. More...
 
void setUpdateCallback (Callback *nc)
 Set update node callback, called during update traversal. More...
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 Get update node callback, called during update traversal. More...
 
const CallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal. More...
 
void addUpdateCallback (Callback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...
 
void setEventCallback (Callback *nc)
 Set event node callback, called during event traversal. More...
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 Get event node callback, called during event traversal. More...
 
const CallbackgetEventCallback () const
 Get const event node callback, called during event traversal. More...
 
void addEventCallback (Callback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...
 
void setCullCallback (Callback *nc)
 Set cull node callback, called during cull traversal. More...
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 Get cull node callback, called during cull traversal. More...
 
const CallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal. More...
 
void addCullCallback (Callback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive. More...
 
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node. More...
 
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled. More...
 
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...
 
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's. More...
 
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...
 
void setNodeMask (NodeMask nm)
 Set the node mask. More...
 
NodeMask getNodeMask () const
 Get the node Mask. More...
 
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet. More...
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...
 
osg::StateSetgetStateSet ()
 Return the node's StateSet. More...
 
const osg::StateSetgetStateSet () const
 Return the node's const StateSet. More...
 
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions. More...
 
DescriptionListgetDescriptions ()
 Get the description list of the node. More...
 
const DescriptionListgetDescriptions () const
 Get the const description list of the const node. More...
 
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node. More...
 
std::string & getDescription (unsigned int i)
 Get a single description of the node. More...
 
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node. More...
 
void addDescription (const std::string &desc)
 Add a description string to the node. More...
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
void dirtyBound ()
 Mark this node's bounding sphere dirty. More...
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound. More...
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback. More...
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 Get the const compute bound callback. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 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. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~Text ()
 
virtual osg::StateSetcreateStateSet ()
 
FontgetActiveFont ()
 
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 computePositionsImplementation ()
 
void computeColorGradients ()
 
void computeColorGradientsOverall ()
 
void computeColorGradientsPerCharacter ()
 
void drawImplementation (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void drawImplementationSinglePass (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 ()
 
virtual void assignStateSet ()
 
void initArraysAndBuffers ()
 
osg::VertexArrayStatecreateVertexArrayStateImplementation (osg::RenderInfo &renderInfo) const
 Implementation of Create the VertexArrayState object. More...
 
void positionCursor (const osg::Vec2 &endOfLine_coords, osg::Vec2 &cursor, unsigned int linelength)
 
String::iterator computeLastCharacterOnLine (osg::Vec2 &cursor, String::iterator first, String::iterator last)
 
void computePositions ()
 
void setupDecoration ()
 
unsigned int addCoord (const osg::Vec2 &c)
 
unsigned int addCoord (const osg::Vec3 &c)
 
void addTexCoord (const osg::Vec2 &tc)
 
- Protected Member Functions inherited from osg::Drawable
Drawableoperator= (const Drawable &)
 
virtual ~Drawable ()
 
void setBound (const BoundingBox &bb) const
 set the bounding box . More...
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor. More...
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

TextureGlyphQuadMap _textureGlyphQuadMap
 
ShaderTechnique _shaderTechnique
 
bool _enableDepthWrites
 
BackdropType _backdropType
 
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< Font_fontFallback
 
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
 
bool _glyphNormalized
 
osg::Vec3 _offset
 
osg::Vec3 _normal
 
osg::BoundingBox _textBB
 
osg::BoundingBox _textBBWithMargin
 
osg::Matrix _matrix
 
Primitives _decorationPrimitives
 
osg::ref_ptr< osg::VertexBufferObject_vbo
 
osg::ref_ptr< osg::ElementBufferObject_ebo
 
Coords _coords
 
Coords _normals
 
ColorCoords _colorCoords
 
TexCoords _texcoords
 
- Protected Attributes inherited from osg::Drawable
BoundingBox _initialBoundingBox
 
ref_ptr< ComputeBoundingBoxCallback_computeBoundingBoxCallback
 
BoundingBox _boundingBox
 
ref_ptr< Shape_shape
 
bool _supportsDisplayList
 
bool _useDisplayList
 
bool _supportsVertexBufferObjects
 
bool _useVertexBufferObjects
 
bool _useVertexArrayObject
 
GLObjectList _globjList
 
VertexArrayStateList _vertexArrayStateList
 
ref_ptr< DrawCallback_drawCallback
 
ref_ptr< CreateVertexArrayStateCallback_createVertexArrayStateCallback
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- 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)
 Return a OpenGL display list handle a newly generated or reused from display list cache. More...
 
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
 Use deleteDisplayList instead of glDeleteList to allow OpenGL display list to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID. More...
 
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 Set the minimum number of display lists to retain in the deleted display list cache. More...
 
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 Get the minimum number of display lists to retain in the deleted display list cache. More...
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Types inherited from osgText::TextBase
typedef osg::ref_ptr< osg::Vec2ArrayTexCoords
 
typedef osg::ref_ptr< osg::Vec4ArrayColorCoords
 
typedef std::vector< osg::ref_ptr< osg::DrawElements > > Primitives
 
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value< GLuint > GLObjectList
 

Member Typedef Documentation

◆ TextureGlyphQuadMap

Member Enumeration Documentation

◆ BackdropImplementation

deprecated, value ignored.

Enumerator
POLYGON_OFFSET 
NO_DEPTH_BUFFER 
DEPTH_RANGE 
STENCIL_BUFFER 
DELAYED_DEPTH_WRITES 

◆ 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 

◆ ColorGradientMode

Enumerator
SOLID 
PER_CHARACTER 
OVERALL 

Constructor & Destructor Documentation

◆ Text() [1/2]

osgText::Text::Text ( )

◆ Text() [2/2]

osgText::Text::Text ( const Text text,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

◆ ~Text()

virtual osgText::Text::~Text ( )
protectedvirtual

Member Function Documentation

◆ accept() [1/2]

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.

◆ accept() [2/2]

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.

◆ addGlyphQuad()

void osgText::Text::addGlyphQuad ( Glyph glyph,
const osg::Vec2 minc,
const osg::Vec2 maxc,
const osg::Vec2 mintc,
const osg::Vec2 maxtc 
)

◆ bilinearInterpolate()

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

◆ className()

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

return the name of the node's class type.

Reimplemented from osgText::TextBase.

◆ clone()

virtual osg::Object* osgText::Text::clone ( const osg::CopyOp copyop) const
inlinevirtual

return a clone of a node, with Object* return type.

Reimplemented from osg::Node.

◆ cloneType()

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

clone an object of the same type as the node.

Reimplemented from osg::Node.

◆ computeAverageGlyphWidthAndHeight()

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

◆ computeColorGradients()

void osgText::Text::computeColorGradients ( )
protected

◆ computeColorGradientsOverall()

void osgText::Text::computeColorGradientsOverall ( )
protected

◆ computeColorGradientsPerCharacter()

void osgText::Text::computeColorGradientsPerCharacter ( )
protected

◆ computeGlyphRepresentation()

void osgText::Text::computeGlyphRepresentation ( )
protectedvirtual

Implements osgText::TextBase.

◆ computeLastCharacterOnLine()

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

◆ computePositionsImplementation()

virtual void osgText::Text::computePositionsImplementation ( )
protectedvirtual

Reimplemented from osgText::TextBase.

◆ createStateSet()

virtual osg::StateSet* osgText::Text::createStateSet ( )
protectedvirtual

Reimplemented from osgText::TextBase.

◆ drawImplementation() [1/2]

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

Draw the text.

Reimplemented from osg::Drawable.

Reimplemented in osgText::FadeText.

◆ drawImplementation() [2/2]

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

◆ drawImplementationSinglePass()

void osgText::Text::drawImplementationSinglePass ( osg::State state,
const osg::Vec4 colorMultiplier 
) const
protected

◆ getActiveFont()

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

◆ getBackdropColor()

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

◆ getBackdropHorizontalOffset()

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

◆ getBackdropImplementation()

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

deprecated, value should be ignored.

◆ getBackdropType()

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

◆ getBackdropVerticalOffset()

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

◆ getCharacterCorners()

bool osgText::Text::getCharacterCorners ( unsigned int  index,
osg::Vec3 bottomLeft,
osg::Vec3 bottomRight,
osg::Vec3 topLeft,
osg::Vec3 topRight 
) const

Get the coordinates of the character corners in local coordinates.

Use Text::getMatrix() or Text::computeMatrix(..) to get the transform into model coordinates (see TextBase header.)

◆ getColorGradientBottomLeft()

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

◆ getColorGradientBottomRight()

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

◆ getColorGradientMode()

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

◆ getColorGradientTopLeft()

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

◆ getColorGradientTopRight()

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

◆ getEnableDepthWrites()

bool osgText::Text::getEnableDepthWrites ( ) const
inline

◆ getGlyphQuads()

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

Direct Access to GlyphQuads.

References NULL.

◆ getShaderTechnique()

ShaderTechnique osgText::Text::getShaderTechnique ( )
inline

Get the ShaderTechnique hint.

◆ getTextureGlyphQuadMap()

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

◆ isSameKindAs()

virtual bool osgText::Text::isSameKindAs ( const osg::Object obj) const
inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osgText::TextBase.

References NULL.

◆ libraryName()

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

return the name of the node's library.

Reimplemented from osgText::TextBase.

◆ releaseGLObjects()

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.

◆ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osgText::TextBase.

◆ setBackdropColor()

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

This specifies the color of the backdrop text.

The default is black.

◆ setBackdropImplementation()

void osgText::Text::setBackdropImplementation ( BackdropImplementation  )
inline

deprecated, value ignored.

◆ setBackdropOffset() [1/2]

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

◆ setBackdropOffset() [2/2]

void osgText::Text::setBackdropOffset ( float  horizontal,
float  vertical 
)

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

◆ setBackdropType()

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 DROP_SHADOW_* modes do the same for their respective 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.

◆ setColorGradientCorners()

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.

◆ setColorGradientMode()

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

◆ setEnableDepthWrites()

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.

◆ setShaderTechnique()

void osgText::Text::setShaderTechnique ( ShaderTechnique  technique)

Set the ShaderTechnique hint to specify what fatures in the text shaders to enable.

◆ supports() [1/3]

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

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

Reimplemented from osg::Drawable.

◆ supports() [2/3]

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

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

Reimplemented from osg::Drawable.

◆ supports() [3/3]

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

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

Reimplemented from osg::Drawable.

References osg::releaseGLObjects(), and osg::resizeGLObjectBuffers().

Member Data Documentation

◆ _backdropColor

osg::Vec4 osgText::Text::_backdropColor
protected

◆ _backdropHorizontalOffset

float osgText::Text::_backdropHorizontalOffset
protected

◆ _backdropType

BackdropType osgText::Text::_backdropType
protected

◆ _backdropVerticalOffset

float osgText::Text::_backdropVerticalOffset
protected

◆ _colorGradientBottomLeft

osg::Vec4 osgText::Text::_colorGradientBottomLeft
protected

◆ _colorGradientBottomRight

osg::Vec4 osgText::Text::_colorGradientBottomRight
protected

◆ _colorGradientMode

ColorGradientMode osgText::Text::_colorGradientMode
protected

◆ _colorGradientTopLeft

osg::Vec4 osgText::Text::_colorGradientTopLeft
protected

◆ _colorGradientTopRight

osg::Vec4 osgText::Text::_colorGradientTopRight
protected

◆ _enableDepthWrites

bool osgText::Text::_enableDepthWrites
protected

◆ _shaderTechnique

ShaderTechnique osgText::Text::_shaderTechnique
protected

◆ _textureGlyphQuadMap

TextureGlyphQuadMap osgText::Text::_textureGlyphQuadMap
protected

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