osgText::FadeText Class Reference

#include <FadeText>

Inheritance diagram for osgText::FadeText:

Public Member Functions
	FadeText ()
	FadeText (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgText, FadeText) void setFadeSpeed(float fadeSpeed)
	Set the speed that the alpha value changes as the text is occluded or becomes visible.
float	getFadeSpeed () const
	Get the speed that the alpha value changes.
virtual void	drawImplementation (osg::RenderInfo &renderInfo) const
	Draw the text.
Public Member Functions inherited from osgText::Text
	Text ()
	Text (const Text &text, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual osg::Object *	cloneType () const
	clone an object of the same type as the node.
virtual osg::Object *	clone (const osg::CopyOp &copyop) const
	return a clone of a node, with Object* return type.
virtual bool	isSameKindAs (const osg::Object *obj) const
	return true if this and obj are of the same kind of object.
virtual const char *	className () const
	return the name of the node's class type.
virtual const char *	libraryName () const
	return the name of the node's library.
void	setShaderTechnique (ShaderTechnique technique)
	Set the ShaderTechnique hint to specify what fatures in the text shaders to enable.
ShaderTechnique	getShaderTechnique ()
	Get the ShaderTechnique hint.
void	setEnableDepthWrites (bool enable)
	Turns off writing to the depth buffer when rendering text.
bool	getEnableDepthWrites () const
void	setBackdropType (BackdropType type)
	BackdropType gives you a background shadow text behind your regular text.
BackdropType	getBackdropType () const
void	setBackdropOffset (float offset=0.07f)
	Sets the amount text is offset to create the backdrop/shadow effect.
void	setBackdropOffset (float horizontal, float vertical)
	This overloaded version lets you specify the offset for the horizontal and vertical components separately.
float	getBackdropHorizontalOffset () const
float	getBackdropVerticalOffset () const
void	setBackdropColor (const osg::Vec4 &color)
	This specifies the color of the backdrop text.
const osg::Vec4 &	getBackdropColor () const
void	setColorGradientMode (ColorGradientMode mode)
	This sets different types of text coloring modes.
ColorGradientMode	getColorGradientMode () const
void	setColorGradientCorners (const osg::Vec4 &topLeft, const osg::Vec4 &bottomLeft, const osg::Vec4 &bottomRight, const osg::Vec4 &topRight)
	Used only for gradient mode, let's you specify the colors of the 4 corners.
const osg::Vec4 &	getColorGradientTopLeft () const
const osg::Vec4 &	getColorGradientBottomLeft () const
const osg::Vec4 &	getColorGradientBottomRight () const
const osg::Vec4 &	getColorGradientTopRight () const
virtual bool	supports (const osg::Drawable::AttributeFunctor &) const
	return false, osgText::Text does not support accept(AttributeFunctor&).
virtual bool	supports (const osg::Drawable::ConstAttributeFunctor &) const
	return true, osgText::Text does support accept(ConstAttributeFunctor&).
virtual void	accept (osg::Drawable::ConstAttributeFunctor &af) const
	accept an ConstAttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool	supports (const osg::PrimitiveFunctor &) const
	return true, osgText::Text does support accept(PrimitiveFunctor&) .
virtual void	accept (osg::PrimitiveFunctor &pf) const
	accept a PrimtiveFunctor and call its methods to tell it about the internal primitives that this Drawable has.
bool	getCharacterCorners (unsigned int index, osg::Vec3 &bottomLeft, osg::Vec3 &bottomRight, osg::Vec3 &topLeft, osg::Vec3 &topRight) const
	Get the coordinates of the character corners in local coordinates.
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *state=0) const
	If State is non-zero, this function releases OpenGL objects for the specified graphics context.
void	setBackdropImplementation (BackdropImplementation)
	deprecated, value ignored.
BackdropImplementation	getBackdropImplementation () const
	deprecated, value should be ignored.
const GlyphQuads *	getGlyphQuads (GlyphTexture *texture) const
	Direct Access to GlyphQuads.
