Rebel Fork Framework
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Urho3D::Text3D Class Reference

3D text component. More...

#include <Urho3D/UI/Text3D.h>

Inheritance diagram for Urho3D::Text3D:
Urho3D::Drawable Urho3D::Component Urho3D::PipelineStateTracker Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Text3D (Context *context)
 Construct.
 
 ~Text3D () override
 Destruct.
 
void ApplyAttributes () override
 Apply attribute changes that can not be applied immediately.
 
void UpdateBatches (const FrameInfo &frame) override
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
 
void UpdateBatchesDelayed (const FrameInfo &frame) override
 Batch update from main thread. Called on demand only if RequestUpdateBatchesDelayed() is called from UpdateBatches().
 
void UpdateGeometry (const FrameInfo &frame) override
 Prepare geometry for rendering. Called from a worker thread if possible (no GPU update).
 
UpdateGeometryType GetUpdateGeometryType () override
 Return whether a geometry update is necessary, and if it can happen in a worker thread.
 
bool SetFont (const ea::string &fontName, float size=DEFAULT_FONT_SIZE)
 Set font by looking from resource cache by name and font size. Return true if successful.
 
bool SetFont (Font *font, float size=DEFAULT_FONT_SIZE)
 Set font and font size. Return true if successful.
 
bool SetFontSize (float size)
 
void SetMaterial (Material *material)
 
void SetText (const ea::string &text)
 
void SetAlignment (HorizontalAlignment hAlign, VerticalAlignment vAlign)
 Set horizontal and vertical alignment.
 
void SetHorizontalAlignment (HorizontalAlignment align)
 
void SetVerticalAlignment (VerticalAlignment align)
 
void SetTextAlignment (HorizontalAlignment align)
 
void SetRowSpacing (float spacing)
 
void SetWordwrap (bool enable)
 
void SetTextEffect (TextEffect textEffect)
 
void SetEffectShadowOffset (const IntVector2 &offset)
 
void SetEffectStrokeThickness (int thickness)
 
void SetEffectRoundStroke (bool roundStroke)
 
void SetEffectColor (const Color &effectColor)
 
void SetEffectDepthBias (float bias)
 
void SetWidth (int width)
 
void SetColor (const Color &color)
 
void SetColor (Corner corner, const Color &color)
 
void SetOpacity (float opacity)
 
void SetFixedScreenSize (bool enable)
 
void SetSnapToPixels (bool enable)
 Set whether to snap text to pixels. Has effect only if fixed screen size is enabled.
 
void SetFaceCameraMode (FaceCameraMode mode)
 
void SetDepthTest (bool enable)
 Set whether to enable the depth test when rendering the text. Default is true.
 
Font * GetFont () const
 
float GetFontSize () const
 
Material * GetMaterial () const
 
const ea::string & GetText () const
 
HorizontalAlignment GetTextAlignment () const
 
HorizontalAlignment GetHorizontalAlignment () const
 
VerticalAlignment GetVerticalAlignment () const
 
float GetRowSpacing () const
 
bool GetWordwrap () const
 
TextEffect GetTextEffect () const
 
const IntVector2 & GetEffectShadowOffset () const
 
int GetEffectStrokeThickness () const
 
bool GetEffectRoundStroke () const
 
const Color & GetEffectColor () const
 
float GetEffectDepthBias () const
 
int GetWidth () const
 
int GetHeight () const
 
int GetRowHeight () const
 
unsigned GetNumRows () const
 
unsigned GetNumChars () const
 
int GetRowWidth (unsigned index) const
 
Vector2 GetCharPosition (unsigned index)
 
Vector2 GetCharSize (unsigned index)
 
const Color & GetColor (Corner corner) const
 
float GetOpacity () const
 
bool IsFixedScreenSize () const
 
bool GetSnapToPixels () const
 Return whether text is snapped to pixels.
 
