Protected_awokenProtected_boundsProtected_boundsProtected_enabledProtected_object3DProtected_onProtected_onProtected_renderReadonlyentityReadonlyisRenderer flag
Query mask
Component user data
Defines the horizontal position in the text block that should line up with the local origin.
Can be specified as a numeric x position in local units, a string percentage of the total
text block width e.g. '25%', or one of the following keyword strings: 'left', 'center',
or 'right'.
Defines the vertical position in the text block that should line up with the local origin.
Can be specified as a numeric y position in local units (note: down is negative y), a string
percentage of the total text block height e.g. '25%', or one of the following keyword strings:
'top', 'top-baseline', 'top-cap', 'top-ex', 'middle', 'bottom-baseline', or 'bottom'.
If specified, defines a [minX, minY, maxX, maxY] of a rectangle outside of which all
pixels will be discarded. This can be used for example to clip overflowing text when
whiteSpace='nowrap'.
This is a shortcut for setting the color of the text's material. You can use this
if you don't want to specify a whole custom material. Also, if you do use a custom
material, this color will only be used for this particuar Text instance, even if
that same material instance is shared across multiple Text objects.
Defines a cylindrical radius along which the text's plane will be curved. Positive numbers put
the cylinder's centerline (oriented vertically) that distance in front of the text, for a concave
curvature, while negative numbers put it behind the text for a convex curvature. The centerline
will be aligned with the text's local origin; you can use anchorX to offset it.
Since each glyph is by default rendered with a simple quad, each glyph remains a flat plane
internally. You can use glyphGeometryDetail to add more vertices for curvature inside glyphs.
This is a shortcut for setting the material's polygonOffset and related properties,
which can be useful in preventing z-fighting when this text is laid on top of another
plane in the scene. Positive numbers are further from the camera, negatives closer.
Sets the base direction for the text. The default value of "auto" will choose a direction based on the text's content according to the bidi spec. A value of "ltr" or "rtl" will force the direction.
Indicates whether the component is enabled.
Set whether the component is enabled.
WARNING: This API is experimental and may change.
The opacity of the glyph's fill from 0 to 1. This behaves like the material's opacity but allows
giving the fill a different opacity than the strokeOpacity. A fillOpacity of 0 makes the
interior of the glyph invisible, leaving just the strokeWidth. Defaults to 1.
URL of a custom font to be used. Font files can be in .ttf, .otf, or .woff (not .woff2) formats. Defaults to Noto Sans.
The size at which to render the font in local units; corresponds to the em-box height
of the chosen font.
The style of the font. Currently only used for fallback Noto fonts.
The weight of the font. Currently only used for fallback Noto fonts.
Sets a uniform adjustment to spacing between letters after kerning is applied. Positive numbers increase spacing and negative numbers decrease it.
Sets the height of each line of text, as a multiple of the fontSize. Defaults to 'normal'
which chooses a reasonable height based on the chosen font's ascender/descender metrics.
Get material
Defines a base material to be used when rendering the text. This material will be automatically replaced with a material derived from it, that adds shader code to decrease the alpha for each fragment (pixel) outside the text glyphs, with antialiasing. By default it will derive from a simple white MeshBasicMaterial, but you can use any of the other mesh materials to gain other features like lighting, texture maps, etc.
Also see the color shortcut property.
The maximum width of the text block, above which text may start wrapping according to the
whiteSpace and overflowWrap properties.
Get three.js native object3D
WARNING: This API is experimental and may change.
A blur radius applied to the outer edge of the text's outline. If the outlineWidth is
zero, the blur will be applied at the glyph edge, like CSS's text-shadow blur radius.
Can be specified as either an absolute number in local units, or as a percentage string e.g.
"12%" which is treated as a percentage of the fontSize. Defaults to 0.
WARNING: This API is experimental and may change.
The color of the text outline, if outlineWidth/outlineBlur/outlineOffsetX/Y are set.
Defaults to black.
WARNING: This API is experimental and may change.
A horizontal offset for the text outline.
Can be specified as either an absolute number in local units, or as a percentage string e.g. "12%"
which is treated as a percentage of the fontSize. Defaults to 0.
WARNING: This API is experimental and may change.
A vertical offset for the text outline.
Can be specified as either an absolute number in local units, or as a percentage string e.g. "12%"
which is treated as a percentage of the fontSize. Defaults to 0.
WARNING: This API is experimental and may change.
The opacity of the outline, if outlineWidth/outlineBlur/outlineOffsetX/Y are set.
Defaults to 1.
WARNING: This API is experimental and may change.
The width of an outline/halo to be drawn around each text glyph using the outlineColor and outlineOpacity.
Can be specified as either an absolute number in local units, or as a percentage string e.g.
"12%" which is treated as a percentage of the fontSize. Defaults to 0, which means
no outline will be drawn unless an outlineOffsetX/Y or outlineBlur is set.
Defines how text wraps if the whiteSpace property is normal. Can be either 'normal'
to break at whitespace characters, or 'break-word' to allow breaking within words.
Defaults to 'normal'.
Get local position
Set local position
Get local quaternion
Set local quaternion
Get render order
Set render order
Get local rotation
Set local rotation
Get local scale
Set local scale
Scene own the component
WARNING: This API is experimental and may change.
The color of the text stroke, if strokeWidth is greater than zero. Defaults to gray.
WARNING: This API is experimental and may change.
The opacity of the stroke, if strokeWidth is greater than zero. Defaults to 1.
WARNING: This API is experimental and may change.
The width of an inner stroke drawn inside each text glyph using the strokeColor and strokeOpacity.
Can be specified as either an absolute number in local units, or as a percentage string e.g. "12%"
which is treated as a percentage of the fontSize. Defaults to 0.
The string of text to be rendered.
The horizontal alignment of each line of text within the overall text bounding box.
Indentation for the first character of a line; see CSS text-indent.
Set whether visible
Defines whether text should wrap when a line reaches the maxWidth. Can
be either 'normal' (the default), to allow wrapping according to the overflowWrap property,
or 'nowrap' to prevent wrapping. Note that 'normal' here honors newline characters to
manually break lines, making it behave more like 'pre-wrap' does in CSS.
Get renderer world bounds
Protected_attachProtected_destroyProtected_detachProtected_onProtected_onProtected_onProtected_onProtected_updateProtected_updateProtected_updateBatch update attributes
Text component
Export
Text
Date
2024.1.26
Author
yisky