const TextureGlyphQuadMap &	getTextureGlyphQuadMap () const
void	addGlyphQuad (Glyph *glyph, const osg::Vec2 &minc, const osg::Vec2 &maxc, const osg::Vec2 &mintc, const osg::Vec2 &maxtc)
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::Vec4 &	getColor () const
virtual void	setFont (Font *font=0)
	Set the Font to use to render the text.
virtual void	setFont (osg::ref_ptr< Font > font)
	Set the Font to use to render the text.
virtual void	setFont (const std::string &fontfile)
	Set the font, loaded from the specified front file, to use to render the text, setFont("") sets the use of the default font.
Font *	getFont ()
	Get the font.
const Font *	getFont () const
	Get the const font.
void	setStyle (Style *style)
	Set the text style.
Style *	getStyle ()
	Get the text style.
const Style *	getStyle () const
	Get the const text style.
Style *	getOrCreateStyle ()
	Get or create the text style.
void	setFontResolution (unsigned int width, unsigned int height)
	Set the Font reference width and height resolution in texels.
unsigned int	getFontWidth () const
unsigned int	getFontHeight () const
void	setText (const String &text)
	Set the text using a osgText::String.
void	setText (const std::string &text)
	Set the text using a std::string, which is converted to an internal TextString.
void	setText (const std::string &text, String::Encoding encoding)
	Set the text using a Unicode encoded std::string, which is converted to an internal TextString.
void	setText (const wchar_t *text)
	Set the text using a wchar_t string, which is converted to an internal TextString.
String &	getText ()
	Get the text string.
const String &	getText () const
	Get the const text string.
void	update ()
	update internal glyph respresentation used for rendering, and bounding volume.
void	setCharacterSize (float height)
	Set the rendered character size in object coordinates.
void	setCharacterSize (float height, float aspectRatio)
	Set the rendered character size in object coordinates.
float	getCharacterHeight () const
float	getCharacterAspectRatio () const
void	setCharacterSizeMode (CharacterSizeMode mode)
	Set how the CharacterSize value relates to the final rendered character.
CharacterSizeMode	getCharacterSizeMode () const
	Get the CharacterSizeMode.
void	setMaximumWidth (float maximumWidth)
	Set the maximum width of the text box.
float	getMaximumWidth () const
	Get the maximim width of the text box.
void	setMaximumHeight (float maximumHeight)
	Set the maximum height of the text box.
float	getMaximumHeight () const
	Get the maximum height of the text box.
void	setLineSpacing (float lineSpacing)
	Set the line spacing of the text box, given as a percentage of the character height.
float	getLineSpacing () const
	Get the line spacing of the text box.
void	setPosition (const osg::Vec3 &pos)
	Set the position of text.
const osg::Vec3 &	getPosition () const
	Get the position of text.
void	setAlignment (AlignmentType alignment)
AlignmentType	getAlignment () const
void	setAxisAlignment (AxisAlignment axis)
AxisAlignment	getAxisAlignment () const
void	setRotation (const osg::Quat &quat)
const osg::Quat &	getRotation () 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::Vec4 &	getBoundingBoxColor () const
void	setKerningType (KerningType kerningType)
KerningType	getKerningType () const
unsigned int	getLineCount () const
	Get the number of wrapped lines - only valid after computeGlyphRepresentation() has been called, returns 0 otherwise.
virtual void	compileGLObjects (osg::RenderInfo &renderInfo) const
	Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
virtual osg::BoundingBox	computeBoundingBox () const
	Compute the bounding box around Drawables's geometry.
Coords &	getCoords ()
const Coords &	getCoords () const
void	getCoord (unsigned int i, osg::Vec2 &c) const
void	getCoord (unsigned int i, osg::Vec3 &c) const
const osg::Matrix &	getMatrix () const
	Get the cached internal matrix used to provide positioning of text.
bool	computeMatrix (osg::Matrix &matrix, osg::State *state=0) const
	compute the matrix that positions the text in model space for the given viewpoint.
Public Member Functions inherited from osg::Drawable
	Drawable ()
	Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_Node (osg, Drawable)
virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc.
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates.
void	setInitialBound (const osg::BoundingBox &bbox)
	Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingBox &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSphere &	getBound () const
const BoundingBox &	getBoundingBox () const
	Get BoundingBox of Drawable.
virtual BoundingSphere	computeBound () const
	Compute the bounding sphere around Drawables's geometry.
void	setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
	Set the compute bound callback to override the default computeBound.
ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback ()
	Get the compute bound callback.
const ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback () const
	Get the const compute bound callback.
virtual void	setShape (Shape *shape)
	Set the Shape of the Drawable.
template<class T>
void	setShape (const ref_ptr< T > &shape)
Shape *	getShape ()
	Get the Shape of the Drawable.
const Shape *	getShape () const
	Get the const Shape of the const Drawable.
void	setSupportsDisplayList (bool flag)
	Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists.
bool	getSupportsDisplayList () const
	Get whether display lists are supported for this drawable instance.
void	setUseDisplayList (bool flag)
	When set to true, force the draw method to use OpenGL Display List for rendering.
bool	getUseDisplayList () const
	Return whether OpenGL display lists are being used for rendering.
GLuint &	getDisplayList (unsigned int contextID) const
	Return OpenGL display list for specified contextID.
virtual void	setUseVertexBufferObjects (bool flag)
	When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.
bool	getUseVertexBufferObjects () const
	Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
void	setUseVertexArrayObject (bool flag)
	Set whether to use a local VertexArrayObject for this Drawable.
bool	getUseVertexArrayObject () const
	Return whether to use a local VertexArrayObject for this Drawable.
virtual void	dirtyGLObjects ()
	Force a recompile on next draw() of any OpenGL objects associated with this geoset.
virtual unsigned int	getGLObjectSizeHint () const
	Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
void	draw (RenderInfo &renderInfo) const
	Draw OpenGL primitives.
void	drawInner (RenderInfo &renderInfo) const
void	setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
	Set the callback to override the default Drawable::createCreateVertexArrayStateImplementation().
CreateVertexArrayStateCallback *	getCreateVertexArrayStateCallback ()
	Get the callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
const CreateVertexArrayStateCallback *	getCreateVertexArrayStateCallback () const
	Get the const callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
VertexArrayState *	createVertexArrayState (RenderInfo &renderInfo) const
	Create the VertexArrayState object used to track vertex array and vertex array object state.
void	setVertexArrayStateList (VertexArrayStateList &vasl)
VertexArrayStateList &	getVertexArrayStateList ()
const VertexArrayStateList &	getVertexArrayStateList () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void	setDrawCallback (DrawCallback *dc)
	Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
DrawCallback *	getDrawCallback ()
	Get the non const DrawCallback.
const DrawCallback *	getDrawCallback () const
	Get the const DrawCallback.
virtual void	accept (AttributeFunctor &)
	accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool	supports (const PrimitiveIndexFunctor &) const
	Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
virtual void	accept (PrimitiveIndexFunctor &) const
	Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has.
Public Member Functions inherited from osg::Node
	Node ()
	Construct a node.
	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual Geometry *	asGeometry ()
	convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0.
virtual const Geometry *	asGeometry () const
	convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0.
virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::Terrain *	asTerrain () const
	convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void	accept (NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual void	ascend (NodeVisitor &nv)
	Traverse upwards : calls parents' accept method with NodeVisitor.
virtual void	traverse (NodeVisitor &)
	Traverse downwards : calls children's accept method with NodeVisitor.
const ParentList &	getParents () const
	Get the parent list of node.
ParentList	getParents ()
	Get the a copy of parent list of node.
Group *	getParent (unsigned int i)
const Group *	getParent (unsigned int i) const
	Get a single const parent of node.
unsigned int	getNumParents () const
	Get the number of parents of node.
NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
	Get the list of node paths parent paths.
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates.
void	setUpdateCallback (Callback *nc)
	Set update node callback, called during update traversal.
template<class T>
void	setUpdateCallback (const ref_ptr< T > &nc)
Callback *	getUpdateCallback ()
	Get update node callback, called during update traversal.
const Callback *	getUpdateCallback () const
	Get const update node callback, called during update traversal.
void	addUpdateCallback (Callback *nc)
	Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void	addUpdateCallback (const ref_ptr< T > &nc)
void	removeUpdateCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void	removeUpdateCallback (const ref_ptr< T > &nc)
unsigned int	getNumChildrenRequiringUpdateTraversal () const
	Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
void	setEventCallback (Callback *nc)
	Set event node callback, called during event traversal.
template<class T>
void	setEventCallback (const ref_ptr< T > &nc)
Callback *	getEventCallback ()
	Get event node callback, called during event traversal.
const Callback *	getEventCallback () const
	Get const event node callback, called during event traversal.
void	addEventCallback (Callback *nc)
	Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void	addEventCallback (const ref_ptr< T > &nc)
void	removeEventCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void	removeEventCallback (const ref_ptr< T > &nc)
unsigned int	getNumChildrenRequiringEventTraversal () const
	Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
void	setCullCallback (Callback *nc)
	Set cull node callback, called during cull traversal.
template<class T>
void	setCullCallback (const ref_ptr< T > &nc)
Callback *	getCullCallback ()
	Get cull node callback, called during cull traversal.
const Callback *	getCullCallback () const
	Get const cull node callback, called during cull traversal.
void	addCullCallback (Callback *nc)
	Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void	addCullCallback (const ref_ptr< T > &nc)
void	removeCullCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void	removeCullCallback (const ref_ptr< T > &nc)
void	setCullingActive (bool active)
	Set the view frustum/small feature culling of this node to be active or inactive.
bool	getCullingActive () const
	Get the view frustum/small feature _cullingActive flag for this node.
unsigned int	getNumChildrenWithCullingDisabled () const
	Get the number of Children of this node which have culling disabled.
bool	isCullingActive () const
	Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
unsigned int	getNumChildrenWithOccluderNodes () const
	Get the number of Children of this node which are or have OccluderNode's.
bool	containsOccluderNodes () const
	return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
void	setNodeMask (NodeMask nm)
	Set the node mask.
NodeMask	getNodeMask () const
	Get the node Mask.
void	setStateSet (osg::StateSet *stateset)
	Set the node's StateSet.
template<class T>
void	setStateSet (const osg::ref_ptr< T > &stateset)
osg::StateSet *	getOrCreateStateSet ()
	return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSet *	getStateSet ()
	Return the node's StateSet.
const osg::StateSet *	getStateSet () const
	Return the node's const StateSet.
void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions.
DescriptionList &	getDescriptions ()
	Get the description list of the node.
const DescriptionList &	getDescriptions () const
	Get the const description list of the const node.
const std::string &	getDescription (unsigned int i) const
	Get a single const description of the const node.
std::string &	getDescription (unsigned int i)
	Get a single description of the node.
unsigned int	getNumDescriptions () const
	Get the number of descriptions of the node.
void	addDescription (const std::string &desc)
	Add a description string to the node.
void	setInitialBound (const osg::BoundingSphere &bsphere)
	Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume.
void	dirtyBound ()
	Mark this node's bounding sphere dirty.
const BoundingSphere &	getBound () const
void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
	Set the compute bound callback to override the default computeBound.
template<class T>
void	setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback.
const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
	Get the const compute bound callback.
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object.
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name.
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string.
void	setName (const char *name)
	Set the name of object using a C style string.
const std::string &	getName () const
	Get the name of object.
void	setDataVariance (DataVariance dv)
	Set the data variance of this object.
DataVariance	getDataVariance () const
	Get the data variance of this object.
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object.
template<class T>
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () const
	Get const user data.
template<typename T>
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T>
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref().
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object.

Protected Types
typedef std::map< osg::View *, osg::Vec4 >	ViewBlendColourMap
Protected Types inherited from osgText::TextBase
typedef osg::ref_ptr< osg::Vec2Array >	TexCoords
typedef osg::ref_ptr< osg::Vec4Array >	ColorCoords
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	~FadeText ()
void	init ()
ViewBlendColourMap &	getViewBlendColourMap ()
const ViewBlendColourMap &	getViewBlendColourMap () const
Protected Member Functions inherited from osgText::Text
virtual	~Text ()
virtual osg::StateSet *	createStateSet ()
Font *	getActiveFont ()
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	computePositionsImplementation ()
void	computeColorGradients ()
void	computeColorGradientsOverall ()
void	computeColorGradientsPerCharacter ()
void	drawImplementation (osg::State &state, const osg::Vec4 &colorMultiplier) const
void	drawImplementationSinglePass (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 ()
virtual void	assignStateSet ()
void	initArraysAndBuffers ()
osg::VertexArrayState *	createVertexArrayStateImplementation (osg::RenderInfo &renderInfo) const
	Implementation of Create the VertexArrayState object.
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 ()
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
Drawable &	operator= (const Drawable &)
virtual	~Drawable ()
void	setBound (const BoundingBox &bb) const
	set the bounding box .
Protected Member Functions inherited from osg::Node
virtual	~Node ()
	Node destructor.
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 ()
	Object destructor.
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
ShaderTechnique	_shaderTechnique
bool	_enableDepthWrites
BackdropType	_backdropType
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< 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

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	ColorGradientMode { SOLID = 0 , PER_CHARACTER , OVERALL }
enum	BackdropImplementation {   POLYGON_OFFSET = 0 , NO_DEPTH_BUFFER , DEPTH_RANGE , STENCIL_BUFFER ,   DELAYED_DEPTH_WRITES }
	deprecated, value ignored. More...
typedef std::map< osg::ref_ptr< GlyphTexture >, GlyphQuads >	TextureGlyphQuadMap
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 }
typedef osg::ref_ptr< osg::Vec3Array >	Coords
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
	A vector of osg::Group pointers which is used to store the parent(s) of node.
typedef unsigned int	NodeMask
	This is a set of bits (flags) that represent the Node.
typedef std::vector< std::string >	DescriptionList
	A vector of std::string's which are used to describe the object.
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)
	Return a OpenGL display list handle a newly generated or reused from display list cache.
