Skip to main content

ProjectedTextParams

Other

Parameters for creating text projected onto a surface as a separate surface object.

Import​

import ScriptingApi as api

# Create parameter instance
params = api.ProjectedTextParams()

Properties​

font_family​

Font family used to generate the text outline.

Type: str

font_size_points​

Font size in points used to generate the text outline.

Type: int

bold​

Whether the generated text uses a bold font.

Type: bool

italic​

Whether the generated text uses an italic font.

Type: bool

text_scale​

Uniform text size multiplier in model units.

Type: float

center​

World-space center [x, y, z] of the text before projection.

Type: list

surface_normal​

Local Z axis [x, y, z] of the text and its outward direction.

Type: list

text_direction​

Approximate world-space baseline direction [x, y, z].

Type: list

width_scale​

Additional scale multiplier along the text baseline.

Type: float

height_scale​

Additional scale multiplier perpendicular to the text baseline.

Type: float

thickness​

Distance the text extends from the target surface. Must be greater than zero.

Type: float

overlap_thickness​

Distance the text overlaps the target surface. Must be non-negative.

Type: float

emboss​

When true, the text extends along surfaceNormal; when false, it extends in the opposite direction.

Type: bool

See Also​