CNEdEditorBackdrop Text

From PopcornFX
Jump to navigation Jump to search

Text backdrop Last update: v1.11.0 - Main page : Editor backdrops Editor backdrops

This backdrop draws text (3D or 2D) in the scene.

Text backdrop Node properties

Field name Default value Description
Text backdrop 3D Backdrops
AttachToSocket <empty> Parent socket name to which the backdrop should be attached. (Experimental, reserved for future use)
Position { 0, 0, 0 } Backdrop position
EulerOrientation { 0, 0, 0 } Backdrop orientation angles in radians
UniformScale 1.0 Backdrop scale
ApplyScaleToChilds false New v1.11.0 If enabled, will scale all the child backdrops by 'UniformScale'
Text backdrop Data
DataSource Inline Specifies where the sampler fetches the text data
  • Inline : text is specified directly in the sampler properties
  • External : sampler will load an external text file
InlineText Text Backdrop Text to be displayed
ExternalResource <empty> Path to the text file containing the text to be displayed
FontResource <empty> Path to the font file to be used (.ttf)
Text backdrop Layout
DrawMode 3D_Text Sets up the backdrop as a 3D independent object, a billboard, or a text directly displayed on the screen.
  • 3D_Text : Text will be displayed on a plane in 3D space in the scene
  • 2D_Text : Text will be displayed on the HUD
  • Billboard : Text will be displayed in 3D space as a camera-facing billboard
TextColor { 1, 1, 1, 1 } Color of the text
HorizontalAlign Center Horizontal alignment of the text.
  • Left : align the left side of the text on the backdrop origin
  • Center : horizontally center the text on the backdrop origin
  • Right : align the right side of the text on the backdrop origin
VerticalAlign Center Vertical alignment of the text
  • Top : align the top line of the text on the backdrop origin
  • Center : vertically center the text on the backdrop origin
  • Bottom : align the bottom line of the text on the backdrop origin
FontSize 0.1 Size of a glyph in world units
FontResolution 30 Resolution of the font texture in texels per glyph
DropShadowOffset 0.08 Controls the drop-shadow offset, in fraction of the font size.

0 disables the drop-shadow

Text backdrop properties