3D text component. More...

#include <Text3D.h>

Inheritance diagram for Urho3D::Text3D:
Collaboration diagram for Urho3D::Text3D:

Public Member Functions

 Text3D (Context *context)
 ~Text3D ()
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately.
virtual void UpdateBatches (const FrameInfo &frame)
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
virtual void UpdateGeometry (const FrameInfo &frame)
 Prepare geometry for rendering. Called from a worker thread if possible (no GPU update.)
virtual UpdateGeometryType GetUpdateGeometryType ()
 Return whether a geometry update is necessary, and if it can happen in a worker thread.
bool SetFont (const String &fontName, int size=DEFAULT_FONT_SIZE)
 Set font and font size and use signed distance field font. Return true if successful.
bool SetFont (Font *font, int size=DEFAULT_FONT_SIZE)
 Set font and font size and use signed distance field font. Return true if successful.
void SetMaterial (Material *material)
 Set material.
void SetText (const String &text)
 Set text. Text is assumed to be either ASCII or UTF8-encoded.
void SetAlignment (HorizontalAlignment hAlign, VerticalAlignment vAlign)
 Set horizontal and vertical alignment.
void SetHorizontalAlignment (HorizontalAlignment align)
 Set horizontal alignment.
void SetVerticalAlignment (VerticalAlignment align)
 Set vertical alignment.
void SetTextAlignment (HorizontalAlignment align)
 Set row alignment.
void SetRowSpacing (float spacing)
 Set row spacing, 1.0 for original font spacing.
void SetWordwrap (bool enable)
 Set wordwrap. In wordwrap mode the text element will respect its current width. Otherwise it resizes itself freely.
void SetTextEffect (TextEffect textEffect)
 Set text effect.
void SetEffectColor (const Color &effectColor)
 Set effect color.
void SetEffectDepthBias (float bias)
 Set effect Z bias.
void SetWidth (int width)
 Set text width. Only has effect in word wrap mode.
void SetColor (const Color &color)
 Set color on all corners.
void SetColor (Corner corner, const Color &color)
 Set color on one corner.
void SetOpacity (float opacity)
 Set opacity.
void SetFaceCameraMode (FaceCameraMode mode)
 Set how the text should rotate in relation to the camera. Default is to not rotate (FC_NONE.)
FontGetFont () const
 Return font.
MaterialGetMaterial () const
 Return material.
int GetFontSize () const
 Return font size.
const StringGetText () const
 Return text.
HorizontalAlignment GetTextAlignment () const
 Return row alignment.
HorizontalAlignment GetHorizontalAlignment () const
 Return horizontal alignment.
VerticalAlignment GetVerticalAlignment () const
 Return vertical alignment.
float GetRowSpacing () const
 Return row spacing.
bool GetWordwrap () const
 Return wordwrap mode.
TextEffect GetTextEffect () const
 Return text effect.
const ColorGetEffectColor () const
 Return effect color.
float GetEffectDepthBias () const
 Return effect depth bias.
int GetWidth () const
 Return text width.
int GetRowHeight () const
 Return row height.
unsigned GetNumRows () const
 Return number of rows.
unsigned GetNumChars () const
 Return number of characters.
int GetRowWidth (unsigned index) const
 Return width of row by index.
IntVector2 GetCharPosition (unsigned index)
 Return position of character by index relative to the text element origin.
IntVector2 GetCharSize (unsigned index)
 Return size of character by index.
const ColorGetColor (Corner corner) const
 Return corner color.
float GetOpacity () const
 Return opacity.
FaceCameraMode GetFaceCameraMode () const
 Return how the text rotates in relation to the camera.
void SetFontAttr (const ResourceRef &value)
 Set font attribute.
ResourceRef GetFontAttr () const
 Return font attribute.
void SetMaterialAttr (const ResourceRef &value)
 Set material attribute.
ResourceRef GetMaterialAttr () const
 Return material attribute.
const ColorGetColorAttr () const
 Get color attribute. Uses just the top-left color.
- Public Member Functions inherited from Urho3D::Drawable
 Drawable (Context *context, unsigned char drawableFlags)
virtual ~Drawable ()
virtual void OnSetEnabled ()
 Handle enabled/disabled state change.