FaceCameraMode GetFaceCameraMode () const
 
bool GetDepthTest () const
 Return whether the depth test is enabled when rendering the text.
 
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.
 
void SetTextAttr (const ea::string &value)
 Set text attribute.
 
ea::string GetTextAttr () const
 Return text attribute.
 
const Color & GetColorAttr () const
 Get color attribute. Uses just the top-left color.
 
- Public Member Functions inherited from Urho3D::Drawable
 Drawable (Context *context, DrawableFlags drawableFlags=DRAWABLE_UNDEFINED)
 Construct.
 
 ~Drawable () override
 Destruct.
 
void OnSetEnabled () override
 Handle enabled/disabled state change.
 
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
 
virtual void ProcessRayQuery (const RayOctreeQuery &query, ea::vector< 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 Geometry * GetLodGeometry (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.
 
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
 
void SetDrawDistance (float distance)
 
void SetShadowDistance (float distance)
 
void SetLodBias (float bias)
 
void SetViewMask (unsigned mask)
 
void SetLightMask (unsigned mask)
 
void SetShadowMask (unsigned mask)
 
void SetZoneMask (unsigned mask)
 
void SetCastShadows (bool enable)
 
void SetOccluder (bool enable)
 
void SetOccludee (bool enable)
 
void SetGlobalIlluminationType (GlobalIlluminationType type)
 Set GI type.
 
void SetReflectionMode (ReflectionMode mode)
 Set reflection mode.
 
void MarkForUpdate ()
 Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
 
const BoundingBox & GetBoundingBox () const
 
const BoundingBox & GetWorldBoundingBox ()
 
DrawableFlags GetDrawableFlags () const
 Return drawable flags.
 
float GetDrawDistance () const
 
float GetShadowDistance () const
 
float GetLodBias () const
 
unsigned GetViewMask () const
 
unsigned GetLightMask () const
 
unsigned GetShadowMask () const
 
unsigned GetZoneMask () const
 
bool GetCastShadows () const
 
bool IsOccluder () const
 
bool IsOccludee () const
 
GlobalIlluminationType GetGlobalIlluminationType () const
 Return global illumination type.
 
ReflectionMode GetReflectionMode () const
 Return reflection mode.
 
bool IsInView () const
 
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 ea::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 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.
 
Octant * GetOctant () const
 Return octree octant.
 
unsigned GetDrawableIndex () const
 Return index in octree.
 
bool IsInOctree () const
 Return whether the drawable is added to Octree.
 
Zone * GetZone () const
 
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.
 
unsigned & GetMutableLightProbeTetrahedronHint ()
 Return mutable light probe tetrahedron hint.
 
CachedDrawableZone & GetMutableCachedZone ()
 Return mutable cached zone data.
 
CachedDrawableReflection & GetMutableCachedReflection ()
 Return mutable cached reflection data.
 
unsigned GetLightMaskInZone () const
 Return combined light masks of Drawable and its currently cached Zone.
 
unsigned GetShadowMaskInZone () const
 Return combined shadow masks of Drawable and its currently cached Zone.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
 ~Component () override
 Destruct.
 
AttributeScopeHint GetEffectiveScopeHint () const
 
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
 
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
 
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
 
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
 
virtual bool HasAuxiliaryData () const
 
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
 
void SetEnabled (bool enable)
 
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
 
unsigned GetID () const
 
Node * GetNode () const
 
Scene * GetScene () const
 Return the scene the node belongs to.
 
bool IsEnabled () const
 
bool IsEnabledEffective () const
 
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
 
Component * GetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
 
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
 
unsigned GetIndexInParent () const
 Return index of this component in the node.
 
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
 
 ~Serializable () override
 Destruct.
 
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 ObjectReflection * GetReflection () const
 Return reflection used for serialization.
 
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
 
void SerializeInBlock (Archive &archive, bool serializeTemporary)
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
 
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
 
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
 
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
 
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
 
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
 
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
 
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
 
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
 
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)
 
Variant GetAttribute (unsigned index) const
 
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
 
bool IsTemporary () const
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfo * GetTypeInfo () 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.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMap & GetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
Context * GetContext () const
 Return execution context.
 
const Variant & GetGlobalVar (StringHash key) const
 
const VariantMap & GetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
Object * GetSubsystem (StringHash type) const
 Return subsystem by type.
 
Object * GetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandler * GetEventHandler () 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 ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- 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.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCounted & operator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCount * RefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 
- Public Member Functions inherited from Urho3D::PipelineStateTracker
virtual ~PipelineStateTracker ()
 Destruct.
 
unsigned GetPipelineStateHash () const
 Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.
 
void MarkPipelineStateHashDirty ()
 Mark pipeline state hash as dirty.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Drawable
static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo * GetTypeInfoStatic ()
 Return type info static.
 

Protected Member Functions

void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
 
void OnWorldBoundingBoxUpdate () override
 Recalculate the world-space bounding box.
 
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.
 
void CalculateFixedScreenSize (const FrameInfo &frame)
 Recalculate camera facing and fixed screen size.
 
- Protected Member Functions inherited from Urho3D::Drawable
unsigned RecalculatePipelineStateHash () const override
 Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
 
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
 
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.
 
virtual void OnRemoveFromOctree ()
 Handle removal from octree.
 
void AddToOctree ()
 Add to octree.
 
void RemoveFromOctree ()
 Remove from octree.
 
void RequestUpdateBatchesDelayed (const FrameInfo &frame)
 Request UpdateBatchesDelayed call from main thread.
 
void SetOctant (Octant *octant)
 Move into another octree octant.
 
void SetDrawableIndex (unsigned drawableIndex)
 Update drawable index.
 
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
 
void SetID (unsigned id)
 
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
 
Component * GetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
 
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
 
- Protected Member Functions inherited from Urho3D::PipelineStateTracker
PipelineStateSubscription CreateDependency (PipelineStateTracker *dependency)
 Create dependency onto another pipeline state.
 
void AddSubscriberReference (PipelineStateTracker *subscriber)
 Add reference to subscriber pipeline state tracker.
 
void RemoveSubscriberReference (PipelineStateTracker *subscriber)
 Remove reference to subscriber pipeline state tracker.
 

Protected Attributes

Text text_
 Internally used text element.
 
ea::vector< SharedPtr< Geometry > > geometries_
 Geometries.
 
SharedPtr< VertexBuffer > vertexBuffer_
 Vertex buffer.
 
SharedPtr< Material > material_
 Material to use as a base for the text material(s).
 
ea::vector< UIBatch > uiBatches_
 Text UI batches.
 
ea::vector< 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.
 
float minAngle_
 Minimal angle between text normal and look-at direction.
 
bool fixedScreenSize_
 Fixed screen size flag.
 
bool snapToPixels_ {}
 Snap to pixel flag. Has effect only if fixed screen size is enabled.
 
bool depthTest_ {true}
 Whether to enable the depth test when rendering the text.
 
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.
 
- Protected Attributes inherited from Urho3D::Drawable
BoundingBox worldBoundingBox_
 World-space bounding box.
 
BoundingBox boundingBox_
 Local-space bounding box.
 
ea::vector< SourceBatch > batches_
 Draw call source data.
 
DrawableFlags drawableFlags_
 Drawable flags.
 
GlobalIlluminationType giType_ {}
 Global illumination type.
 
ReflectionMode reflectionMode_ {ReflectionMode::BlendProbesAndZone}
 Reflection mode.
 
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.
 
Octant * octant_
 Octree octant.
 
unsigned drawableIndex_ { M_MAX_UNSIGNED }
 Index of Drawable in Scene. May be updated.
 
CachedDrawableZone cachedZone_
 Current zone.
 
CachedDrawableReflection cachedReflection_
 Current reflection.
 
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 lodBias_
 LOD bias.
 
unsigned lightProbeTetrahedronHint_ { M_MAX_UNSIGNED }
 Light probe tetrahedron hint.
 
ea::vector< Camera * > viewCameras_
 List of cameras from which is seen on the current frame.
 
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
 
unsigned id_
 Unique ID within the scene.
 
bool networkUpdate_
 Network update queued flag.
 
bool enabled_
 Enabled flag.
 
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMap > instanceDefaultValues_
 Attribute default value at each instance level.
 
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
 
bool temporary_
 Temporary flag.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Context > context_
 Execution context.
 

Private Member Functions

 URHO3D_OBJECT (Text3D, Drawable)
 

Additional Inherited Members

- Static Protected Member Functions inherited from Urho3D::Drawable
static Geometry * GetGeometryIfNotEmpty (Geometry *geometry)
 Get Geometry pointer if the source one is not null or empty.
 

Detailed Description

3D text component.

Member Function Documentation

◆ GetCharPosition()

Vector2 Urho3D::Text3D::GetCharPosition ( unsigned  index)

Return position of character by index relative to the text element origin.

◆ GetCharSize()

Vector2 Urho3D::Text3D::GetCharSize ( unsigned  index)

Return size of character by index.

◆ GetColor()

const Color & Urho3D::Text3D::GetColor ( Corner  corner) const

Return corner color.

◆ GetEffectColor()

const Color & Urho3D::Text3D::GetEffectColor ( ) const

Return effect color.

◆ GetEffectDepthBias()

float Urho3D::Text3D::GetEffectDepthBias ( ) const

Return effect depth bias.

◆ GetEffectRoundStroke()

bool Urho3D::Text3D::GetEffectRoundStroke ( ) const

Return effect round stroke.

◆ GetEffectShadowOffset()

const IntVector2 & Urho3D::Text3D::GetEffectShadowOffset ( ) const

Return effect shadow offset.

◆ GetEffectStrokeThickness()

int Urho3D::Text3D::GetEffectStrokeThickness ( ) const

Return effect stroke thickness.

◆ GetFaceCameraMode()

FaceCameraMode Urho3D::Text3D::GetFaceCameraMode ( ) const
inline

Return how the text rotates in relation to the camera.

◆ GetFont()

Font * Urho3D::Text3D::GetFont ( ) const

Return font.

◆ GetFontSize()

float Urho3D::Text3D::GetFontSize ( ) const

Return font size.

◆ GetHeight()

int Urho3D::Text3D::GetHeight ( ) const

Return text height.

◆ GetHorizontalAlignment()

HorizontalAlignment Urho3D::Text3D::GetHorizontalAlignment ( ) const

Return horizontal alignment.

◆ GetMaterial()

Material * Urho3D::Text3D::GetMaterial ( ) const

Return material.

◆ GetNumChars()

unsigned Urho3D::Text3D::GetNumChars ( ) const

Return number of characters.

◆ GetNumRows()

unsigned Urho3D::Text3D::GetNumRows ( ) const

Return number of rows.

◆ GetOpacity()

float Urho3D::Text3D::GetOpacity ( ) const

Return opacity.

◆ GetRowHeight()

int Urho3D::Text3D::GetRowHeight ( ) const

Return row height.

◆ GetRowSpacing()

float Urho3D::Text3D::GetRowSpacing ( ) const

Return row spacing.

◆ GetRowWidth()

int Urho3D::Text3D::GetRowWidth ( unsigned  index) const

Return width of row by index.

◆ GetText()

const ea::string & Urho3D::Text3D::GetText ( ) const

Return text.

◆ GetTextAlignment()

HorizontalAlignment Urho3D::Text3D::GetTextAlignment ( ) const

Return row alignment.

◆ GetTextEffect()

TextEffect Urho3D::Text3D::GetTextEffect ( ) const

Return text effect.

◆ GetVerticalAlignment()

VerticalAlignment Urho3D::Text3D::GetVerticalAlignment ( ) const

Return vertical alignment.

◆ GetWidth()

int Urho3D::Text3D::GetWidth ( ) const

Return text width.

◆ GetWordwrap()

bool Urho3D::Text3D::GetWordwrap ( ) const

Return wordwrap mode.

◆ IsFixedScreenSize()

bool Urho3D::Text3D::IsFixedScreenSize ( ) const
inline

Return whether text has fixed screen size.

◆ RegisterObject()

void Urho3D::Text3D::RegisterObject ( Context *  context)
static

Register object factory. Drawable must be registered first.

◆ SetColor() [1/2]

void Urho3D::Text3D::SetColor ( const Color &  color)

Set color on all corners.

◆ SetColor() [2/2]

void Urho3D::Text3D::SetColor ( Corner  corner,
const Color &  color 
)

Set color on one corner.

◆ SetEffectColor()

void Urho3D::Text3D::SetEffectColor ( const Color &  effectColor)

Set effect color.

◆ SetEffectDepthBias()

void Urho3D::Text3D::SetEffectDepthBias ( float  bias)

Set effect Z bias.

◆ SetEffectRoundStroke()

void Urho3D::Text3D::SetEffectRoundStroke ( bool  roundStroke)

Set stroke rounding. Corners of the font will be rounded off in the stroke so the stroke won't have corners.

◆ SetEffectShadowOffset()

void Urho3D::Text3D::SetEffectShadowOffset ( const IntVector2 &  offset)

Set shadow offset.

◆ SetEffectStrokeThickness()

void Urho3D::Text3D::SetEffectStrokeThickness ( int  thickness)

Set stroke thickness.

◆ SetFaceCameraMode()

void Urho3D::Text3D::SetFaceCameraMode ( FaceCameraMode  mode)

Set how the text should rotate in relation to the camera. Default is to not rotate (FC_NONE).

◆ SetFixedScreenSize()

void Urho3D::Text3D::SetFixedScreenSize ( bool  enable)

Set whether text has fixed size on screen (pixel-perfect) regardless of distance to camera. Works best when combined with face camera rotation. Default false.

◆ SetFontSize()

bool Urho3D::Text3D::SetFontSize ( float  size)

Set font size only while retaining the existing font. Return true if successful.

◆ SetHorizontalAlignment()

void Urho3D::Text3D::SetHorizontalAlignment ( HorizontalAlignment  align)

Set horizontal alignment.

◆ SetMaterial()

void Urho3D::Text3D::SetMaterial ( Material *  material)

Set material.

◆ SetOpacity()

void Urho3D::Text3D::SetOpacity ( float  opacity)

Set opacity.

◆ SetRowSpacing()

void Urho3D::Text3D::SetRowSpacing ( float  spacing)

Set row spacing, 1.0 for original font spacing.

◆ SetText()

void Urho3D::Text3D::SetText ( const ea::string &  text)

Set text. Text is assumed to be either ASCII or UTF8-encoded.

◆ SetTextAlignment()

void Urho3D::Text3D::SetTextAlignment ( HorizontalAlignment  align)

Set row alignment.

◆ SetTextEffect()

void Urho3D::Text3D::SetTextEffect ( TextEffect  textEffect)

Set text effect.

◆ SetVerticalAlignment()

void Urho3D::Text3D::SetVerticalAlignment ( VerticalAlignment  align)

Set vertical alignment.

◆ SetWidth()

void Urho3D::Text3D::SetWidth ( int  width)

Set text width. Only has effect in word wrap mode.

◆ SetWordwrap()

void Urho3D::Text3D::SetWordwrap ( bool  enable)

Set wordwrap. In wordwrap mode the text element will respect its current width. Otherwise it resizes itself freely.

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