Docsv3.30.0
Back to API Reference
Struct

Text3DLayer

sealed
Implements:IEquatable<Text3DLayer>IStateSnapshot<Text3DLayer>

An extra solid a Layer3DModifier draws with a UniText3D: an outline around or inside the glyphs, a plate behind them, or a tube along their strokes, with its own depth, place in depth, bevel, colour and materials. Lengths are in em of the font size.

Remarks

Shapes of a unit join into one solid, so a grown outline of the whole text is one connected body. Outlines, tubes and boxes per glyph follow the motion of their glyphs: a joined outline unites anew around glyphs the 2D modifiers move, while under 3D poses every part of it follows the glyph nearest it, so it stretches between glyphs that pose apart and gains vertices the first time they do; a box around a word, line or the whole text stays where the glyphs are laid out. An opaque filled outline per glyph looks like a joined one where neighbours meet and follows its glyph as a whole. A tube reads only the layer's position, depth, colour and face material.
public static Text3DLayer Default{ get }

A grown outline of the whole text behind it, as new layers start.

public static Text3DLayer GlyphOutline{ get }

A grown outline behind each glyph.

public static Text3DLayer GlyphRim{ get }

A thin rim around each glyph, standing out from its front.

public static Text3DLayer RaisedCore{ get }

A shrunk copy of each glyph raised in front of it.

public static Text3DLayer LinePlate{ get }

A rounded plate behind each line.

public static Text3DLayer HighlightPlate{ get }

A rounded plate behind each line, raised like a highlight in depth: the layer new Layer3D styles start with.

public static Text3DLayer WordChip{ get }

A rounded chip behind each word.

public static Text3DLayer StencilPlate{ get }

A plate around the whole text with the glyphs cut through it.

public static Text3DLayer EngravedPlate{ get }

A plate around the whole text with the glyphs engraved into its front.

public static Text3DLayer NeonTube{ get }

A round tube along the strokes of each glyph, in front of it.

public bool PerGlyph{ get }

Whether the layer is drawn as one solid per glyph, built once per glyph and following its motion.

public bool Equals()
public override bool Equals()
public Text3DLayer CaptureStateSnapshot()
public bool StateEquals()
public override int GetHashCode()
public bool enabled

Whether the layer is drawn.

public Text3DLayerShape shape

What the layer is shaped from.

public Text3DLayerUnit unit

The unit the layer makes one shape of; a tube is one shape per glyph whatever the unit.

public float offset

How far the shape grows beyond the glyphs or box, in em; negative shrinks it.

public float width

Width of the band kept inside the edge of the shape, in em; zero or less fills the shape.

public Text3DCorners corners

How the corners an offset opens are drawn.

public float radius

Corner radius of box shapes, in em; zero or less leaves the corners square.

public Text3DLayerCut cut

What the layer cuts out where the glyphs are.

public float cutOffset

How far the cut grows beyond the glyphs, in em.

public float engraveDepth

Depth of engraved recesses, in em; zero or less engraves nothing.

public float position

Distance of the layer's front behind the text's front, in em; negative brings it forward.

public float depth

Distance from the layer's front to its back, in em: a tube's thickness; zero or less hides the layer.

public Text3DBevel bevel

Edge between the layer's faces and its sides, on both sides.

public Color color

Vertex colour of the layer, tinting its materials.

public Material faceMaterial

Material of the layer's front and back, of all of a tube, and of its bevels and sides that name none; when empty, each surface of the layer takes the text's material of the same surface, the front's for a tube.

public Material bevelMaterial

Material of the layer's bevels; the layer's face material when empty, else the text's bevel material.

public Material sideMaterial

Material of the layer's sides; the layer's face material when empty, else the text's side material.

Back to API Reference