Show / Hide Table of Contents

Class GuiText

Creates a text mesh for the GUI.

Inheritance
System.Object
SceneComponent
Mesh
GuiText
Implements
IComponent
IManagedMesh
System.IDisposable
Inherited Members
Mesh.DisposeData
Mesh.SessionUniqueIdentifier
Mesh.UpdatePerFrame
Mesh.ResetIndexLists()
Mesh.Triangles
Mesh.Vertices
Mesh.Normals
Mesh.UVs
Mesh.BoneWeights
Mesh.BoneIndices
Mesh.Tangents
Mesh.BiTangents
Mesh.Colors0
Mesh.Colors1
Mesh.Colors2
Mesh.Flags
Mesh.VerticesSet
Mesh.TangentsSet
Mesh.BiTangentsSet
Mesh.Colors0Set
Mesh.Colors1Set
Mesh.Colors2Set
Mesh.NormalsSet
Mesh.UVsSet
Mesh.BoneWeightsSet
Mesh.BoneIndicesSet
Mesh.TrianglesSet
Mesh.FlagsSet
Mesh.BoundingBox
Mesh.MeshType
Mesh.Dispose()
Mesh.Dispose(Boolean)
SceneComponent.Name
SceneComponent.Active
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fusee.Engine.Gui
Assembly: Fusee.Engine.Gui.dll
Syntax
public class GuiText : Mesh, IComponent, IManagedMesh, IDisposable

Constructors

GuiText(FontMap, String, HorizontalTextAlignment)

Returns the text mesh.

Declaration
public GuiText(FontMap fontMap, string text, HorizontalTextAlignment horizontalAlignment)
Parameters
Type Name Description
FontMap fontMap
System.String text
HorizontalTextAlignment horizontalAlignment

Defines the HorizontalAlignment of the text. This is needed here because it changes the shape of the mesh.

Properties

Height

The height of the text mesh's bounding box.

Declaration
public float Height { get; }
Property Value
Type Description
System.Single

HorizontalAlignment

Defines the HorizontalAlignment of the text. This is needed here because it changes the shape of the mesh. The mesh's vertices will be recalculated the value is set.

Declaration
public HorizontalTextAlignment HorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalTextAlignment

LineNormals

The Normals per line of text.

Declaration
public List<List<float3>> LineNormals { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Collections.Generic.List<float3>>

LineTriangles

The Triangles per line of text.

Declaration
public List<List<uint>> LineTriangles { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Collections.Generic.List<System.UInt32>>

LineUVs

The UV coordinates per line of text.

Declaration
public List<List<float2>> LineUVs { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Collections.Generic.List<float2>>

LineVertices

The Vertices per line of text.

Declaration
public List<List<float3>> LineVertices { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Collections.Generic.List<float3>>

Text

The text to display. The Vertices, Triangles, Normals and UV coordinates will be recalculated if this value is set.

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

Width

The width of the text mesh's bounding box.

Declaration
public float Width { get; }
Property Value
Type Description
System.Single

Implements

IComponent
IManagedMesh
System.IDisposable
Generated by DocFX
GitHub Repo
Back to top