openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgText::TextBase Class Referenceabstract

#include <TextBase>

Inheritance diagram for osgText::TextBase:
osg::Drawable osg::Node osg::Object osg::Referenced osgText::Text osgText::Text3D osgText::FadeText

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
 
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)
 
FontgetFont ()
 
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 compileGLObjects (osg::RenderInfo &renderInfo) const
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *state=0) const
 
virtual osg::BoundingBox computeBoundingBox () const
 
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
 
bool computeMatrix (osg::Matrix &matrix, osg::State *state=0) 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
 
virtual 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
 
void setUseVertexArrayObject (bool flag)
 
bool getUseVertexArrayObject () const
 
virtual void dirtyGLObjects ()
 
virtual unsigned int getGLObjectSizeHint () const
 
void draw (RenderInfo &renderInfo) const
 
void drawInner (RenderInfo &renderInfo) const
 
void setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
 
CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback ()
 
const CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback () const
 
VertexArrayStatecreateVertexArrayState (RenderInfo &renderInfo) const
 
void setVertexArrayStateList (VertexArrayStateList &vasl)
 
VertexArrayStateListgetVertexArrayStateList ()
 
const VertexArrayStateListgetVertexArrayStateList () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
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 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 StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () 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 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
 
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
 
- 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< 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)
 
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
 
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

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

◆ 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

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

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

◆ setFont() [2/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.

◆ setFont() [3/3]

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

Set the Font to use to render the text.

◆ 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 std::string &  text)

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

◆ setText() [2/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() [3/4]

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

Set the text using a osgText::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: