Polyphase Game Engine
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
Text Class Reference

#include <Text.h>

Inheritance diagram for Text:
Widget Node Object ConsoleOutputText

Public Member Functions

 DECLARE_NODE (Text, Widget)
 
 Text ()
 
virtual ~Text ()
 
virtual void Create () override
 
virtual void Destroy () override
 
TextResource * GetResource ()
 
virtual void GatherProperties (std::vector< Property > &outProps) override
 
void GatherTextProperties (std::vector< Property > &outProps)
 
virtual DrawData GetDrawData () override
 
virtual void PreRender () override
 
virtual void Render () override
 
virtual void SetColor (glm::vec4 color) override
 
virtual void MarkDirty ()
 
void SetFont (Font *font)
 
Font * GetFont ()
 
void SetOutlineColor (glm::vec4 color)
 
glm::vec4 GetOutlineColor () const
 
void SetTextSize (float size)
 
float GetTextSize () const
 
float GetScaledTextSize () const
 
float GetOutlineSize () const
 
float GetSoftness () const
 
float GetCutoff () const
 
void SetHorizontalJustification (Justification just)
 
Justification GetHorizontalJustification () const
 
void SetVerticalJustification (Justification just)
 
Justification GetVerticalJustification () const
 
bool IsWordWrapEnabled () const
 
void EnableWordWrap (bool wrap)
 
void SetText (const std::string &text)
 
void SetText (const char *text)
 
const std::string & GetText () const
 
VertexUI * GetVertices ()
 
uint32_t GetNumCharactersAllocated () const
 
uint32_t GetNumVisibleCharacters () const
 
void MarkVerticesDirty ()
 
float GetTextWidth ()
 
float GetTextHeight ()
 
glm::vec2 GetScaledMinExtent ()
 
glm::vec2 GetScaledMaxExtent ()
 
virtual bool ContainsPoint (int32_t x, int32_t y) override
 
glm::vec2 GetJustifiedOffset ()
 
- Public Member Functions inherited from Widget
 DECLARE_NODE (Widget, Node)
 
 Widget ()
 
virtual void Start () override
 
virtual void SetVisible (bool visible) override
 
virtual void PrepareTick (std::vector< NodePtrWeak > &outTickNodes, bool game, bool recurse) override
 
virtual VertexType GetVertexType () const override
 
virtual bool IsWidget () const override
 
Widget * GetParentWidget ()
 
const Widget * GetParentWidget () const
 
Widget * GetChildWidget (int32_t index)
 
Rect GetRect ()
 
void SetX (float x)
 
void SetY (float y)
 
void SetWidth (float width)
 
void SetHeight (float height)
 
void SetXRatio (float x)
 
void SetYRatio (float y)
 
void SetWidthRatio (float width)
 
void SetHeightRatio (float height)
 
void SetLeftMargin (float left)
 
void SetTopMargin (float top)
 
void SetRightMargin (float right)
 
void SetBottomMargin (float bottom)
 
virtual void SetPosition (float x, float y)
 
virtual void SetDimensions (float width, float height)
 
void SetPosition (glm::vec2 position)
 
void SetDimensions (glm::vec2 dimensions)
 
void SetRect (float x, float y, float width, float height)
 
void SetRect (glm::vec2 position, glm::vec2 dimensions)
 
void SetRect (Rect rect)
 
void SetRatios (float x, float y, float width, float height)
 
void SetMargins (float left, float top, float right, float bottom)
 
void SetOffset (float x, float y)
 
glm::vec2 GetOffset () const
 
void SetSize (float x, float y)
 
glm::vec2 GetSize () const
 
AnchorMode GetAnchorMode () const
 
void SetAnchorMode (AnchorMode anchorMode)
 
bool AnchorStretchesX (AnchorMode mode) const
 
bool AnchorStretchesY (AnchorMode mode) const
 
bool StretchX () const
 
bool StretchY () const
 
glm::vec2 GetAnchorRatio () const
 
void SetFullScreen ()
 
void Centered ()
 
void CenterPivot ()
 
float GetX () const
 
float GetY () const
 
float GetWidth () const
 
float GetHeight () const
 
glm::vec2 GetPosition () const
 
glm::vec2 GetDimensions () const
 
void UpdateRect ()
 
void UpdateColor ()
 
void FitInsideParent ()
 
float GetParentWidth () const
 
float GetParentHeight () const
 
glm::vec4 GetColor () const
 
void SetOpacity (uint8_t opacity)
 
uint8_t GetOpacity () const
 
void SetOpacityFloat (float opacity)
 
float GetOpacityFloat () const
 
virtual bool ShouldHandleInput ()
 
void MarkClean ()
 
bool IsDirty () const
 
bool ContainsMouse (bool testScissor=true) const
 
void MoveToMousePosition ()
 
const glm::mat3 & GetTransform ()
 
void SetRotation (float degrees)
 
float GetRotation () const
 
void SetPivot (glm::vec2 pivot)
 
glm::vec2 GetPivot () const
 
void SetScale (glm::vec2 scale)
 
glm::vec2 GetScale () const
 
glm::vec2 GetAbsoluteScale () const
 
bool IsScissorEnabled () const
 
void EnableScissor (bool enable)
 
Rect GetScissorRect () const
 
void SetUseGameResolution (bool use)
 
bool GetUseGameResolution () const
 
void SetTooltipName (const std::string &name)
 
const std::string & GetTooltipName () const
 
void SetTooltipDescription (const std::string &description)
 
const std::string & GetTooltipDescription () const
 
bool HasTooltip () const
 
- Public Member Functions inherited from Node
 DECLARE_FACTORY_MANAGER (Node)
 
 DECLARE_FACTORY (Node, Node)
 
 DECLARE_OBJECT (Node, Object)
 
 DECLARE_SCRIPT_LINK_BASE (Node)
 
 Node ()
 
virtual ~Node ()
 
void DestroyDeferred ()
 
void Doom ()
 
virtual void SaveStream (Stream &stream, Platform platform)
 
virtual void LoadStream (Stream &stream, Platform platform, uint32_t version)
 
virtual void Copy (Node *srcNode, bool recurse)
 
virtual void Render (PipelineConfig pipelineConfig)
 
virtual void Awake ()
 
virtual void Stop ()
 
virtual void Tick (float deltaTime)
 
virtual void EditorTick (float deltaTime)
 
uint32_t GetLastTickedFrame () const
 
virtual void OnInstanced ()
 
virtual void GatherReplicatedData (std::vector< NetDatum > &outData)
 
virtual void GatherNetFuncs (std::vector< NetFunc > &outFuncs)
 
void GatherPropertyOverrides (std::vector< Property > &outOverrides)
 
void ApplyPropertyOverrides (const std::vector< Property > &overs)
 
virtual void BeginOverlap (Primitive3D *thisComp, Primitive3D *otherComp)
 
virtual void EndOverlap (Primitive3D *thisComp, Primitive3D *otherComp)
 
virtual void OnCollision (Primitive3D *thisComp, Primitive3D *otherComp, glm::vec3 impactPoint, glm::vec3 impactNormal, btPersistentManifold *manifold)
 
NodeId GetNodeId () const
 
uint64_t GetPersistentUuid () const
 
void SetPersistentUuid (uint64_t uuid)
 
void EnsurePersistentUuid ()
 
void EmitSignal (const std::string &name, const std::vector< Datum > &args)
 
void ConnectSignal (const std::string &name, Node *listener, SignalHandlerFP func)
 
void ConnectSignal (const std::string &name, Node *listener, const ScriptFunc &func)
 
void DisconnectSignal (const std::string &name, Node *listener)
 
void RenderShadow ()
 
void RenderSelected (bool renderChildren)
 
Node * CreateChild (TypeId nodeType)
 
Node * CreateChild (const char *typeName)
 
Node * CreateChildClone (Node *srcNode, bool recurse)
 
NodePtr Clone (bool recurse, bool instantiateLinkedScene=true, bool resolveNodePaths=false)
 
void DestroyAllChildren ()
 
Node * GetRoot ()
 
bool IsWorldRoot () const
 
Node * GetSubRoot ()
 