virtual void ProcessRayQuery (const RayOctreeQuery &query, PODVector< RayQueryResult > &results)
 Process octree raycast. May be called from a worker thread.
virtual void Update (const FrameInfo &frame)
 Update before octree reinsertion. Is called from a worker thread.
virtual GeometryGetLodGeometry (unsigned batchIndex, unsigned level)
 Return the geometry for a specific LOD level.
virtual unsigned GetNumOccluderTriangles ()
 Return number of occlusion geometry triangles.
virtual bool DrawOcclusion (OcclusionBuffer *buffer)
 Draw to occlusion buffer. Return true if did not run out of triangles.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
void SetDrawDistance (float distance)
 Set draw distance.
void SetShadowDistance (float distance)
 Set shadow draw distance.
void SetLodBias (float bias)
 Set LOD bias.
void SetViewMask (unsigned mask)
 Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
void SetLightMask (unsigned mask)
 Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
void SetShadowMask (unsigned mask)
 Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
void SetZoneMask (unsigned mask)
 Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
void SetMaxLights (unsigned num)
 Set maximum number of per-pixel lights. Default 0 is unlimited.
void SetCastShadows (bool enable)
 Set shadowcaster flag.
void SetOccluder (bool enable)
 Set occlusion flag.
void SetOccludee (bool enable)
 Set occludee flag.
void MarkForUpdate ()
 Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
const BoundingBoxGetBoundingBox () const
 Return local space bounding box. May not be applicable or properly updated on all drawables.
const BoundingBoxGetWorldBoundingBox ()
 Return world-space bounding box.
unsigned char GetDrawableFlags () const
 Return drawable flags.
float GetDrawDistance () const
 Return draw distance.
float GetShadowDistance () const
 Return shadow draw distance.
float GetLodBias () const
 Return LOD bias.
unsigned GetViewMask () const
 Return view mask.
unsigned GetLightMask () const
 Return light mask.
unsigned GetShadowMask () const
 Return shadow mask.
unsigned GetZoneMask () const
 Return zone mask.
unsigned GetMaxLights () const
 Return maximum number of per-pixel lights.
bool GetCastShadows () const
 Return shadowcaster flag.
bool IsOccluder () const
 Return occluder flag.
bool IsOccludee () const
 Return occludee flag.
bool IsInView () const
 Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
bool IsInView (Camera *camera) const
 Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
const Vector< SourceBatch > & GetBatches () const
 Return draw call source data.
void SetZone (Zone *zone, bool temporary=false)
 Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
void SetSortValue (float value)
 Set sorting value.
void SetMinMaxZ (float minZ, float maxZ)
 Set view-space depth bounds.
void MarkInView (const FrameInfo &frame)
 Mark in view. Also clear the light list.
void MarkInView (unsigned frameNumber)
 Mark in view without specifying a camera. Used for shadow casters.
void LimitLights ()
 Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
void LimitVertexLights (bool removeConvertedLights)
 Sort and limit per-vertex lights to maximum allowed.
void SetBasePass (unsigned batchIndex)
 Set base pass flag for a batch.
OctantGetOctant () const
 Return octree octant.
ZoneGetZone () const
 Return current zone.
bool IsZoneDirty () const
 Return whether current zone is inconclusive or dirty due to the drawable moving.
float GetDistance () const
 Return distance from camera.
float GetLodDistance () const
 Return LOD scaled distance from camera.
float GetSortValue () const
 Return sorting value.
bool IsInView (const FrameInfo &frame, bool anyCamera=false) const
 Return whether is in view on the current frame. Called by View.
bool HasBasePass (unsigned batchIndex) const
 Return whether has a base pass.
const PODVector< Light * > & GetLights () const
 Return per-pixel lights.
const PODVector< Light * > & GetVertexLights () const
 Return per-vertex lights.
LightGetFirstLight () const
 Return the first added per-pixel light.
float GetMinZ () const
 Return the minimum view-space depth.
float GetMaxZ () const
 Return the maximum view-space depth.
void AddLight (Light *light)
void AddVertexLight (Light *light)
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
virtual ~Component ()
virtual bool Save (Serializer &dest) const
 Save as binary data. Return true if successful.
virtual bool SaveXML (XMLElement &dest) const
 Save as XML data. Return true if successful.
