Skip to content

Commit

Permalink
Merged PR 692: Text Formatting Docs
Browse files Browse the repository at this point in the history
Adding extra guidance around text formatting. (And, updated webinar link/image to the newly listed video.)

Related work items: #600
  • Loading branch information
Cameron-Micka committed Mar 1, 2021
1 parent 1bd66c7 commit 61b7eca
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
Binary file modified Docs/Images/Readme/UnrealAndHL_Webinar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Docs/Text.md
Expand Up @@ -16,6 +16,9 @@ UX Tools contains assets, actors, and components which are optimized to render t

To provide automatic text configuration UX Tools contains an actor named `UxtTextRenderActor` and component named `UxtTextRenderComponent`. The `UxtTextRenderActor` and `UxtTextRenderComponent` automatically construct text with appropriate font, font material, and sizing defaults.

> [!NOTE]
> Automatic text formatting is not supported by the `UxtTextRender` actor and component. To manually add a single line break in text use the `<br>` tag. If your application requires advanced text formatting then [UMG Text](https://docs.unrealengine.com/en-US/InteractiveExperiences/UMG/UserGuide/UMGRichTextBlock/index.html) has support for this. Note, [UMG](https://docs.unrealengine.com/en-US/Engine/UMG/UserGuide/index.html) can cause decreased performance on HoloLens, so it's best to profile after adding UMG to your app.
The `UxtTextRenderComponent` derives from the [TextRenderComponent](https://docs.unrealengine.com/en-US/API/Runtime/Engine/Components/UTextRenderComponent/index.html) and all properties can be accessed and altered via the top level `UxtTextRenderActor` component wrapper actor details panel:

![TextActor](Images/Text/TextActor.png)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -93,7 +93,7 @@ Please note that you also need to [add the UX Tools plugin to your project](Docs

# Videos

| [![Create a HoloLens 2 app](Docs/Images/Readme/CreateHoloLensApp_InsideUnreal.png)](https://youtu.be/u_qR-1DrvMg) | [![Getting started with HoloLens 2 and Unreal Engine](Docs/Images/Readme/GettingStarted_DevDays.png)](https://youtu.be/tGYGA_L8Pnw) | [![Working with UE and HoloLens 2](Docs/Images/Readme/UnrealAndHL_Webinar.png)](https://youtu.be/50zY10O5GM8) |
| [![Create a HoloLens 2 app](Docs/Images/Readme/CreateHoloLensApp_InsideUnreal.png)](https://youtu.be/u_qR-1DrvMg) | [![Getting started with HoloLens 2 and Unreal Engine](Docs/Images/Readme/GettingStarted_DevDays.png)](https://youtu.be/tGYGA_L8Pnw) | [![Working with UE and HoloLens 2](Docs/Images/Readme/UnrealAndHL_Webinar.png)](https://youtu.be/t95Bge-yk5E) |
| :--- | :--- | :--- |
| A step-by-step tutorial on how to set up a dev environment for HoloLens 2 and a simple level from scratch | Walk through how to get started developing for HoloLens 2 using Unreal Engine | Webinar showing how to build a product configurator using UX Tools |

Expand Down

0 comments on commit 61b7eca

Please sign in to comment.