Class TextBlock3D

Class Hierarchy

To render a Text Block 3D node Kanzi:

  • Prepares the text as 2D text using pixel metrics.
  • Projects the prepared text to 3D space using the value of Node::Projection2DTo3DScaleProperty to scale pixels to 3D units.

Use pixel values to set the values of text-specific properties such as the FontStyleConcept::SizeProperty or FontStyleConcept::FixedCharacterWidthProperty properties.

Use 3D units to adjust the layout of a Text Block 3D node in 3D space. For example, use 3D units to set the values of the Node::WidthProperty and Node::HeightProperty properties in a Text Block 3D node.

Text Block 3D does not support clipping.

See also

Use a Text Block 3D to display text in 3D space. It uses fonts to render text and has location and orientation in 3D space.

Inherits properties and message types from TextBlock3DMetadata.

Synopsis

Methods
create()

Creates a TextBlock3D node

TextBlock3D.TextBlock3D:create(name)

Creates a TextBlock3D node.

Parameters
name (string)

The name of the node.

Return Values
(TextBlock3D)

The created node.