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

Classes

struct  GlyphRenderInfo
 

Public Types

enum  RenderMode { PER_FACE, PER_GLYPH }
 
- Public Types inherited from osgText::TextBase
enum  CharacterSizeMode { OBJECT_COORDS, SCREEN_COORDS, OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT }
 
enum  AlignmentType {
  LEFT_TOP, LEFT_CENTER, LEFT_BOTTOM, CENTER_TOP,
  CENTER_CENTER, CENTER_BOTTOM, RIGHT_TOP, RIGHT_CENTER,
  RIGHT_BOTTOM, LEFT_BASE_LINE, CENTER_BASE_LINE, RIGHT_BASE_LINE,
  LEFT_BOTTOM_BASE_LINE, CENTER_BOTTOM_BASE_LINE, RIGHT_BOTTOM_BASE_LINE, BASE_LINE = LEFT_BASE_LINE
}
 
enum  AxisAlignment {
  XY_PLANE, REVERSED_XY_PLANE, XZ_PLANE, REVERSED_XZ_PLANE,
  YZ_PLANE, REVERSED_YZ_PLANE, SCREEN, USER_DEFINED_ROTATION
}
 
enum  Layout { LEFT_TO_RIGHT, RIGHT_TO_LEFT, VERTICAL }
 
enum  DrawModeMask { TEXT = 1, BOUNDINGBOX = 2, FILLEDBOUNDINGBOX = 4, ALIGNMENT = 8 }
 
- 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
 
typedef unsigned int AttributeType
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Text3D ()
 
 Text3D (const Text3D &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgText, Text3D) float getCharacterDepth() const
 
void setCharacterDepth (float characterDepth)
 
RenderMode getRenderMode () const
 
void setRenderMode (RenderMode renderMode)
 
osg::StateSetgetWallStateSet ()
 
const osg::StateSetgetWallStateSet () const
 
osg::StateSetgetOrCreateWallStateSet ()
 
void setWallStateSet (osg::StateSet *wallStateSet)
 
osg::StateSetgetBackStateSet ()
 
osg::StateSetgetBackStateSet () const
 
osg::StateSetgetOrCreateBackStateSet ()
 
void setBackStateSet (osg::StateSet *backStateSet)
 
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
 
virtual bool supports (const osg::Drawable::AttributeFunctor &) const
 
virtual bool supports (const osg::Drawable::ConstAttributeFunctor &) const
 
virtual void accept (osg::Drawable::ConstAttributeFunctor &af) const
 
virtual bool supports (const osg::PrimitiveFunctor &) const
 
virtual void accept (osg::PrimitiveFunctor &pf) const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *state=0) const
 
virtual osg::BoundingBox computeBound () const
 
- Public Member Functions inherited from osgText::TextBase
 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
 
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual void computeDataVariance ()
 
const ParentListgetParents () const
 
ParentList getParents ()
 
NodegetParent (unsigned int i)
 
const NodegetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setStateSet (StateSet *stateset)
 
StateSetgetStateSet ()
 
const StateSetgetStateSet () const
 
StateSetgetOrCreateStateSet ()
 
void setInitialBound (const osg::BoundingBox &bbox)
 
const BoundingBoxgetInitialBound () const
 
void dirtyBound ()
 
const BoundingBoxgetBound () const
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 
void setShape (Shape *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 setUpdateCallback (UpdateCallback *ac)
 
UpdateCallbackgetUpdateCallback ()
 
const UpdateCallbackgetUpdateCallback () const
 
bool requiresUpdateTraversal () const
 
virtual void setEventCallback (EventCallback *ac)
 
EventCallbackgetEventCallback ()
 
const EventCallbackgetEventCallback () const
 
bool requiresEventTraversal () const
 
virtual void setCullCallback (CullCallback *cc)
 
CullCallbackgetCullCallback ()
 
const CullCallbackgetCullCallback () const
 
virtual void setDrawCallback (DrawCallback *dc)
 
DrawCallbackgetDrawCallback ()
 
const DrawCallbackgetDrawCallback () const
 
virtual void accept (AttributeFunctor &)
 
virtual bool supports (const PrimitiveIndexFunctor &) const
 
virtual void accept (PrimitiveIndexFunctor &) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
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)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
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 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 std::vector
< GlyphRenderInfo
LineRenderInfo
 
typedef std::vector
< LineRenderInfo
TextRenderInfo
 

Protected Member Functions

virtual ~Text3D ()
 
void renderPerGlyph (osg::State &state) const
 
void renderPerFace (osg::State &state) const
 
String::iterator computeLastCharacterOnLine (osg::Vec2 &cursor, String::iterator first, String::iterator last)
 
void computeGlyphRepresentation ()
 