virtual void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
void SetEnabled (bool enable)
 Set enabled/disabled state.
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
 Return ID.
NodeGetNode () const
 Return scene node.
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
 Return whether is enabled.
bool IsEnabledEffective () const
 Return whether is effectively enabled (node is also enabled.)
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
void GetComponents (PODVector< Component * > &dest, StringHash type) const
 Return components in the same scene node by type.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
template<class T >
void GetComponents (PODVector< T * > &dest) const
 Template version of returning components in the same scene node by type.
void AddReplicationState (ComponentReplicationState *state)
 Add a replication state that is tracking this component.
void PrepareNetworkUpdate ()
 Prepare network update by comparing attributes and marking replication states dirty as necessary.
void CleanupConnection (Connection *connection)
 Clean up all references to a network connection that is about to be removed.
- Public Member Functions inherited from Urho3D::Animatable
 Animatable (Context *context)
virtual ~Animatable ()
virtual bool LoadXML (const XMLElement &source, bool setInstanceDefault=false)
 Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void SetAnimationEnabled (bool enable)
 Set automatic update of animation, default true.
void SetAnimationTime (float time)
 Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void SetObjectAnimation (ObjectAnimation *objectAnimation)
 Set object animation.
void SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
 Set attribute animation.
void SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
 Set attribute animation wrap mode.
void SetAttributeAnimationSpeed (const String &name, float speed)
 Set attribute animation speed.
void SetAttributeAnimationTime (const String &name, float time)
 Set attribute animation time position manually. Automatic update should be disabled in this case.
void RemoveObjectAnimation ()
 Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void RemoveAttributeAnimation (const String &name)
 Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool GetAnimationEnabled () const
 Return animation enabled.
ObjectAnimationGetObjectAnimation () const
 Return object animation.
ValueAnimationGetAttributeAnimation (const String &name) const
 Return attribute animation.
WrapMode GetAttributeAnimationWrapMode (const String &name) const
 Return attribute animation wrap mode.
float GetAttributeAnimationSpeed (const String &name) const
 Return attribute animation speed.
float GetAttributeAnimationTime (const String &name) const
 Return attribute animation time position.
void SetObjectAnimationAttr (const ResourceRef &value)
 Set object animation attribute.
ResourceRef GetObjectAnimationAttr () const
 Return object animation attribute.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
virtual ~Serializable ()
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector
< AttributeInfo > * 
GetAttributes () const
 Return attribute descriptions, or null if none defined.
virtual const Vector
< AttributeInfo > * 
GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
virtual bool Load (Deserializer &source, bool setInstanceDefault=false)
 Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool SaveDefaultAttributes () const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
 Set attribute by index. Return true if successfully set.
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void ResetToDefault ()
 Reset all editable attributes to their default values.
void RemoveInstanceDefault ()
 Remove instance's default values if they are set previously.
void SetTemporary (bool enable)
 Set temporary flag. Temporary objects will not be saved.
void SetInterceptNetworkUpdate (const String &attributeName, bool enable)
 Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void AllocateNetworkState ()
 Allocate network attribute state.
void WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
 Write initial delta network update.
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
 Write a delta network update according to dirty attribute bits.
void WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
 Write a latest data network update.
bool ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update. Return true if attributes were changed.
bool ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update. Return true if attributes were changed.
Variant GetAttribute (unsigned index) const
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
 Return attribute default value by index. Return empty if illegal index.