static void	deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
	Use deleteDisplayList instead of glDeleteList to allow OpenGL display list to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.
static void	setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
	Set the minimum number of display lists to retain in the deleted display list cache.
static unsigned int	getMinimumNumberOfDisplayListsToRetainInCache ()
	Get the minimum number of display lists to retain in the deleted display list cache.
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.

Member Typedef Documentation

ViewBlendColourMap

typedef std::map<osg::View*, osg::Vec4 > osgText::FadeText::ViewBlendColourMap

protected

Constructor & Destructor Documentation

FadeText() [1/2]

osgText::FadeText::FadeText

(

)

Referenced by META_Object().

FadeText() [2/2]

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

References osg::CopyOp::SHALLOW_COPY, and osgText::Text::Text().

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

References _fadeSpeed.

getViewBlendColourMap() [1/2]

ViewBlendColourMap & osgText::FadeText::getViewBlendColourMap ( )

inlineprotected

References _viewBlendColourMap.

getViewBlendColourMap() [2/2]

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

inlineprotected

References _viewBlendColourMap.

init()

void osgText::FadeText::init ( )

protected

References FadeTextUpdateCallback.

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.

References _fadeSpeed, and FadeText().

Friends And Related Symbol Documentation

FadeTextUpdateCallback

friend struct FadeTextUpdateCallback

friend

References FadeTextUpdateCallback.

Referenced by FadeTextUpdateCallback, and init().

Member Data Documentation

_fadeSpeed

float osgText::FadeText::_fadeSpeed

protected

Referenced by getFadeSpeed(), and META_Object().

_viewBlendColourMap

ViewBlendColourMap osgText::FadeText::_viewBlendColourMap

mutableprotected

Referenced by getViewBlendColourMap(), and getViewBlendColourMap().

---

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

• osgText/FadeText