template<class NodeClass >
NodeClass * CreateChild ()
 
template<class NodeClass >
SharedPtr< NodeClass > CreateChildSp ()
 
template<class NodeClass >
NodeClass * CreateChild (const char *name)
 
template<class NodeClass >
SharedPtr< NodeClass > CreateChildSp (const char *name)
 
bool IsDestroyed () const
 
bool IsPendingDestroy () const
 
bool IsDoomed () const
 
bool HasStarted () const
 
bool HasAwoken () const
 
void EnableTick (bool enable)
 
bool IsTickEnabled () const
 
virtual void SetWorld (World *world, bool subRoot)
 
World * GetWorld ()
 
void SetScene (Scene *scene)
 
Scene * GetScene ()
 
uint8_t GetTargetScreen () const
 
void SetTargetScreen (uint8_t screen)
 
std::vector< NetDatum > & GetReplicatedData ()
 
void SetNetId (NetId id)
 
NetId GetNetId () const
 
NetHostId GetOwningHost () const
 
void SetOwningHost (NetHostId hostId, bool setAsPawn=false)
 
void SetReplicate (bool replicate)
 
bool IsReplicated () const
 
void SetReplicateTransform (bool repTransform)
 
bool IsTransformReplicated () const
 
void ForceReplication ()
 
void ClearForcedReplication ()
 
bool NeedsForcedReplication ()
 
virtual bool CheckNetRelevance (Node *playerNode)
 
bool IsAlwaysRelevant () const
 
void SetAlwaysRelevant (bool alwaysRelevant)
 
bool HasTag (const std::string &tag)
 
void AddTag (const std::string &tag)
 
void RemoveTag (const std::string &tag)
 
void SetName (const std::string &newName)
 
const std::string & GetName () const
 
virtual void SetActive (bool active)
 
bool IsActive (bool recurse=false) const
 
bool IsVisible (bool recurse=false) const
 
void SetTransient (bool transient)
 
virtual bool IsTransient () const
 
void SetPersistent (bool persistent)
 
bool IsPersistent () const
 
void SetDefault (bool isDefault)
 
bool IsDefault () const
 
void SetUserdataCreated (bool created)
 
bool IsUserdataCreated () const
 
virtual const char * GetTypeName () const
 
virtual bool IsNode3D () const
 
virtual bool IsPrimitive3D () const
 
virtual bool IsLight3D () const
 
Node * GetParent ()
 
const Node * GetParent () const
 
const std::vector< NodePtr > & GetChildren () const
 
virtual void Attach (Node *parent, bool keepWorldTransform=false, int32_t index=-1)
 
void Detach (bool keepWorldTransform=false)
 
void AddChild (Node *child, int32_t index=-1)
 
void RemoveChild (Node *child)
 
void RemoveChild (int32_t index)
 
template<typename T >
void AddChild (const SharedPtr< T > &child, int32_t index=-1)
 
template<typename T >
void RemoveChild (const SharedPtr< Node > &child)
 
int32_t FindChildIndex (const std::string &name) const
 
int32_t FindChildIndex (Node *child) const
 
Node * FindChild (const std::string &name, bool recurse) const
 
Node * FindChildWithTag (const std::string &name, bool recurse) const
 
Node * FindDescendant (const std::string &name)
 
Node * FindAncestor (const std::string &name)
 
bool HasAncestor (Node *node)
 
Node * GetChild (int32_t index) const
 
Node * GetChildByType (TypeId type) const
 
uint32_t GetNumChildren () const
 
int32_t FindParentNodeIndex () const
 
void SetHitCheckId (uint32_t id)
 
uint32_t GetHitCheckId () const
 
bool IsLateTickEnabled () const
 
void EnableLateTick (bool enable)
 
Script * GetScript ()
 
void SetScriptFile (const std::string &fileName)
 
bool DoChildrenHaveUniqueNames () const
 
void BreakSceneLink ()
 
bool IsSceneLinked (bool ignoreInPie=true) const
 
bool IsSceneLinkedChild (bool ignoreInPie=true)
 
bool IsForeign () const
 
bool HasAuthority () const
 
bool IsOwned () const
 
bool IsLocallyControlled () const
 
Datum GetField (const std::string &key)
 
void SetField (const std::string &name, const Datum &value)
 
Datum GetField (int32_t key)
 
void SetField (int32_t key, const Datum &value)
 
Datum CallFunction (const std::string &name, const std::vector< Datum > &args={})
 
NetFunc * FindNetFunc (const char *name)
 
NetFunc * FindNetFunc (uint16_t index)
 
void InvokeNetFunc (const char *name)
 
void InvokeNetFunc (const char *name, Datum param0)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5, Datum param6)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5, Datum param6, Datum param7)
 
void InvokeNetFunc (const char *name, const std::vector< Datum > &params)
 
const WeakPtr< Node > & GetSelfPtr () const
 
template<typename T >
T * FindChild (const std::string &name, bool recurse)
 
template<typename T >
void Traverse (T func, bool inverted=false)
 
template<typename T >
bool ForEach (T func, bool inverted=false)
 
- Public Member Functions inherited from Object
virtual ~Object ()=default
 
virtual const char * RuntimeName () const =0
 
virtual const char * RuntimeParentName () const =0
 
virtual RuntimeId InstanceRuntimeId () const =0
 
virtual Object * QueryInterface (RuntimeId id) const
 
virtual bool Is (RuntimeId id) const
 
virtual bool Is (const char *name) const
 
virtual bool DrawCustomProperty (Property &prop)
 
template<typename T >
T * As () const
 
virtual bool Equals (const Object *rhs) const
 

Static Public Member Functions

static float GetJustificationRatio (Justification just)
 
- Static Public Member Functions inherited from Widget
static float InterfaceToNormalized (float interfaceCoord, float interfaceSize)
 
static bool IsMouseInside (Rect rect)
 
- Static Public Member Functions inherited from Node
static NodePtr Construct (const std::string &name)
 
static NodePtr Construct (TypeId typeId)
 
static void Destruct (Node *node)
 
static void ProcessPendingDestroys ()
 
static void RegisterNetFuncs (Node *node)
 
static void Deleter (Node *node)
 
template<class NodeClass >
static SharedPtr< NodeClass > Construct ()
 
- Static Public Member Functions inherited from Object
static const char * ClassRuntimeName ()
 

Protected Member Functions

void UpdateVertexData ()
 
void UploadVertexData ()
 
void JustifyLine (VertexUI *vertices, Justification just, int32_t &lineVertStart, int32_t numVerts)
 
- Protected Member Functions inherited from Widget
virtual void SetParent (Node *parent) override
 
float PixelsToRatioX (float x) const
 
float PixelsToRatioY (float y) const
 
float RatioToPixelsX (float x) const
 
float RatioToPixelsY (float y) const
 
void PushScissor ()
 
void PopScissor ()
 
void SetScissor (Rect &area)
 
- Protected Member Functions inherited from Node
void TickCommon (float deltaTime)
 
void ValidateUniqueChildName (Node *newChild)
 
void SendNetFunc (NetFunc *func, uint32_t numParams, const Datum **params)
 

Static Protected Member Functions

static bool HandlePropChange (Datum *datum, uint32_t index, const void *newValue)
 
- Static Protected Member Functions inherited from Widget
static bool HandlePropChange (Datum *datum, uint32_t index, const void *newValue)
 
- Static Protected Member Functions inherited from Node
static bool HandlePropChange (Datum *datum, uint32_t index, const void *newValue)
 
static bool OnRep_OwningHost (Datum *datum, uint32_t index, const void *newValue)
 

Protected Attributes

FontRef mFont
 
std::string mText
 
float mCutoff
 
float mOutlineSize
 
float mTextSize
 
float mSoftness
 
glm::vec4 mOutlineColor
 
VertexUI * mVertices
 
bool mWordWrap = false
 
glm::vec2 mMinExtent = {}
 
glm::vec2 mMaxExtent = {}
 
int32_t mVisibleCharacters
 
uint32_t mNumCharactersAllocated
 
Justification mHoriJust = Justification::Left
 
Justification mVertJust = Justification::Top
 
bool mUploadVertices [MAX_FRAMES] = {}
 