Variant GetAttributeDefault (const String &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
bool IsTemporary () const
 Return whether is temporary.
bool GetInterceptNetworkUpdate (const String &attributeName) const
 Return whether an attribute's network updates are being intercepted.
NetworkStateGetNetworkState () const
 Return the network attribute state, if allocated.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int Refs () const
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory. Drawable must be registered first.
- Static Public Member Functions inherited from Urho3D::Drawable
static void RegisterObject (Context *context)
 Register object attributes. Drawable must be registered first.

Protected Member Functions

virtual void OnNodeSet (Node *node)
 Handle node being assigned.
virtual void OnWorldBoundingBoxUpdate ()
 Recalculate the world-space bounding box.
- Protected Member Functions inherited from Urho3D::Drawable
virtual void OnSceneSet (Scene *scene)
 Handle scene being assigned.
virtual void OnMarkedDirty (Node *node)
 Handle node transform being dirtied.
virtual void OnRemoveFromOctree ()
 Handle removal from octree.
void AddToOctree ()
 Add to octree.
void RemoveFromOctree ()
 Remove from octree.
void SetOctant (Octant *octant)
 Move into another octree octant.
- Protected Member Functions inherited from Urho3D::Component
virtual void OnAttributeAnimationAdded ()
 Handle attribute animation added.
virtual void OnAttributeAnimationRemoved ()
 Handle attribute animation removed.
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
void SetID (unsigned id)
 Set ID. Called by Scene.
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
void HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
 Handle scene attribute animation update event.
- Protected Member Functions inherited from Urho3D::Animatable
virtual AnimatableFindAttributeAnimationTarget (const String &name, String &outName)
 Find target of an attribute animation from object hierarchy by name.
void SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
 Set object attribute animation internal.
void OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
 Handle object animation added.
void OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
 Handle object animation removed.
void UpdateAttributeAnimations (float timeStep)
 Update attribute animations.
bool IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
 Is animated network attribute.
AttributeAnimationInfoGetAttributeAnimationInfo (const String &name) const
 Return attribute animation info.
void HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
 Handle attribute animation added.
void HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
 Handle attribute animation removed.

Private Member Functions

 URHO3D_OBJECT (Text3D, Drawable)
void MarkTextDirty ()
 Mark text & geometry dirty.
void UpdateTextBatches ()
 Update text UI batches.
void UpdateTextMaterials (bool forceUpdate=false)
 Create materials for text rendering. May only be called from the main thread. Text UI batches must be up-to-date.

Private Attributes

Text text_
 Internally used text element.
Vector< SharedPtr< Geometry > > geometries_
SharedPtr< VertexBuffervertexBuffer_
 Vertex buffer.
SharedPtr< Materialmaterial_
 Material to use as a base for the text material(s).
PODVector< UIBatchuiBatches_
 Text UI batches.
PODVector< float > uiVertexData_
 Text vertex data.
Matrix3x4 customWorldTransform_
 Custom world transform for facing the camera automatically.
FaceCameraMode faceCameraMode_
 Text rotation mode in relation to the camera.
bool textDirty_
 Text needs update flag.
bool geometryDirty_
 Geometry dirty flag.
bool usingSDFShader_
 Flag for whether currently using SDF shader defines in the generated material.
bool fontDataLost_
 Font texture data lost flag.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Drawable
BoundingBox worldBoundingBox_
 World-space bounding box.
BoundingBox boundingBox_
 Local-space bounding box.
Vector< SourceBatchbatches_
 Draw call source data.
unsigned char drawableFlags_
 Drawable flags.
bool worldBoundingBoxDirty_
 Bounding box dirty flag.
bool castShadows_
 Shadowcaster flag.
bool occluder_
 Occluder flag.
bool occludee_
 Occludee flag.
bool updateQueued_
 Octree update queued flag.
bool zoneDirty_
 Zone inconclusive or dirtied flag.
 Octree octant.
 Current zone.
unsigned viewMask_
 View mask.
unsigned lightMask_
 Light mask.
unsigned shadowMask_
 Shadow mask.
unsigned zoneMask_
 Zone mask.
unsigned viewFrameNumber_
 Last visible frame number.
float distance_
 Current distance to camera.
float lodDistance_
 LOD scaled distance.
float drawDistance_
 Draw distance.
float shadowDistance_
 Shadow distance.
float sortValue_
 Current sort value.
float minZ_
 Current minimum view space depth.
float maxZ_
 Current maximum view space depth.
float lodBias_
 LOD bias.
unsigned basePassFlags_
 Base pass flags, bit per batch.
unsigned maxLights_
 Maximum per-pixel lights.
PODVector< Camera * > viewCameras_
 List of cameras from which is seen on the current frame.
 First per-pixel light added this frame.
PODVector< Light * > lights_
 Per-pixel lights affecting this drawable.
PODVector< Light * > vertexLights_
 Per-vertex lights affecting this drawable.

Detailed Description

3D text component.

The documentation for this class was generated from the following files:
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/UI/Text3D.h
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/UI/Text3D.cpp