void computePositions (unsigned int contextID) const
 
- Protected Member Functions inherited from osgText::TextBase
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)
 
- Protected Member Functions inherited from osg::Drawable
Drawableoperator= (const Drawable &)
 
virtual ~Drawable ()
 
void setBound (const BoundingBox &bb) const
 
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 ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

TextRenderInfo _textRenderInfo
 
RenderMode _renderMode
 
osg::ref_ptr< osg::StateSet_wallStateSet
 
osg::ref_ptr< osg::StateSet_backStateSet
 
- Protected Attributes inherited from osgText::TextBase
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
 

Friends

class Font
 

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 ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 
static void setExtensions (unsigned int contextID, Extensions *extensions)
 
- Static Public Attributes inherited from osg::Drawable
static unsigned int s_numberDrawablesReusedLastInLastFrame
 
static unsigned int s_numberNewDrawablesInLastFrame
 
static unsigned int s_numberDeletedDrawablesInLastFrame
 

Member Typedef Documentation

typedef std::vector<GlyphRenderInfo> osgText::Text3D::LineRenderInfo
protected
typedef std::vector<LineRenderInfo> osgText::Text3D::TextRenderInfo
protected

Member Enumeration Documentation

Reder mode used to render the Text. PER_FACE : render all front face with the default StateSet all wall face with the wall StateSet all back face with the back StateSet (back face of the character, no the OpenGL back face)

PER_GLYPH : render all Charactere with the default StateSet

Enumerator
PER_FACE 
PER_GLYPH 

Constructor & Destructor Documentation

osgText::Text3D::Text3D ( )
osgText::Text3D::Text3D ( const Text3D text,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgText::Text3D::~Text3D ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osgText::Text3D::accept ( osg::Drawable::ConstAttributeFunctor af) const
virtual

accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.

Reimplemented from osg::Drawable.

virtual void osgText::Text3D::accept ( osg::PrimitiveFunctor pf) const
virtual

accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has.

Reimplemented from osg::Drawable.

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

Compute the bounding box around Drawables's geometry.

Reimplemented from osgText::TextBase.

void osgText::Text3D::computeGlyphRepresentation ( )
protectedvirtual

Implements osgText::TextBase.

String::iterator osgText::Text3D::computeLastCharacterOnLine ( osg::Vec2 cursor,
String::iterator  first,
String::iterator  last 
)
protected
void osgText::Text3D::computePositions ( unsigned int  contextID) const
protectedvirtual

Implements osgText::TextBase.

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

Draw the text.

Implements osg::Drawable.

osg::StateSet* osgText::Text3D::getBackStateSet ( )
inline

Get the back StateSet

osg::StateSet* osgText::Text3D::getBackStateSet ( ) const
inline

Get the back StateSet

osg::StateSet* osgText::Text3D::getOrCreateBackStateSet ( )
inline

Get or create the back StateSet

osg::StateSet* osgText::Text3D::getOrCreateWallStateSet ( )
inline

Get or create the wall StateSet

RenderMode osgText::Text3D::getRenderMode ( ) const
inline

Get the render mode used to render the text.

osg::StateSet* osgText::Text3D::getWallStateSet ( )
inline

Get the wall StateSet

const osg::StateSet* osgText::Text3D::getWallStateSet ( ) const
inline

Get the wall StateSet

osgText::Text3D::META_Object ( osgText  ,
Text3D   
) const

Get the Charactere Depth of text.

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

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

Reimplemented from osgText::TextBase.

void osgText::Text3D::renderPerFace ( osg::State state) const
protected
void osgText::Text3D::renderPerGlyph ( osg::State state) const
protected
virtual void osgText::Text3D::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osgText::TextBase.

void osgText::Text3D::setBackStateSet ( osg::StateSet backStateSet)
inline

Set the back StateSet

void osgText::Text3D::setCharacterDepth ( float  characterDepth)

Set the Charactere Depth of text.

void osgText::Text3D::setRenderMode ( RenderMode  renderMode)
inline

Set the render mode used to render the text.

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

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

Reimplemented from osgText::TextBase.

void osgText::Text3D::setWallStateSet ( osg::StateSet wallStateSet)
inline

Set the wall StateSet

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

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

Reimplemented from osg::Drawable.

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

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

Reimplemented from osg::Drawable.

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

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

Reimplemented from osg::Drawable.

Friends And Related Function Documentation

friend class Font
friend

Member Data Documentation

osg::ref_ptr<osg::StateSet> osgText::Text3D::_backStateSet
protected
RenderMode osgText::Text3D::_renderMode
protected
TextRenderInfo osgText::Text3D::_textRenderInfo
protected
osg::ref_ptr<osg::StateSet> osgText::Text3D::_wallStateSet
protected

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