bool mReconstructVertices = false
 
TextResource mResource
 
- Protected Attributes inherited from Widget
Rect mRect
 
Rect mScissorRect
 
glm::mat3 mTransform
 
glm::vec4 mColor
 
glm::vec2 mOffset
 
glm::vec2 mSize
 
glm::vec2 mPivot
 
glm::vec2 mScale
 
glm::vec2 mAbsoluteScale
 
float mRotation
 
AnchorMode mAnchorMode
 
uint8_t mActiveMargins
 
bool mUseScissor
 
bool mUseGameResolution = false
 
uint8_t mOpacity
 
std::string mTooltipName
 
std::string mTooltipDescription
 
- Protected Attributes inherited from Node
std::string mName
 
World * mWorld = nullptr
 
NodePtrWeak mParent
 
NodePtrWeak mSelf
 
std::vector< NodePtr > mChildren
 
std::unordered_map< std::string, Node * > mChildNameMap
 
std::unordered_map< std::string, Signal > mSignalMap
 
std::string mScriptFile
 
uint32_t mLastTickedFrame = 0
 
bool mActive = true
 
bool mVisible = true
 
bool mTransient = false
 
bool mPersistent = false
 
bool mDefault = false
 
bool mUserdataCreated = false
 
bool mHasStarted = false
 
bool mHasAwoken = false
 
bool mDestroyed = false
 
bool mTickEnabled = true
 
bool mLateTick = false
 
SceneRef mScene
 
uint8_t mTargetScreen = 0
 
std::vector< std::string > mTags
 
NodeId mNodeId = INVALID_NODE_ID
 
uint64_t mPersistentUuid = 0
 
std::vector< NetDatum > mReplicatedData
 
NetId mNetId = INVALID_NET_ID
 
NetHostId mOwningHost = INVALID_HOST_ID
 
bool mReplicate = false
 
bool mReplicateTransform = false
 
bool mForceReplicate = false
 
bool mAlwaysRelevant = true
 
Script * mScript = nullptr
 

Friends

class Button
 

Additional Inherited Members

- Static Protected Attributes inherited from Widget
static WeakPtr< Widget > sWidgetToClean
 
static const char * sAnchorModeStrings []
 
- Static Protected Attributes inherited from Node
static std::unordered_map< TypeId, NetFuncMap > sTypeNetFuncMap
 
static std::unordered_set< NodePtrWeak > sPendingDestroySet
 
static NodeId sNextNodeId = NodeId(1)
 

Constructor & Destructor Documentation

◆ Text()

Text::Text ( )

◆ ~Text()

Text::~Text ( )
virtual

Member Function Documentation

◆ ContainsPoint()

bool Text::ContainsPoint ( int32_t  x,
int32_t  y 
)
overridevirtual

Reimplemented from Widget.

◆ Create()

void Text::Create ( )
overridevirtual

Reimplemented from Node.

◆ DECLARE_NODE()

Text::DECLARE_NODE ( Text  ,
Widget   
)

◆ Destroy()

void Text::Destroy ( )
overridevirtual

Reimplemented from Node.

◆ EnableWordWrap()

void Text::EnableWordWrap ( bool  wrap)

◆ GatherProperties()

void Text::GatherProperties ( std::vector< Property > &  outProps)
overridevirtual

Reimplemented from Widget.

◆ GatherTextProperties()

void Text::GatherTextProperties ( std::vector< Property > &  outProps)

◆ GetCutoff()

float Text::GetCutoff ( ) const

◆ GetDrawData()

DrawData Text::GetDrawData ( )
overridevirtual

Reimplemented from Node.

◆ GetFont()

Font * Text::GetFont ( )

◆ GetHorizontalJustification()

Justification Text::GetHorizontalJustification ( ) const

◆ GetJustificationRatio()

float Text::GetJustificationRatio ( Justification  just)
static

◆ GetJustifiedOffset()

glm::vec2 Text::GetJustifiedOffset ( )

◆ GetNumCharactersAllocated()

uint32_t Text::GetNumCharactersAllocated ( ) const

◆ GetNumVisibleCharacters()

