Docsv3.30.0
Back to API Reference
Struct

Text3DDeformer

sealed

A deformation of extruded text that a Deform3DModifier applies to each range of its style: the range's solids, layers and decorations bend, twist, taper, ripple, wrap onto a sphere or run along a spline. Angles and extents are measured over the laid-out range, so a deformation keeps its look as the text changes size; lengths are in em of the font size.

Remarks

Edges a deformation would show as straight chords are split until they follow it within the curve tolerance of the text, but never shorter than 1/32 em, so a deformation turning faster than that allows — a full twist of a single glyph — strays from its curve by several times the tolerance. A path follows its spline through 32 samples per curve on average, fewer once the spline has more than 127 curves. Glyph motion of modifiers happens before the deformation, so animated glyphs travel along the deformed shape.
public static Text3DDeformer Default{ get }

A bend of a sixth of a turn away from the viewer about the middle of the range, as new deformations start.

public bool Equals()
public override bool Equals()
public override int GetHashCode()
public bool enabled

Whether the deformation applies.

public Text3DDeformerKind kind

How the deformation reshapes the range.

public Text3DDeformAxis axis

The direction of the range a bend, twist, taper or wave changes along.

public Text3DDeformDirection direction

Where a bend or a wave moves the range.

public float angle

Turn of a bend or twist over the whole range along the axis, and the arc of a sphere across the width of the range, in degrees; negative turns the other way.

public float taper

How much a taper grows the range from its start to its end along the axis: the end stands this fraction of the range's size taller than the start.

public float amplitude

Height of a wave's crests above the range, in em.

public float wavelength

Distance between a wave's crests, in em.

public float speed

Crests a wave travels along the range per second of the text's clock; zero holds it still.

public float phase

Offset of a wave along the range, in crests; drive it to move the wave yourself.

public float pivot

The point along the axis that the deformation leaves in place, from the start of the range at 0 to its end at 1; for a path, the point of the range that lands at position.

public Component path

The spline a path runs the range along: a SplineContainer of the Splines package.

public float position

Where along the spline the pivot of the range lands, from its start at 0 to its end at 1.