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

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 unsigned int AttributeType
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- 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
 
virtual const char * libraryName () const
 
void setColor (const osg::Vec4 &color)
 
const osg::Vec4getColor () const
 
virtual void setFont (Font *font=0)
 
virtual void setFont (osg::ref_ptr< Font > font)
 
virtual void setFont (const std::string &fontfile)
 
const FontgetFont () const
 
void setStyle (Style *style)
 
StylegetStyle ()
 
const StylegetStyle () const
 
StylegetOrCreateStyle ()
 
void setFontResolution (unsigned int width, unsigned int height)
 
unsigned int getFontWidth () const
 
unsigned int getFontHeight () const
 
void setText (const String &text)
 
void setText (const std::string &text)
 
void setText (const std::string &text, String::Encoding encoding)
 
void setText (const wchar_t *text)
 
StringgetText ()
 
const StringgetText () const
 
void update ()
 
void setCharacterSize (float height)
 
void setCharacterSize (float height, float aspectRatio)
 
float getCharacterHeight () const
 
float getCharacterAspectRatio () const
 
void setCharacterSizeMode (CharacterSizeMode mode)
 
CharacterSizeMode getCharacterSizeMode () const
 
void setMaximumWidth (float maximumWidth)
 
float getMaximumWidth () const
 
void setMaximumHeight (float maximumHeight)
 
float getMaximumHeight () const
 
void setLineSpacing (float lineSpacing)
 
float getLineSpacing () const
 
void setPosition (const osg::Vec3 &pos)
 
const osg::Vec3getPosition () const
 
void setAlignment (AlignmentType alignment)
 
AlignmentType getAlignment () const
 
void setAxisAlignment (AxisAlignment axis)
 
AxisAlignment getAxisAlignment () const
 
void setRotation (const osg::Quat &quat)
 
const osg::QuatgetRotation () const
 
void setAutoRotateToScreen (bool autoRotateToScreen)
 
bool getAutoRotateToScreen () const
 
void setLayout (Layout layout)
 
Layout getLayout () const
 
void setDrawMode (unsigned int mode)
 
unsigned int getDrawMode () const
 
void setBoundingBoxMargin (float margin)
 
float getBoundingBoxMargin () const
 
void setBoundingBoxColor (const osg::Vec4 &color)
 
const osg::Vec4getBoundingBoxColor () const
 
void setKerningType (KerningType kerningType)
 
KerningType getKerningType () const
 
unsigned int getLineCount () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *state=0) const
 
virtual osg::BoundingBox computeBoundingBox () const
 
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Drawable)
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual void computeDataVariance ()
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setInitialBound (const osg::BoundingBox &bbox)
 
const BoundingBoxgetInitialBound () const
 
const BoundingSpheregetBound () const
 
const BoundingBoxgetBoundingBox () const
 
virtual BoundingSphere computeBound () const
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 
void setShape (Shape *shape)
 
template<class T >
void setShape (const ref_ptr< T > &shape)
 
ShapegetShape ()
 
const ShapegetShape () const
 
void setSupportsDisplayList (bool flag)
 
bool getSupportsDisplayList () const
 
void setUseDisplayList (bool flag)
 
bool getUseDisplayList () const
 
GLuint & getDisplayList (unsigned int contextID) const
 
virtual void setUseVertexBufferObjects (bool flag)
 
bool getUseVertexBufferObjects () const
 
virtual void dirtyDisplayList ()
 
virtual unsigned int getGLObjectSizeHint () const
 
void draw (RenderInfo &renderInfo) const
 
virtual void compileGLObjects (RenderInfo &renderInfo) const
 
virtual void setDrawCallback (DrawCallback *dc)
 
DrawCallbackgetDrawCallback ()
 
const DrawCallbackgetDrawCallback () const
 
virtual void drawImplementation (RenderInfo &) const
 
virtual bool supports (const AttributeFunctor &) const
 
virtual void accept (AttributeFunctor &)
 
virtual bool supports (const ConstAttributeFunctor &) const
 
virtual void accept (ConstAttributeFunctor &) const
 
virtual bool supports (const PrimitiveFunctor &) const
 
virtual void accept (PrimitiveFunctor &) const
 
virtual bool supports (const PrimitiveIndexFunctor &) const
 
virtual void accept (PrimitiveIndexFunctor &) const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
virtual void traverse (NodeVisitor &)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~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
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
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 ()
 
- 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
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_drawableUpdateCallback
 
ref_ptr< EventCallback_drawableEventCallback
 
ref_ptr< CullCallback_drawableCullCallback
 
ref_ptr< DrawCallback_drawCallback
 
- 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)
 
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
 
static void flushAllDeletedDisplayLists (unsigned int contextID)
 
static void discardAllDeletedDisplayLists (unsigned int contextID)
 
static void flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- 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 node's class type.

Reimplemented from osg::Node.

Reimplemented in osgText::Text.

virtual osg::BoundingBox osgText::TextBase::computeBoundingBox ( ) 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
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

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

Reimplemented from osg::Node.

Reimplemented in osgText::Text.

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

return the name of the node's library.

Reimplemented from osg::Node.

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.

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: