OpenSceneGraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgText::TextBase Class Referenceabstract
Inheritance diagram for osgText::TextBase:
Inheritance graph
[legend]

Public Types

enum  CharacterSizeMode { OBJECT_COORDS, SCREEN_COORDS, OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT }
 
enum  AlignmentType {
  LEFT_TOP, LEFT_CENTER, LEFT_BOTTOM, CENTER_TOP,
  CENTER_CENTER, CENTER_BOTTOM, RIGHT_TOP, RIGHT_CENTER,
  RIGHT_BOTTOM, LEFT_BASE_LINE, CENTER_BASE_LINE, RIGHT_BASE_LINE,
  LEFT_BOTTOM_BASE_LINE, CENTER_BOTTOM_BASE_LINE, RIGHT_BOTTOM_BASE_LINE, BASE_LINE = LEFT_BASE_LINE
}
 
enum  AxisAlignment {
  XY_PLANE, REVERSED_XY_PLANE, XZ_PLANE, REVERSED_XZ_PLANE,
  YZ_PLANE, REVERSED_YZ_PLANE, SCREEN, USER_DEFINED_ROTATION
}
 
enum  Layout { LEFT_TO_RIGHT, RIGHT_TO_LEFT, VERTICAL }
 
enum  DrawModeMask { TEXT = 1, BOUNDINGBOX = 2, 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

 TextBase ()
 
 TextBase (const TextBase &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
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 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 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...
 
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 drawImplementation (RenderInfo &) const
 drawImplementation(RenderInfo&) is a pure virtual method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable. More...
 
virtual bool supports (const AttributeFunctor &) const
 Return true if the Drawable subclass supports accept(AttributeFunctor&). 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 ConstAttributeFunctor &) const
 Return true if the Drawable subclass supports accept(ConstAttributeFunctor&). More...
 
virtual void accept (ConstAttributeFunctor &) const
 Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. More...
 
virtual bool supports (const PrimitiveFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveFunctor&). More...
 
virtual void accept (PrimitiveFunctor &) const
 Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives 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 ObjectcloneType () const
 clone an object of the same type as the node. More...
 
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type. 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 Types

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
 

Protected Member Functions

virtual ~TextBase ()
 
virtual osg::StateSetcreateStateSet ()
 
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 ()
 
virtual void computePositionsImplementation ()
 
virtual void computeGlyphRepresentation ()=0
 
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

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

Member Typedef Documentation

◆ ColorCoords

◆ Coords

◆ Primitives

◆ TexCoords

Member Enumeration Documentation

◆ AlignmentType

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

◆ AxisAlignment

Enumerator
XY_PLANE 
REVERSED_XY_PLANE 
XZ_PLANE 
REVERSED_XZ_PLANE 
YZ_PLANE 
REVERSED_YZ_PLANE 
SCREEN 
USER_DEFINED_ROTATION 

◆ CharacterSizeMode

Enumerator
OBJECT_COORDS 
SCREEN_COORDS 

default

OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT 

internally scale the characters to be constant screen size.

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

◆ DrawModeMask

Enumerator
TEXT 
BOUNDINGBOX 

default

FILLEDBOUNDINGBOX 
ALIGNMENT 

◆ Layout

Enumerator
LEFT_TO_RIGHT 
RIGHT_TO_LEFT 

default

VERTICAL 

Constructor & Destructor Documentation

◆ TextBase() [1/2]

osgText::TextBase::TextBase ( )

◆ TextBase() [2/2]

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

◆ ~TextBase()

virtual osgText::TextBase::~TextBase ( )
protectedvirtual

Member Function Documentation

◆ addCoord() [1/2]

unsigned int osgText::TextBase::addCoord ( const osg::Vec2 c)
inlineprotected

◆ addCoord() [2/2]

unsigned int osgText::TextBase::addCoord ( const osg::Vec3 c)
inlineprotected

◆ addTexCoord()

void osgText::TextBase::addTexCoord ( const osg::Vec2 tc)
inlineprotected

◆ assignStateSet()

virtual void osgText::TextBase::assignStateSet ( )
protectedvirtual

◆ className()

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

return the name of the node's class type.

Reimplemented from osg::Node.

Reimplemented in osgText::Text.

◆ compileGLObjects()

virtual void osgText::TextBase::compileGLObjects ( osg::RenderInfo renderInfo) const
virtual

Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.

Note
Operation is ignored if _useDisplayList is false or VertexBufferObjects are not used.

Reimplemented from osg::Drawable.

◆ computeBoundingBox()

virtual osg::BoundingBox osgText::TextBase::computeBoundingBox ( ) const
virtual

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text3D.

◆ computeGlyphRepresentation()

virtual void osgText::TextBase::computeGlyphRepresentation ( )
protectedpure virtual

Implemented in osgText::Text, and osgText::Text3D.

◆ computeLastCharacterOnLine()

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

◆ computeMatrix()

bool osgText::TextBase::computeMatrix ( osg::Matrix matrix,
osg::State state = 0 
) const

compute the matrix that positions the text in model space for the given viewpoint.

◆ computePositions()

void osgText::TextBase::computePositions ( )
protected

◆ computePositionsImplementation()

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

Reimplemented in osgText::Text.

◆ createStateSet()

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

Reimplemented in osgText::Text.

◆ createVertexArrayStateImplementation()

osg::VertexArrayState* osgText::TextBase::createVertexArrayStateImplementation ( osg::RenderInfo renderInfo) const
protectedvirtual

Implementation of Create the VertexArrayState object.

Reimplemented from osg::Drawable.

◆ getAlignment()

AlignmentType osgText::TextBase::getAlignment ( ) const
inline

◆ getAutoRotateToScreen()

bool osgText::TextBase::getAutoRotateToScreen ( ) const
inline

◆ getAxisAlignment()

AxisAlignment osgText::TextBase::getAxisAlignment ( ) const
inline

◆ getBoundingBoxColor()

const osg::Vec4& osgText::TextBase::getBoundingBoxColor ( ) const
inline

◆ getBoundingBoxMargin()

float osgText::TextBase::getBoundingBoxMargin ( ) const
inline

◆ getCharacterAspectRatio()

float osgText::TextBase::getCharacterAspectRatio ( ) const
inline

◆ getCharacterHeight()

float osgText::TextBase::getCharacterHeight ( ) const
inline

◆ getCharacterSizeMode()

CharacterSizeMode osgText::TextBase::getCharacterSizeMode ( ) const
inline

Get the CharacterSizeMode.

◆ getColor()

const osg::Vec4& osgText::TextBase::getColor ( ) const
inline

◆ getCoord() [1/2]

void osgText::TextBase::getCoord ( unsigned int  i,
osg::Vec2 c 
) const
inline

References osg::Vec2f::set().

◆ getCoord() [2/2]

void osgText::TextBase::getCoord ( unsigned int  i,
osg::Vec3 c 
) const
inline

◆ getCoords() [1/2]

Coords& osgText::TextBase::getCoords ( )
inline

◆ getCoords() [2/2]

const Coords& osgText::TextBase::getCoords ( ) const
inline

◆ getDrawMode()

unsigned int osgText::TextBase::getDrawMode ( ) const
inline

◆ getFont() [1/2]

Font* osgText::TextBase::getFont ( )
inline

Get the font.

Return 0 if default is being used.

◆ getFont() [2/2]

const Font* osgText::TextBase::getFont ( ) const
inline

Get the const font.

Return 0 if default is being used.

◆ getFontHeight()

unsigned int osgText::TextBase::getFontHeight ( ) const
inline

◆ getFontWidth()

unsigned int osgText::TextBase::getFontWidth ( ) const
inline

◆ getKerningType()

KerningType osgText::TextBase::getKerningType ( ) const
inline

◆ getLayout()

Layout osgText::TextBase::getLayout ( ) const
inline

◆ getLineCount()

unsigned int osgText::TextBase::getLineCount ( ) const
inline

Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise.

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

◆ getLineSpacing()

float osgText::TextBase::getLineSpacing ( ) const
inline

Get the line spacing of the text box.

◆ getMatrix()

const osg::Matrix& osgText::TextBase::getMatrix ( ) const
inline

Get the cached internal matrix used to provide positioning of text.

The cached matrix is originally computed by computeMatrix(..).

◆ getMaximumHeight()

float osgText::TextBase::getMaximumHeight ( ) const
inline

Get the maximum height of the text box.

◆ getMaximumWidth()

float osgText::TextBase::getMaximumWidth ( ) const
inline

Get the maximim width of the text box.

◆ getOrCreateStyle()

Style* osgText::TextBase::getOrCreateStyle ( )
inline

Get or create the text style.

◆ getPosition()

const osg::Vec3& osgText::TextBase::getPosition ( ) const
inline

Get the position of text.

◆ getRotation()

const osg::Quat& osgText::TextBase::getRotation ( ) const
inline

◆ getStyle() [1/2]

Style* osgText::TextBase::getStyle ( )
inline

Get the text style.

◆ getStyle() [2/2]

const Style* osgText::TextBase::getStyle ( ) const
inline

Get the const text style.

◆ getText() [1/2]

String& osgText::TextBase::getText ( )
inline

Get the text string.

Note, if you modify the string you must call Text::update() for the internal glyph reprentation to be updated.

◆ getText() [2/2]

const String& osgText::TextBase::getText ( ) const
inline

Get the const text string.

◆ initArraysAndBuffers()

void osgText::TextBase::initArraysAndBuffers ( )
protected

◆ isSameKindAs()

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

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

Reimplemented from osg::Node.

Reimplemented in osgText::Text.

References NULL.

◆ libraryName()

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

return the name of the node's library.

Reimplemented from osg::Node.

Reimplemented in osgText::Text.

◆ positionCursor()

void osgText::TextBase::positionCursor ( const osg::Vec2 endOfLine_coords,
osg::Vec2 cursor,
unsigned int  linelength 
)
protected

◆ releaseGLObjects()

virtual void osgText::TextBase::releaseGLObjects ( osg::State state = 0) const
virtual

If State is non-zero, this function releases OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objexts for all graphics contexts.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text, and osgText::Text3D.

◆ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text, and osgText::Text3D.

◆ setAlignment()

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

◆ setAutoRotateToScreen()

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

◆ setAxisAlignment()

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

◆ setBoundingBoxColor()

void osgText::TextBase::setBoundingBoxColor ( const osg::Vec4 color)
inline

◆ setBoundingBoxMargin()

void osgText::TextBase::setBoundingBoxMargin ( float  margin)

◆ setCharacterSize() [1/2]

void osgText::TextBase::setCharacterSize ( float  height)

Set the rendered character size in object coordinates.

◆ setCharacterSize() [2/2]

void osgText::TextBase::setCharacterSize ( float  height,
float  aspectRatio 
)

Set the rendered character size in object coordinates.

◆ setCharacterSizeMode()

void osgText::TextBase::setCharacterSizeMode ( CharacterSizeMode  mode)
inline

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

◆ setColor()

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

◆ setDrawMode()

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

◆ setFont() [1/3]

virtual void osgText::TextBase::setFont ( Font font = 0)
inlinevirtual

Set the Font to use to render the text.

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

References setFont().

Referenced by setFont().

◆ setFont() [2/3]

virtual void osgText::TextBase::setFont ( osg::ref_ptr< Font font)
virtual

Set the Font to use to render the text.

◆ setFont() [3/3]

virtual void osgText::TextBase::setFont ( const std::string &  fontfile)
virtual

Set the font, loaded from the specified front file, to use to render the text, setFont("") sets the use of the default font.

See the osgText::readFontFile function for how the font file will be located.

◆ setFontResolution()

void osgText::TextBase::setFontResolution ( unsigned int  width,
unsigned int  height 
)

Set the Font reference width and height resolution in texels.

Note, the size may not be supported by current font, the closest supported font size will be selected.

◆ setKerningType()

void osgText::TextBase::setKerningType ( KerningType  kerningType)
inline

◆ setLayout()

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

◆ setLineSpacing()

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

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

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

◆ setMaximumHeight()

void osgText::TextBase::setMaximumHeight ( float  maximumHeight)

Set the maximum height of the text box.

With horizontal layouts any characters which do not fit are wrapped around. 0 or negative values indicate that no maximum height is set, lines can be as long as they need be to fit the required text

◆ setMaximumWidth()

void osgText::TextBase::setMaximumWidth ( float  maximumWidth)

Set the maximum width of the text box.

With horizontal layouts any characters which do not fit are wrapped around. 0 or negative values indicate that no maximum width is set, lines can be as long as they need be to fit thre required text

◆ setPosition()

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

Set the position of text.

◆ setRotation()

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

◆ setStyle()

void osgText::TextBase::setStyle ( Style style)
inline

Set the text style.

◆ setText() [1/4]

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

Set the text using a osgText::String.

◆ setText() [2/4]

void osgText::TextBase::setText ( const std::string &  text)

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

◆ setText() [3/4]

void osgText::TextBase::setText ( const std::string &  text,
String::Encoding  encoding 
)

Set the text using a Unicode encoded std::string, which is converted to an internal TextString.

The encoding parameter specificies which Unicode encodeding is used in the std::string.

◆ setText() [4/4]

void osgText::TextBase::setText ( const wchar_t *  text)

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

◆ setupDecoration()

void osgText::TextBase::setupDecoration ( )
protected

◆ update()

void osgText::TextBase::update ( )
inline

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

Member Data Documentation

◆ _alignment

AlignmentType osgText::TextBase::_alignment
protected

◆ _autoRotateToScreen

bool osgText::TextBase::_autoRotateToScreen
protected

◆ _axisAlignment

AxisAlignment osgText::TextBase::_axisAlignment
protected

◆ _characterHeight

float osgText::TextBase::_characterHeight
protected

◆ _characterSizeMode

CharacterSizeMode osgText::TextBase::_characterSizeMode
protected

◆ _color

osg::Vec4 osgText::TextBase::_color
protected

◆ _colorCoords

ColorCoords osgText::TextBase::_colorCoords
protected

◆ _coords

Coords osgText::TextBase::_coords
protected

◆ _decorationPrimitives

Primitives osgText::TextBase::_decorationPrimitives
protected

◆ _drawMode

unsigned int osgText::TextBase::_drawMode
protected

◆ _ebo

osg::ref_ptr<osg::ElementBufferObject> osgText::TextBase::_ebo
protected

◆ _font

osg::ref_ptr<Font> osgText::TextBase::_font
protected

◆ _fontFallback

osg::ref_ptr<Font> osgText::TextBase::_fontFallback
protected

◆ _fontSize

FontResolution osgText::TextBase::_fontSize
protected

◆ _glyphNormalized

bool osgText::TextBase::_glyphNormalized
protected

◆ _kerningType

KerningType osgText::TextBase::_kerningType
protected

◆ _layout

Layout osgText::TextBase::_layout
protected

◆ _lineCount

unsigned int osgText::TextBase::_lineCount
protected

◆ _lineSpacing

float osgText::TextBase::_lineSpacing
protected

◆ _matrix

osg::Matrix osgText::TextBase::_matrix
mutableprotected

◆ _maximumHeight

float osgText::TextBase::_maximumHeight
protected

◆ _maximumWidth

float osgText::TextBase::_maximumWidth
protected

◆ _normal

osg::Vec3 osgText::TextBase::_normal
protected

◆ _normals

Coords osgText::TextBase::_normals
protected

◆ _offset

osg::Vec3 osgText::TextBase::_offset
protected

◆ _position

osg::Vec3 osgText::TextBase::_position
protected

◆ _rotation

osg::Quat osgText::TextBase::_rotation
protected

◆ _style

osg::ref_ptr<Style> osgText::TextBase::_style
protected

◆ _texcoords

TexCoords osgText::TextBase::_texcoords
protected

◆ _text

String osgText::TextBase::_text
protected

◆ _textBB

osg::BoundingBox osgText::TextBase::_textBB
protected

◆ _textBBColor

osg::Vec4 osgText::TextBase::_textBBColor
protected

◆ _textBBMargin

float osgText::TextBase::_textBBMargin
protected

◆ _textBBWithMargin

osg::BoundingBox osgText::TextBase::_textBBWithMargin
protected

◆ _vbo

osg::ref_ptr<osg::VertexBufferObject> osgText::TextBase::_vbo
protected

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