Urho3D::Text3D Class Reference
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:
Collaboration diagram for Urho3D::Text3D:
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 | 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 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 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 | SetFaceCameraMode (FaceCameraMode mode) |
| Font * | GetFont () const |
| float | GetFontSize () const |
| Material * | GetMaterial () const |
| const 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 |
| FaceCameraMode | GetFaceCameraMode () const |
| 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 String &value) |
| Set text attribute. | |
| 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, unsigned char drawableFlags) | |
| Construct. | |
| ~Drawable () override | |
| Destruct. | |
| void | OnSetEnabled () override |
| 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 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 | SetMaxLights (unsigned num) |
| void | SetCastShadows (bool enable) |
| void | SetOccluder (bool enable) |
| void | SetOccludee (bool enable) |
| 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 () |
| unsigned char | 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 |
| unsigned | GetMaxLights () const |
| bool | GetCastShadows () const |
| bool | IsOccluder () const |
| bool | IsOccludee () const |
| 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 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. | |
| Octant * | GetOctant () const |
| Return octree octant. | |
| 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. | |
| 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. | |
| Light * | GetFirstLight () 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) |
| Add a per-pixel light affecting the object this frame. | |
| void | AddVertexLight (Light *light) |
| Add a per-vertex light affecting the object this frame. | |
| Public Member Functions inherited from Urho3D::Component | |
| Component (Context *context) | |
| Construct. | |
| ~Component () override | |
| Destruct. | |
| 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. | |
| void | MarkNetworkUpdate () override |
| 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) |
| void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. | |
| unsigned | GetID () const |
| bool | IsReplicated () const |
| Node * | GetNode () const |
| Scene * | GetScene () const |
| Return the scene the node belongs to. | |
| bool | IsEnabled () const |
| bool | IsEnabledEffective () const |
| Component * | GetComponent (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) | |
| Construct. | |
| ~Animatable () override | |
| Destruct. | |
| bool | LoadXML (const XMLElement &source) override |
| Load from XML data. Return true if successful. | |
| bool | LoadJSON (const JSONValue &source) override |
| Load from JSON data. Return true if successful. | |
| void | SetAnimationEnabled (bool enable) |
| 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) |
| 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 |
| ObjectAnimation * | GetObjectAnimation () const |
| ValueAnimation * | GetAttributeAnimation (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) | |
| 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 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) |
| Load from binary data. 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) |
| bool | SetAttribute (const String &name, const Variant &value) |
| Set attribute by name. Return true if successfully set. | |
| void | SetInstanceDefault (bool enable) |
| Set instance-level default flag. | |
| 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) |
| 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 |
| Variant | GetAttribute (const String &name) const |
| Return attribute value by name. Return empty if not found. | |
| Variant | GetAttributeDefault (unsigned index) const |
| Variant | GetAttributeDefault (const String &name) const |
| Return attribute default value by name. Return empty if not found. | |
| unsigned | GetNumAttributes () const |
| unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes. | |
| bool | IsTemporary () const |
| bool | GetInterceptNetworkUpdate (const String &attributeName) const |
| Return whether an attribute's network updates are being intercepted. | |
| NetworkState * | GetNetworkState () const |
| Return the network attribute state, if allocated. | |
| 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 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 | 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 | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| 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. | |
| 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, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| 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 String & | GetCategory () const |
| 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. | |
| 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 |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () |
| 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. | |
| Static Public Member Functions inherited from Urho3D::Animatable | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Protected Member Functions | |
| void | OnNodeSet (Node *node) 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 | |
| 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 | SetOctant (Octant *octant) |
| Move into another octree octant. | |
| Protected Member Functions inherited from Urho3D::Component | |
| void | OnAttributeAnimationAdded () override |
| Handle attribute animation added. | |
| void | OnAttributeAnimationRemoved () override |
| Handle attribute animation removed. | |
| 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. | |
| void | HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData) |
| Handle scene attribute animation update event. | |
| 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::Animatable | |
| virtual Animatable * | FindAttributeAnimationTarget (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. | |
| AttributeAnimationInfo * | GetAttributeAnimationInfo (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. | |
Protected Attributes | |
| Text | text_ |
| Internally used text element. | |
| Vector< SharedPtr< Geometry > > | geometries_ |
| Geometries. | |
| SharedPtr< VertexBuffer > | vertexBuffer_ |
| Vertex buffer. | |
| SharedPtr< Material > | material_ |
| Material to use as a base for the text material(s). | |
| PODVector< UIBatch > | uiBatches_ |
| 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. | |
| float | minAngle_ |
| Minimal angle between text normal and look-at direction. | |
| bool | fixedScreenSize_ |
| Fixed screen size flag. | |
| 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. | |
| Vector< SourceBatch > | batches_ |
| 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. | |
| Octant * | octant_ |
| Octree octant. | |
| Zone * | zone_ |
| 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. | |
| Light * | firstLight_ |
| 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. | |
| 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::Animatable | |
| bool | animationEnabled_ |
| Animation enabled. | |
| SharedPtr< ObjectAnimation > | objectAnimation_ |
| Animation. | |
| HashSet< const AttributeInfo * > | animatedNetworkAttributes_ |
| Animated network attribute set. | |
| HashMap< String, SharedPtr< AttributeAnimationInfo > > | attributeAnimationInfos_ |
| Attribute animation infos. | |
| Protected Attributes inherited from Urho3D::Serializable | |
| UniquePtr< NetworkState > | networkState_ |
| Network attribute state. | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Private Member Functions | |
| URHO3D_OBJECT (Text3D, Drawable) | |
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.
Here is the call graph for this function:
◆ GetCharSize()
| Vector2 Urho3D::Text3D::GetCharSize | ( | unsigned | index | ) |
Return size of character by index.
Here is the call graph for this function:
◆ GetColor()
Return corner color.
Here is the call graph for this function:
◆ GetEffectColor()
| const Color & Urho3D::Text3D::GetEffectColor | ( | ) | const |
Return effect color.
Here is the call graph for this function:
◆ GetEffectDepthBias()
| float Urho3D::Text3D::GetEffectDepthBias | ( | ) | const |
Return effect depth bias.
Here is the call graph for this function:
◆ GetEffectRoundStroke()
| bool Urho3D::Text3D::GetEffectRoundStroke | ( | ) | const |
Return effect round stroke.
Here is the call graph for this function:
◆ GetEffectShadowOffset()
| const IntVector2 & Urho3D::Text3D::GetEffectShadowOffset | ( | ) | const |
Return effect shadow offset.
Here is the call graph for this function:
◆ GetEffectStrokeThickness()
| int Urho3D::Text3D::GetEffectStrokeThickness | ( | ) | const |
Return effect stroke thickness.
Here is the call graph for this function:
◆ GetFaceCameraMode()
|
inline |
Return how the text rotates in relation to the camera.
◆ GetFont()
| Font * Urho3D::Text3D::GetFont | ( | ) | const |
Return font.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ GetFontSize()
| float Urho3D::Text3D::GetFontSize | ( | ) | const |
Return font size.
Here is the call graph for this function:
◆ GetHeight()
| int Urho3D::Text3D::GetHeight | ( | ) | const |
Return text height.
Here is the call graph for this function:
◆ GetHorizontalAlignment()
| HorizontalAlignment Urho3D::Text3D::GetHorizontalAlignment | ( | ) | const |
Return horizontal alignment.
Here is the call graph for this function:
◆ GetMaterial()
| Material * Urho3D::Text3D::GetMaterial | ( | ) | const |
Return material.
◆ GetNumChars()
| unsigned Urho3D::Text3D::GetNumChars | ( | ) | const |
Return number of characters.
Here is the call graph for this function:
◆ GetNumRows()
| unsigned Urho3D::Text3D::GetNumRows | ( | ) | const |
Return number of rows.
Here is the call graph for this function:
◆ GetOpacity()
| float Urho3D::Text3D::GetOpacity | ( | ) | const |
Return opacity.
Here is the call graph for this function:
◆ GetRowHeight()
| int Urho3D::Text3D::GetRowHeight | ( | ) | const |
Return row height.
Here is the call graph for this function:
◆ GetRowSpacing()
| float Urho3D::Text3D::GetRowSpacing | ( | ) | const |
Return row spacing.
Here is the call graph for this function:
◆ GetRowWidth()
| int Urho3D::Text3D::GetRowWidth | ( | unsigned | index | ) | const |
Return width of row by index.
Here is the call graph for this function:
◆ GetText()
| const String & Urho3D::Text3D::GetText | ( | ) | const |
Return text.
Here is the call graph for this function:
◆ GetTextAlignment()
| HorizontalAlignment Urho3D::Text3D::GetTextAlignment | ( | ) | const |
Return row alignment.
Here is the call graph for this function:
◆ GetTextEffect()
| TextEffect Urho3D::Text3D::GetTextEffect | ( | ) | const |
Return text effect.
Here is the call graph for this function:
◆ GetVerticalAlignment()
| VerticalAlignment Urho3D::Text3D::GetVerticalAlignment | ( | ) | const |
Return vertical alignment.
Here is the call graph for this function:
◆ GetWidth()
| int Urho3D::Text3D::GetWidth | ( | ) | const |
Return text width.
Here is the call graph for this function:
◆ GetWordwrap()
| bool Urho3D::Text3D::GetWordwrap | ( | ) | const |
Return wordwrap mode.
Here is the call graph for this function:
◆ IsFixedScreenSize()
|
inline |
Return whether text has fixed screen size.
◆ SetColor() [1/2]
| void Urho3D::Text3D::SetColor | ( | const Color & | color | ) |
Set color on all corners.
Here is the call graph for this function:
◆ SetColor() [2/2]
Set color on one corner.
Here is the call graph for this function:
◆ SetEffectColor()
| void Urho3D::Text3D::SetEffectColor | ( | const Color & | effectColor | ) |
Set effect color.
Here is the call graph for this function:
◆ SetEffectDepthBias()
| void Urho3D::Text3D::SetEffectDepthBias | ( | float | bias | ) |
Set effect Z bias.
Here is the call graph for this function:
◆ 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.
Here is the call graph for this function:
◆ SetEffectShadowOffset()
| void Urho3D::Text3D::SetEffectShadowOffset | ( | const IntVector2 & | offset | ) |
Set shadow offset.
Here is the call graph for this function:
◆ SetEffectStrokeThickness()
| void Urho3D::Text3D::SetEffectStrokeThickness | ( | int | thickness | ) |
Set stroke thickness.
Here is the call graph for this function:
◆ 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).
Here is the call graph for this function:
◆ 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.
Here is the call graph for this function:
◆ SetFontSize()
| bool Urho3D::Text3D::SetFontSize | ( | float | size | ) |
Set font size only while retaining the existing font. Return true if successful.
Here is the call graph for this function:
◆ SetHorizontalAlignment()
| void Urho3D::Text3D::SetHorizontalAlignment | ( | HorizontalAlignment | align | ) |
Set horizontal alignment.
Here is the call graph for this function:
◆ SetMaterial()
| void Urho3D::Text3D::SetMaterial | ( | Material * | material | ) |
Set material.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetOpacity()
| void Urho3D::Text3D::SetOpacity | ( | float | opacity | ) |
Set opacity.
Here is the call graph for this function:
◆ SetRowSpacing()
| void Urho3D::Text3D::SetRowSpacing | ( | float | spacing | ) |
Set row spacing, 1.0 for original font spacing.
Here is the call graph for this function:
◆ SetText()
| void Urho3D::Text3D::SetText | ( | const String & | text | ) |
Set text. Text is assumed to be either ASCII or UTF8-encoded.
Here is the call graph for this function:
◆ SetTextAlignment()
| void Urho3D::Text3D::SetTextAlignment | ( | HorizontalAlignment | align | ) |
Set row alignment.
Here is the call graph for this function:
◆ SetTextEffect()
| void Urho3D::Text3D::SetTextEffect | ( | TextEffect | textEffect | ) |
Set text effect.
Here is the call graph for this function:
◆ SetVerticalAlignment()
| void Urho3D::Text3D::SetVerticalAlignment | ( | VerticalAlignment | align | ) |
Set vertical alignment.
Here is the call graph for this function:
◆ SetWidth()
| void Urho3D::Text3D::SetWidth | ( | int | width | ) |
Set text width. Only has effect in word wrap mode.
Here is the call graph for this function:
◆ 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.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- Source/Urho3D/UI/Text3D.h
- Source/Urho3D/UI/Text3D.cpp