uint32_t Text::GetNumVisibleCharacters ( ) const

◆ GetOutlineColor()

glm::vec4 Text::GetOutlineColor ( ) const

◆ GetOutlineSize()

float Text::GetOutlineSize ( ) const

◆ GetResource()

TextResource * Text::GetResource ( )

◆ GetScaledMaxExtent()

glm::vec2 Text::GetScaledMaxExtent ( )

◆ GetScaledMinExtent()

glm::vec2 Text::GetScaledMinExtent ( )

◆ GetScaledTextSize()

float Text::GetScaledTextSize ( ) const

◆ GetSoftness()

float Text::GetSoftness ( ) const

◆ GetText()

const std::string & Text::GetText ( ) const

◆ GetTextHeight()

float Text::GetTextHeight ( )

◆ GetTextSize()

float Text::GetTextSize ( ) const

◆ GetTextWidth()

float Text::GetTextWidth ( )

◆ GetVerticalJustification()

Justification Text::GetVerticalJustification ( ) const

◆ GetVertices()

VertexUI * Text::GetVertices ( )

◆ HandlePropChange()

bool Text::HandlePropChange ( Datum *  datum,
uint32_t  index,
const void *  newValue 
)
staticprotected

◆ IsWordWrapEnabled()

bool Text::IsWordWrapEnabled ( ) const

◆ JustifyLine()

void Text::JustifyLine ( VertexUI *  vertices,
Justification  just,
int32_t &  lineVertStart,
int32_t  numVerts 
)
protected

◆ MarkDirty()

void Text::MarkDirty ( )
virtual

Reimplemented from Widget.

◆ MarkVerticesDirty()

void Text::MarkVerticesDirty ( )

◆ PreRender()

void Text::PreRender ( )
overridevirtual

Reimplemented from Widget.

◆ Render()

void Text::Render ( )
overridevirtual

Reimplemented from Widget.

◆ SetColor()

void Text::SetColor ( glm::vec4  color)
overridevirtual

Reimplemented from Widget.

◆ SetFont()

void Text::SetFont ( Font *  font)

◆ SetHorizontalJustification()

void Text::SetHorizontalJustification ( Justification  just)

◆ SetOutlineColor()

void Text::SetOutlineColor ( glm::vec4  color)

◆ SetText() [1/2]

void Text::SetText ( const char *  text)

◆ SetText() [2/2]

void Text::SetText ( const std::string &  text)

◆ SetTextSize()

void Text::SetTextSize ( float  size)

◆ SetVerticalJustification()

void Text::SetVerticalJustification ( Justification  just)

◆ UpdateVertexData()

void Text::UpdateVertexData ( )
protected

◆ UploadVertexData()

void Text::UploadVertexData ( )
protected

Friends And Related Symbol Documentation

◆ Button

friend class Button
friend

Member Data Documentation

◆ mCutoff

float Text::mCutoff
protected

◆ mFont

FontRef Text::mFont
protected

◆ mHoriJust

Justification Text::mHoriJust = Justification::Left
protected

◆ mMaxExtent

glm::vec2 Text::mMaxExtent = {}
protected

◆ mMinExtent

glm::vec2 Text::mMinExtent = {}
protected

◆ mNumCharactersAllocated

uint32_t Text::mNumCharactersAllocated
protected

◆ mOutlineColor

glm::vec4 Text::mOutlineColor
protected

◆ mOutlineSize

float Text::mOutlineSize
protected

◆ mReconstructVertices

bool Text::mReconstructVertices = false
protected

◆ mResource

TextResource Text::mResource
protected

◆ mSoftness

float Text::mSoftness
protected

◆ mText

std::string Text::mText
protected

◆ mTextSize

float Text::mTextSize
protected

◆ mUploadVertices

bool Text::mUploadVertices[MAX_FRAMES] = {}
protected

◆ mVertices

VertexUI* Text::mVertices
protected

◆ mVertJust

Justification Text::mVertJust = Justification::Top
protected

◆ mVisibleCharacters

int32_t Text::mVisibleCharacters
protected

◆ mWordWrap

bool Text::mWordWrap = false
protected
The documentation for this class was generated from the following files: