.. _stdlib_text3d_component:

======
Text3d
======


+++++++
Classes
+++++++

.. _struct-text3d_component-Text3D:

.. das:attribute:: Text3D : NativeComponent

This component is used to display 3D text in the scene. The text is always facing the camera.

Example::

    let node = create_node(NodeData(parent=node))
    add_component(node, new Text3D(text = "3D text"))


:Properties:

.. _function-text3d_component__dot__rq_useDepthScale_Text3D:

.. das:operator:: Text3D.useDepthScale() : bool



.. _function-text3d_component__dot__rq_useDepthScale_rq_clone_Text3D_bool:

.. das:operator:: Text3D.useDepthScale =(value: bool)

If true, the text will be scaled based on the distance from the camera. If false, the text will be the same size regardless of distance. Default is true.

:Arguments: * **value** : bool

.. _function-text3d_component__dot__rq_text_Text3D:

.. das:operator:: Text3D.text() : string



.. _function-text3d_component__dot__rq_text_rq_clone_Text3D_string:

.. das:operator:: Text3D.text =(value: string)

UIText content to be rendered.

:Arguments: * **value** : string

.. _function-text3d_component__dot__rq_pivot_Text3D:

.. das:operator:: Text3D.pivot() : float2



.. _function-text3d_component__dot__rq_pivot_rq_clone_Text3D_float2:

.. das:operator:: Text3D.pivot =(value: float2)

Pivot point of the text. The value is in the range of 0 to 1. Default is (0.5, 0.5).

:Arguments: * **value** : float2

.. _function-text3d_component__dot__rq_size_Text3D:

.. das:operator:: Text3D.size() : float2



.. _function-text3d_component__dot__rq_size_rq_clone_Text3D_float2:

.. das:operator:: Text3D.size =(value: float2)

Max size of the text's bounding box. Default is (-1, -1)

(-1, -1) means the box will be calculated automatically.

:Arguments: * **value** : float2

.. _function-text3d_component__dot__rq_color_Text3D:

.. das:operator:: Text3D.color() : float4



.. _function-text3d_component__dot__rq_color_rq_clone_Text3D_float4:

.. das:operator:: Text3D.color =(value: float4)

Color of the text. Default is white.

:Arguments: * **value** : float4

.. _function-text3d_component__dot__rq_fontSize_Text3D:

.. das:operator:: Text3D.fontSize() : float



.. _function-text3d_component__dot__rq_fontSize_rq_clone_Text3D_float:

.. das:operator:: Text3D.fontSize =(value: float)

Font height of the text. The size in pixels will be determined by the font and the scale of the node. Default is 16.0.

:Arguments: * **value** : float

.. _function-text3d_component__dot__rq_fontScaling_Text3D:

.. das:operator:: Text3D.fontScaling() : bool



.. _function-text3d_component__dot__rq_fontScaling_rq_clone_Text3D_bool:

.. das:operator:: Text3D.fontScaling =(value: bool)

Font scaling. If enabled, applies node scale to the font instead of the text element. Default it true.

:Arguments: * **value** : bool

.. _function-text3d_component__dot__rq_fontId_Text3D:

.. das:operator:: Text3D.fontId() : FontId



.. _function-text3d_component__dot__rq_fontId_rq_clone_Text3D_FontId:

.. das:operator:: Text3D.fontId =(value: FontId)

Font resource id. Default is null it is equal to the default font.

:Arguments: * **value** :  :ref:`FontId <handle-public_resources-FontId>` 

.. _function-text3d_component__dot__rq_effect_Text3D:

.. das:operator:: Text3D.effect() : TextEffect



.. _function-text3d_component__dot__rq_effect_rq_clone_Text3D_TextEffect:

.. das:operator:: Text3D.effect =(value: TextEffect)

UIText effect. Can be None, Shadow, Glow or Outline. Default is None.

:Arguments: * **value** :  :ref:`TextEffect <enum-public_components-TextEffect>` 

.. _function-text3d_component__dot__rq_effectColor_Text3D:

.. das:operator:: Text3D.effectColor() : float4



.. _function-text3d_component__dot__rq_effectColor_rq_clone_Text3D_float4:

.. das:operator:: Text3D.effectColor =(value: float4)

Color of text effect. Default is white.

:Arguments: * **value** : float4

.. _function-text3d_component__dot__rq_effectOffset_Text3D:

.. das:operator:: Text3D.effectOffset() : float2



.. _function-text3d_component__dot__rq_effectOffset_rq_clone_Text3D_float2:

.. das:operator:: Text3D.effectOffset =(value: float2)

Offset of the text effect. Default is (0, 0).

:Arguments: * **value** : float2

.. _function-text3d_component__dot__rq_effectThickness_Text3D:

.. das:operator:: Text3D.effectThickness() : float



.. _function-text3d_component__dot__rq_effectThickness_rq_clone_Text3D_float:

.. das:operator:: Text3D.effectThickness =(value: float)

Thickness of the text effect. Default is 1.

:Arguments: * **value** : float

.. _function-text3d_component__dot__rq_textSize_Text3D:

.. das:operator:: Text3D.textSize() : float2

Actual size of the text's bounding box. This field is read-only.

.. _function-text3d_component__dot__rq_rect_Text3D:

.. das:operator:: Text3D.rect() : float4

Bounding box of the text. Its size is max(size, textSize). This field is read-only.

.. _function-text3d_component__dot__rq_fontAutoSize_Text3D:

.. das:operator:: Text3D.fontAutoSize() : float2



.. _function-text3d_component__dot__rq_fontAutoSize_rq_clone_Text3D_float2:

.. das:operator:: Text3D.fontAutoSize =(value: float2)

Limit of font size. Default is (-1, -1) which means no limit.

:Arguments: * **value** : float2

.. _function-text3d_component__dot__rq_wordWrapping_Text3D:

.. das:operator:: Text3D.wordWrapping() : bool



.. _function-text3d_component__dot__rq_wordWrapping_rq_clone_Text3D_bool:

.. das:operator:: Text3D.wordWrapping =(value: bool)

Word wrapping. Default is true.

If size is (-1, -1) then word wrapping will not take effect.

:Arguments: * **value** : bool

.. _function-text3d_component__dot__rq_margin_Text3D:

.. das:operator:: Text3D.margin() : float4



.. _function-text3d_component__dot__rq_margin_rq_clone_Text3D_float4:

.. das:operator:: Text3D.margin =(value: float4)

UIText margin (left, top, right, bottom). Default is (0, 0, 0, 0).

:Arguments: * **value** : float4

.. _function-text3d_component__dot__rq_horAlignment_Text3D:

.. das:operator:: Text3D.horAlignment() : TextHorAlignment



.. _function-text3d_component__dot__rq_horAlignment_rq_clone_Text3D_TextHorAlignment:

.. das:operator:: Text3D.horAlignment =(value: TextHorAlignment)

Horizontal text alignment. Can be Left, Center or Right. Default is Center

:Arguments: * **value** :  :ref:`TextHorAlignment <enum-public_components-TextHorAlignment>` 

.. _function-text3d_component__dot__rq_vertAlignment_Text3D:

.. das:operator:: Text3D.vertAlignment() : TextVertAlignment



.. _function-text3d_component__dot__rq_vertAlignment_rq_clone_Text3D_TextVertAlignment:

.. das:operator:: Text3D.vertAlignment =(value: TextVertAlignment)

Vertical text alignment. Can be Top, Middle or Bottom. Default is Middle

:Arguments: * **value** :  :ref:`TextVertAlignment <enum-public_components-TextVertAlignment>`