OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osgText::TextBase Class Reference
Inheritance diagram for osgText::TextBase:
Inheritance graph
[legend]

List of all members.

Classes

struct  AutoTransformCache

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 }
- Public Types inherited from osg::Drawable
enum  AttributeTypes {
  VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3,
  SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTRIBUTE_6 = 6, ATTRIBUTE_7 = 7,
  TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2,
  TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6,
  TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7
}
typedef std::vector< Node * > ParentList
 A vector of osg::Node pointers which is used to store the parent(s) of drawable.
typedef unsigned int AttributeType
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 TextBase ()
 TextBase (const TextBase &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * className () const
 return the name of the object's class type.
virtual const char * libraryName () const
 return the name of the object's library.
void setColor (const osg::Vec4 &color)
const osg::Vec4getColor () const
virtual void setFont (Font *font=0)
 Set the Font to use to render the text.
virtual void setFont (osg::ref_ptr< Font > font)
 Set the Font to use to render the text.
virtual void setFont (const std::string &fontfile)
 Set the font, loaded from the specified front file, to use to render the text, setFont("") sets the use of the default font.
const FontgetFont () const
 Get the font.
void setStyle (Style *style)
 Set the text style.
StylegetStyle ()
 Get the text style.
const StylegetStyle () const
 Get the const text style.
StylegetOrCreateStyle ()
 Get or create the text style.
void setFontResolution (unsigned int width, unsigned int height)
 Set the Font reference width and height resolution in texels.
unsigned int getFontWidth () const
unsigned int getFontHeight () const
void setText (const String &text)
 Set the text using a osgText::String.
void setText (const std::string &text)
 Set the text using a std::string, which is converted to an internal TextString.
void setText (const std::string &text, String::Encoding encoding)
 Set the text using a Unicode encoded std::string, which is converted to an internal TextString.
void setText (const wchar_t *text)
 Set the text using a wchar_t string, which is converted to an internal TextString.
StringgetText ()
 Get the text string.
const StringgetText () const
 Get the const text string.
void update ()
 update internal glyph respresentation used for rendering, and bounding volume.
void setCharacterSize (float height)
 Set the rendered character size in object coordinates.
void setCharacterSize (float height, float aspectRatio)
 Set the rendered character size in object coordinates.
float getCharacterHeight () const
float getCharacterAspectRatio () const
void setCharacterSizeMode (CharacterSizeMode mode)
 Set how the CharacterSize value relates to the final rendered character.
CharacterSizeMode getCharacterSizeMode () const
 Get the CharacterSizeMode.
void setMaximumWidth (float maximumWidth)
 Set the maximum width of the text box.
float getMaximumWidth () const
 Get the maximim width of the text box.
void setMaximumHeight (float maximumHeight)
 Set the maximum height of the text box.
float getMaximumHeight () const
 Get the maximum height of the text box.
void setLineSpacing (float lineSpacing)
 Set the line spacing of the text box, given as a percentage of the character height.
float getLineSpacing () const
 Get the line spacing of the text box.
void setPosition (const osg::Vec3 &pos)
 Set the position of text.
const osg::Vec3getPosition () const
 Get the position of text.
void setAlignment (AlignmentType alignment)
AlignmentType getAlignment () const
void setAxisAlignment (AxisAlignment axis)
AxisAlignment getAxisAlignment () const
void setRotation (const osg::Quat &quat)
const osg::QuatgetRotation () const
void setAutoRotateToScreen (bool autoRotateToScreen)
bool getAutoRotateToScreen () const
void setLayout (Layout layout)
Layout getLayout () const
void setDrawMode (unsigned int mode)
unsigned int getDrawMode () const
void setBoundingBoxMargin (float margin)
float getBoundingBoxMargin () const
void setBoundingBoxColor (const osg::Vec4 &color)
const osg::Vec4getBoundingBoxColor () const
void setKerningType (KerningType kerningType)
KerningType getKerningType () const
unsigned int getLineCount () const
 Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
virtual osg::BoundingBox computeBound () const
 Compute the bounding box around Drawables's geometry.
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual GeometryasGeometry ()
 Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual const GeometryasGeometry () const
 Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
const ParentListgetParents () const
 Get the parent list of drawable.
ParentList getParents ()
 Get the a copy of parent list of node.
NodegetParent (unsigned int i)
 Get a single parent of Drawable.
const NodegetParent (unsigned int i) const
 Get a single const parent of Drawable.
unsigned int getNumParents () const
 Get the number of parents of node.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setStateSet (StateSet *stateset)
 Set the StateSet attached to the Drawable.
StateSetgetStateSet ()
 Get the attached StateSet.
const StateSetgetStateSet () const
 Get the attached const StateSet.
StateSetgetOrCreateStateSet ()
 Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it.
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Dirty the bounding box, forcing a computeBound() on the next call to getBound().
const BoundingBoxgetBound () const
 Get BoundingBox of Drawable.
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback.
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback.
void setShape (Shape *shape)
 Set the Shape of the Drawable.
ShapegetShape ()
 Get the Shape of the Drawable.
const ShapegetShape () const
 Get the const Shape of the const Drawable.
void setSupportsDisplayList (bool flag)
 Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists.
bool getSupportsDisplayList () const
 Get whether display lists are supported for this drawable instance.
void setUseDisplayList (bool flag)
 When set to true, force the draw method to use OpenGL Display List for rendering.
bool getUseDisplayList () const
 Return whether OpenGL display lists are being used for rendering.
GLuint & getDisplayList (unsigned int contextID) const
 Return OpenGL display list for specified contextID.
virtual void setUseVertexBufferObjects (bool flag)
 When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
virtual void dirtyDisplayList ()
 Force a recompile on next draw() of any OpenGL display list associated with this geoset.
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
void draw (RenderInfo &renderInfo) const
 Draw OpenGL primitives.
virtual void compileGLObjects (RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
virtual void setUpdateCallback (UpdateCallback *ac)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
UpdateCallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const UpdateCallbackgetUpdateCallback () const
 Get the const UpdateCallback.
bool requiresUpdateTraversal () const
 Return whether this Drawable has update callbacks associated with it, and therefore must be traversed.
virtual void setEventCallback (EventCallback *ac)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
EventCallbackgetEventCallback ()
 Get the non const EventCallback.
const EventCallbackgetEventCallback () const
 Get the const EventCallback.
bool requiresEventTraversal () const
 Return whether this Drawable has event callbacks associated with it, and therefore must be traversed.
virtual void setCullCallback (CullCallback *cc)
 Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.
CullCallbackgetCullCallback ()
 Get the non const CullCallback.
const CullCallbackgetCullCallback () const
 Get the const CullCallback.
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback.
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback.
virtual void drawImplementation (RenderInfo &renderInfo) const =0
 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.
virtual bool supports (const AttributeFunctor &) const
 Return true if the Drawable subclass supports accept(AttributeFunctor&).
virtual void accept (AttributeFunctor &)
 accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const ConstAttributeFunctor &) const
 Return true if the Drawable subclass supports accept(ConstAttributeFunctor&).
virtual void accept (ConstAttributeFunctor &) const
 Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const PrimitiveFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveFunctor&).
virtual void accept (PrimitiveFunctor &) const
 Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has.
virtual bool supports (const PrimitiveIndexFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
virtual void accept (PrimitiveIndexFunctor &) const
 Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

virtual ~TextBase ()
void positionCursor (const osg::Vec2 &endOfLine_coords, osg::Vec2 &cursor, unsigned int linelength)
void computePositions ()
String::iterator computeLastCharacterOnLine (osg::Vec2 &cursor, String::iterator first, String::iterator last)
virtual void computePositions (unsigned int contextID) const =0
virtual void computeGlyphRepresentation ()=0
- Protected Member Functions inherited from osg::Drawable
Drawableoperator= (const Drawable &)
virtual ~Drawable ()
void setBound (const BoundingBox &bb) const
 set the bounding box .
void addParent (osg::Node *node)
void removeParent (osg::Node *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setNumChildrenRequiringEventTraversal (unsigned int num)
unsigned int getNumChildrenRequiringEventTraversal () const
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

osg::Vec4 _color
osg::ref_ptr< Font_font
osg::ref_ptr< Style_style
FontResolution _fontSize
float _characterHeight
CharacterSizeMode _characterSizeMode
float _maximumWidth
float _maximumHeight
float _lineSpacing
String _text
osg::Vec3 _position
AlignmentType _alignment
AxisAlignment _axisAlignment
osg::Quat _rotation
bool _autoRotateToScreen
Layout _layout
unsigned int _drawMode
float _textBBMargin
osg::Vec4 _textBBColor
KerningType _kerningType
unsigned int _lineCount
osg::buffered_object
< AutoTransformCache
_autoTransformCache
osg::Vec3 _offset
osg::Vec3 _normal
osg::BoundingBox _textBB
- Protected Attributes inherited from osg::Drawable
ParentList _parents
ref_ptr< StateSet_stateset
BoundingBox _initialBound
ref_ptr
< ComputeBoundingBoxCallback
_computeBoundCallback
BoundingBox _boundingBox
bool _boundingBoxComputed
ref_ptr< Shape_shape
bool _supportsDisplayList
bool _useDisplayList
bool _supportsVertexBufferObjects
bool _useVertexBufferObjects
GLObjectList _globjList
ref_ptr< UpdateCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< EventCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< CullCallback_cullCallback
ref_ptr< DrawCallback_drawCallback
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Static Public Member Functions inherited from osg::Drawable
static GLuint generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)
 Return a OpenGL display list handle a newly generated or reused from display list cache.
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 Set the minimum number of display lists to retain in the deleted display list cache.
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 Get the minimum number of display lists to retain in the deleted display list cache.
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.
static void flushAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
static void discardAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
static void flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
 Flush the cached display list which need to be deleted in the OpenGL context related to contextID.
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 Function to call to get the extension of a specified context.
static void setExtensions (unsigned int contextID, Extensions *extensions)
 setExtensions allows users to override the extensions across graphics contexts.
- Static Public Attributes inherited from osg::Drawable
static unsigned int s_numberDrawablesReusedLastInLastFrame
static unsigned int s_numberNewDrawablesInLastFrame
static unsigned int s_numberDeletedDrawablesInLastFrame
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value
< GLuint > 
GLObjectList

Member Enumeration Documentation

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 
Enumerator:
XY_PLANE 
REVERSED_XY_PLANE 
XZ_PLANE 
REVERSED_XZ_PLANE 
YZ_PLANE 
REVERSED_YZ_PLANE 
SCREEN 
USER_DEFINED_ROTATION 
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.

Enumerator:
TEXT 
BOUNDINGBOX 

default

FILLEDBOUNDINGBOX 
ALIGNMENT 
Enumerator:
LEFT_TO_RIGHT 
RIGHT_TO_LEFT 

default

VERTICAL 

Constructor & Destructor Documentation

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

Member Function Documentation

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

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text.

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

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text3D.

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

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

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

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

void osgText::TextBase::computePositions ( )
protected
virtual void osgText::TextBase::computePositions ( unsigned int  contextID) const
protectedpure virtual

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

AlignmentType osgText::TextBase::getAlignment ( ) const
inline
bool osgText::TextBase::getAutoRotateToScreen ( ) const
inline
AxisAlignment osgText::TextBase::getAxisAlignment ( ) const
inline
const osg::Vec4& osgText::TextBase::getBoundingBoxColor ( ) const
inline
float osgText::TextBase::getBoundingBoxMargin ( ) const
inline
float osgText::TextBase::getCharacterAspectRatio ( ) const
inline
float osgText::TextBase::getCharacterHeight ( ) const
inline
CharacterSizeMode osgText::TextBase::getCharacterSizeMode ( ) const
inline

Get the CharacterSizeMode.

const osg::Vec4& osgText::TextBase::getColor ( ) const
inline
unsigned int osgText::TextBase::getDrawMode ( ) const
inline
const Font* osgText::TextBase::getFont ( ) const
inline

Get the font.

Return 0 if default is being used.

unsigned int osgText::TextBase::getFontHeight ( ) const
inline
unsigned int osgText::TextBase::getFontWidth ( ) const
inline
KerningType osgText::TextBase::getKerningType ( ) const
inline
Layout osgText::TextBase::getLayout ( ) const
inline
unsigned int osgText::TextBase::getLineCount ( ) const
inline

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

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

Get the line spacing of the text box.

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

Get the maximum height of the text box.

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

Get the maximim width of the text box.

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

Get or create the text style.

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

Get the position of text.

const osg::Quat& osgText::TextBase::getRotation ( ) const
inline
Style* osgText::TextBase::getStyle ( )
inline

Get the text style.

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

Get the const text style.

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.

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

Get the const text string.

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

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text.

References NULL.

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

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::Drawable.

Reimplemented in osgText::Text.

void osgText::TextBase::positionCursor ( const osg::Vec2 endOfLine_coords,
osg::Vec2 cursor,
unsigned int  linelength 
)
protected
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.

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.

void osgText::TextBase::setAlignment ( AlignmentType  alignment)
void osgText::TextBase::setAutoRotateToScreen ( bool  autoRotateToScreen)
void osgText::TextBase::setAxisAlignment ( AxisAlignment  axis)
void osgText::TextBase::setBoundingBoxColor ( const osg::Vec4 color)
inline
void osgText::TextBase::setBoundingBoxMargin ( float  margin)
void osgText::TextBase::setCharacterSize ( float  height)

Set the rendered character size in object coordinates.

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

Set the rendered character size in object coordinates.

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

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

void osgText::TextBase::setColor ( const osg::Vec4 color)
void osgText::TextBase::setDrawMode ( unsigned int  mode)
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.

Reimplemented in osgText::Text.

References setFont().

Referenced by setFont(), and osgText::Text::setFont().

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

Set the Font to use to render the text.

Reimplemented in osgText::Text.

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.

Reimplemented in osgText::Text.

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.

void osgText::TextBase::setKerningType ( KerningType  kerningType)
inline
void osgText::TextBase::setLayout ( Layout  layout)
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.

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

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

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

Set the position of text.

void osgText::TextBase::setRotation ( const osg::Quat quat)
void osgText::TextBase::setStyle ( Style style)
inline

Set the text style.

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

Set the text using a osgText::String.

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

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

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.

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

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

virtual void osgText::TextBase::setThreadSafeRefUnref ( bool  threadSafe)
virtual

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

Reimplemented from osg::Drawable.

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

void osgText::TextBase::update ( )
inline

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


Member Data Documentation

AlignmentType osgText::TextBase::_alignment
protected
bool osgText::TextBase::_autoRotateToScreen
protected
osg::buffered_object<AutoTransformCache> osgText::TextBase::_autoTransformCache
mutableprotected
AxisAlignment osgText::TextBase::_axisAlignment
protected
float osgText::TextBase::_characterHeight
protected
CharacterSizeMode osgText::TextBase::_characterSizeMode
protected
osg::Vec4 osgText::TextBase::_color
protected
unsigned int osgText::TextBase::_drawMode
protected
osg::ref_ptr<Font> osgText::TextBase::_font
protected
FontResolution osgText::TextBase::_fontSize
protected
KerningType osgText::TextBase::_kerningType
protected
Layout osgText::TextBase::_layout
protected
unsigned int osgText::TextBase::_lineCount
protected
float osgText::TextBase::_lineSpacing
protected
float osgText::TextBase::_maximumHeight
protected
float osgText::TextBase::_maximumWidth
protected
osg::Vec3 osgText::TextBase::_normal
mutableprotected
osg::Vec3 osgText::TextBase::_offset
mutableprotected
osg::Vec3 osgText::TextBase::_position
protected
osg::Quat osgText::TextBase::_rotation
protected
osg::ref_ptr<Style> osgText::TextBase::_style
protected
String osgText::TextBase::_text
protected
osg::BoundingBox osgText::TextBase::_textBB
mutableprotected
osg::Vec4 osgText::TextBase::_textBBColor
protected
float osgText::TextBase::_textBBMargin
protected

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

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