Navigation
API > API/Plugins > API/Plugins/Text3D
Base class for a rendering implementation of Text3D The whole rendering logic should be encapsulated into an instance of this class
| Name | UText3DRendererBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Text3D/Source/Text3D/Public/Renderers/Text3DRendererBase.h |
| Include Path | #include "Renderers/Text3DRendererBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UText3DRendererBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UText3DRendererBase
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitialized | bool | Renderers/Text3DRendererBase.h | ||
| CachedBounds | TOptional< FBox > | Renderers/Text3DRendererBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Clear() |
Clears the active rendering state | Renderers/Text3DRendererBase.h | |
void Create() |
Allocate renderer resources | Renderers/Text3DRendererBase.h | |
void Destroy() |
Cleanup renderer resources | Renderers/Text3DRendererBase.h | |
FBox GetBounds() |
Get cached bounds from last update | Renderers/Text3DRendererBase.h | |
virtual FName GetName() |
Get the implementation name for debug purposes | Renderers/Text3DRendererBase.h | |
void Update
(
EText3DRendererFlags InFlags |
Update rendering state | Renderers/Text3DRendererBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UText3DComponent * GetText3DComponent() |
Renderers/Text3DRendererBase.h | ||
virtual FBox OnCalculateBounds() |
Calculate the bounds of the rendered text | Renderers/Text3DRendererBase.h | |
virtual void OnClear() |
Clear rendering state and remove all visible characters | Renderers/Text3DRendererBase.h | |
virtual void OnCreate() |
Create and setup the implementation components, called on load or creation | Renderers/Text3DRendererBase.h | |
virtual void OnDestroy() |
Destroy and clean the implementation components, called on destroy or deactivation | Renderers/Text3DRendererBase.h | |
virtual void OnUpdate
(
EText3DRendererFlags InFlags |
Update rendering state of text characters, called when render state is outdated | Renderers/Text3DRendererBase.h | |
void RefreshBounds() |
Recalculates bounds when a layout or geometry change happened | Renderers/Text3DRendererBase.h |