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

Public Member Functions

 FadeText ()
 
 FadeText (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgText, FadeText) void setFadeSpeed(float fadeSpeed)
 
float getFadeSpeed () const
 
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
 
- Public Member Functions inherited from osgText::Text
 Text ()
 
 Text (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual osg::ObjectcloneType () const
 
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * className () const
 
virtual const char * libraryName () const
 
virtual void setFont (Font *font=0)
 
virtual void setFont (osg::ref_ptr< Font > font)
 
virtual void setFont (const std::string &fontfile)
 
void setEnableDepthWrites (bool enable)
 
bool getEnableDepthWrites () const
 
void setBackdropType (BackdropType type)
 
BackdropType getBackdropType () const
 
void setBackdropOffset (float offset=0.07f)
 
void setBackdropOffset (float horizontal, float vertical)
 
float getBackdropHorizontalOffset () const
 
float getBackdropVerticalOffset () const
 
void setBackdropColor (const osg::Vec4 &color)
 
const osg::Vec4getBackdropColor () const
 
void setBackdropImplementation (BackdropImplementation implementation)
 
BackdropImplementation getBackdropImplementation () const
 
void setColorGradientMode (ColorGradientMode mode)
 
ColorGradientMode getColorGradientMode () const
 
void setColorGradientCorners (const osg::Vec4 &topLeft, const osg::Vec4 &bottomLeft, const osg::Vec4 &bottomRight, const osg::Vec4 &topRight)
 
const osg::Vec4getColorGradientTopLeft () const
 
const osg::Vec4getColorGradientBottomLeft () const
 
const osg::Vec4getColorGradientBottomRight () const
 
const osg::Vec4getColorGradientTopRight () 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
 
const GlyphQuadsgetGlyphQuads (GlyphTexture *texture) const
 
const TextureGlyphQuadMapgetTextureGlyphQuadMap () const
 
- Public Member Functions inherited from osgText::TextBase
 TextBase ()
 
 TextBase (const TextBase &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
void setColor (const osg::Vec4 &color)
 
const osg::Vec4getColor () const
 
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 osg::BoundingBox computeBound () 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 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::map< osg::View *, osg::Vec4ViewBlendColourMap
 
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value< GLuint > GLObjectList
 

Protected Member Functions

virtual ~FadeText ()
 
void init ()
 
ViewBlendColourMapgetViewBlendColourMap ()
 
const ViewBlendColourMapgetViewBlendColourMap () const
 
- Protected Member Functions inherited from osgText::Text
virtual ~Text ()
 
FontgetActiveFont ()
 
const FontgetActiveFont () const
 
String::iterator computeLastCharacterOnLine (osg::Vec2 &cursor, String::iterator first, String::iterator last)
 
void computeGlyphRepresentation ()
 
bool computeAverageGlyphWidthAndHeight (float &avg_width, float &avg_height) const
 
virtual void computePositions (unsigned int contextID) const
 
void computeBackdropPositions (unsigned int contextID) const
 
void computeBackdropBoundingBox () const
 
void computeBoundingBoxMargin () const
 
void computeColorGradients () const
 
void computeColorGradientsOverall () const
 
void computeColorGradientsPerCharacter () const
 
void drawImplementation (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void drawForegroundText (osg::State &state, const GlyphQuads &glyphquad, const osg::Vec4 &colorMultiplier) const
 
void drawTextWithBackdrop (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderOnlyForegroundText (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderWithPolygonOffset (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderWithNoDepthBuffer (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderWithDepthRange (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderWithStencilBuffer (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
void renderWithDelayedDepthWrites (osg::State &state, const osg::Vec4 &colorMultiplier) const
 
float bilinearInterpolate (float x1, float x2, float y1, float y2, float x, float y, float q11, float q12, float q21, float q22) 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

float _fadeSpeed
 
ViewBlendColourMap _viewBlendColourMap
 
- Protected Attributes inherited from osgText::Text
TextureGlyphQuadMap _textureGlyphQuadMap
 
bool _enableDepthWrites
 
BackdropType _backdropType
 
BackdropImplementation _backdropImplementation
 
float _backdropHorizontalOffset
 
float _backdropVerticalOffset
 
osg::Vec4 _backdropColor
 
ColorGradientMode _colorGradientMode
 
osg::Vec4 _colorGradientTopLeft
 
osg::Vec4 _colorGradientBottomLeft
 
osg::Vec4 _colorGradientBottomRight
 
osg::Vec4 _colorGradientTopRight
 
- 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

struct FadeTextUpdateCallback
 

Additional Inherited Members

- Public Types inherited from osgText::Text
enum  BackdropType {
  DROP_SHADOW_BOTTOM_RIGHT = 0, DROP_SHADOW_CENTER_RIGHT, DROP_SHADOW_TOP_RIGHT, DROP_SHADOW_BOTTOM_CENTER,
  DROP_SHADOW_TOP_CENTER, DROP_SHADOW_BOTTOM_LEFT, DROP_SHADOW_CENTER_LEFT, DROP_SHADOW_TOP_LEFT,
  OUTLINE, NONE
}
 
enum  BackdropImplementation {
  POLYGON_OFFSET = 0, NO_DEPTH_BUFFER, DEPTH_RANGE, STENCIL_BUFFER,
  DELAYED_DEPTH_WRITES
}
 
enum  ColorGradientMode { SOLID = 0, PER_CHARACTER, OVERALL }
 
typedef std::map< osg::ref_ptr< GlyphTexture >, GlyphQuadsTextureGlyphQuadMap
 
- 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 }
 
- 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 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
 

Member Typedef Documentation

§ ViewBlendColourMap

Constructor & Destructor Documentation

§ FadeText() [1/2]

osgText::FadeText::FadeText ( )

§ FadeText() [2/2]

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

§ ~FadeText()

virtual osgText::FadeText::~FadeText ( )
inlineprotectedvirtual

Member Function Documentation

§ drawImplementation()

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

Draw the text.

Reimplemented from osgText::Text.

§ getFadeSpeed()

float osgText::FadeText::getFadeSpeed ( ) const
inline

Get the speed that the alpha value changes.

§ getViewBlendColourMap() [1/2]

ViewBlendColourMap& osgText::FadeText::getViewBlendColourMap ( )
inlineprotected

§ getViewBlendColourMap() [2/2]

const ViewBlendColourMap& osgText::FadeText::getViewBlendColourMap ( ) const
inlineprotected

§ init()

void osgText::FadeText::init ( )
protected

§ META_Object()

osgText::FadeText::META_Object ( osgText  ,
FadeText   
)
inline

Set the speed that the alpha value changes as the text is occluded or becomes visible.

Friends And Related Function Documentation

§ FadeTextUpdateCallback

friend struct FadeTextUpdateCallback
friend

Member Data Documentation

§ _fadeSpeed

float osgText::FadeText::_fadeSpeed
protected

§ _viewBlendColourMap

ViewBlendColourMap osgText::FadeText::_viewBlendColourMap
mutableprotected

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