Method

This node generates and renders a 3D mesh from the text that has been generated according to various attributes using a supplied font. The font must be in TrueType or OpenType format and loaded as a Font resource. Text must be entered via the Text String parameter. Text justification, spacing and kerning may be controlled by various attributes. Kerning may make use of the kerning table supplied with the font, if applicable; or it may be generated optically, using proximity checks between characters. The kerning mode is specified by the Kerning Mode parameter.

The generated mesh is 3D, and its depth is defined by the Extrude Amount parameter. It may also be bevelled using the Bevel Amount parameter. Write On / Write Off parameters allow the text to appear over time, one letter, word or line at a time.

Text strings may be supplied directly via the Text String parameter, or generated by a suitable node connected to the Text String Nodes parameter. Nodes capable of generating text include OSC Text String and RSS Text nodes, enabling strings to be supplied via external sources. Javascript scripts may modify the Text String parameter of a text node in order to control text from a script.

As well as being rendered directly, Text nodes may also be used as an input for various other nodes, including Particle Mesh Emitters, Field 3D Object Emitters, Clone To Mesh, Clone To Volume, Collision Affectors and numerous others.

There is a set of material parameters under the Material property group which controls how the shape is rendered. The material also has a corresponding input which allows Material nodes to be connected to it. See Materials for more information about material properties.

Deformers may be parented to the node, causing the generated mesh to be deformed.

If a valid font resource is not supplied or the text string is empty, this node is ineffective.

Example
Nodegraph Example

Transform

Name Description
Position X Move its position along the x-axis in local space.
Position Y Move its position along the y-axis in local space.
Position Z Move its position along the z-axis in local space.
Rotation Heading Rotate the object about the x-axis.
Rotation Pitch Rotate the object about the y-axis.
Rotation Bank Rotate the object about the z-axis.
Scale X Scale along the x-axis.
Scale Y Scale along the y-axis.
Scale Z Scale along the z-axis.

Inherit Transform Channels

Toggle which transform channels should be inherited. By default, all are on.

Attributes

Name Description
Font Select a font to be used.
Visible Control whether the node is visible or not to the scene.
Text String String of text to be displayed.
Geometry Type How the text is generated to the screen.
  • Polygons, Text is generated into a 3D mesh.
  • Bitmaps, Text is generated into a bitmap image on a 3D plane.
Kerning Control the kerning on the text.
Letter Spacing Scale Scale the spacing between each letter.
Letter Gap Scale the spacing between each letter.
Word Spacing Control the spacing between words.
Line Spacing Control the spacing between each new line.
Point Size Changes the point size of the font.
Write On Off Mode Choose how the text is animated onto the screen.
Write Off Function Choose how the text is animated off the screen.
Write On/Off Time Control the time it takes for the text to appear and disappear on the screen.
Write Off Time Offset Control the time between the write on time finishing and the write off time beginning.
Write On Space Duration How long it takes for a space character to be “written” on.
Write On/Off Fade Time Fades the alpha of text as its written on and off. Only functions in Bitmap mode.
Justification Choose how the text is justified in reference to the gizmo.
Kerning Mode Choose whether kerning is done optically or through a kerning table.
Creation Plane Choose which plane the text is generated on.
Size Scale Scale the size of the text.
Extrude Amount Extrude the text, so it is 3D.
Bevel Amount Bevel the edges around the text.
Static Geometry (Generate Once) Only generate the mesh once on creation. Updates to the text string or geometry deformation will no longer function.
Normal Smoothing Angle The angle difference between two faces that their common edge is will be rendered as smooth.
Circular Generates the text into a circle format
Circular Radius The size of the circle for the text to be fixed around
Deformer Chunks Mode How Connected Deformers in Chunks Vertex Source Mode will affect the text.
  • Letters, Each letter will be treated as a chunk.
  • Words, Each word will be treated as a chunk.

Text Box

Name Description
Fit To Box Enable text to be clamped to fit inside of a defined box.
Box X0 / Y0 Text boxes bottom left X / Y position.
Box X1 / Y1 Text boxes top right X / Y position.

Lines

Name Description
Lines Visible Control whether the node is visible or not to the scene.
Lines Alpha Control the alpha value of the lines.
Colour Control the colour value of the lines.
Use Vertex Colours Colour lines based on the vertex colours of the geometry.
Blend Mode Control how the lines blend with the rest of the scene.
Thick Lines Use lines with thickness relative to their distance to camera.
Hide Back Face Lines Hides the lines around back faces of geometry.
Lock Width Lock the line width to be consistent regardless of distance from camera. Only functions with Thick Lines enabled.
Thick Line Width Control the thickness of all the lines. Only functions with Thick Lines enabled.
Show Silhouette Lines Draws lines along the edges of the object relative to the camera.
Show Normal Difference Lines Draw a line along the edges of the mesh, depending on the angle difference between their mutual faces.
Show Unshared Lines Draw lines along all edges of the shape.
Show Other Lines Show all the lines for each edge of the Mesh.
Unshared Lines Weight Greater control over the alpha of the unshared lines.
Silhouette Lines Weight Greater control over the alpha of the silhouette lines.
Normal Difference Lines Weight Greater control over the alpha of the normal difference lines.
Other Lines Weight Greater control over the alpha of the other lines.
Line Normal Difference Angle Change the threshold angle between two face normals that will generate a line along their common edge. Only functions with Show Normal Lines enabled.
Line Normal Fade Sharpness How much the drawn normal lines will fade away the closer the edge angle is to the Line Normal Difference Angle.
Line Depth Bias Exaggerate the width of the lines based on the distance to the camera. not functional with Lock Width enabled.
Line Silhouette Fade Sharpness How much the drawn silhouette lines will fade away based on the size of the edge angle to the camera.

Materials

see Materials

Inputs

Name Description Typical Node Input
Effectors Use Cloner Effectors to transform the words or letters. Plain Effector
Text String Nodes Override the text string from in the node. OSC Text String
Material Override the default material with another material. Materials
Extruded Material Select the Material to be applied to the extruded section of the mesh. Materials
Transform Modifier Links all transform properties to the input node. Null
Target Node Always faces the x-axis towards the inputs anchor point. Null
Local Transform Override Override the transformation values of the node, relative to its parent. Null

Outputs

This node outputs the normal transformation and translation values, but it also outputs geometry which can be Deformed or used as a mesh source by other nodes.