Documentation / loaders / StrandRibbonOptions

Type Alias: StrandRibbonOptions

StrandRibbonOptions = object

Defined in: libs/loaders/src/curves/strandribbon.ts:25

Options controlling how strand curves are turned into renderable geometry.

Properties

scale?

optional scale?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:33

Uniform scale applied to control point positions.

Remarks

Maya scenes are usually authored in centimetres while the engine works in metres, so archives coming out of XGen normally need 0.01. Defaults to 1.

---

strandStride?

optional strandStride?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:42

Keep only every Nth strand.

Remarks

A full XGen description can hold tens of thousands of strands, which is far more than a CPU-tessellated ribbon mesh should carry. Values above 1 thin the set out evenly. Defaults to 1.

---

maxStrands?

optional maxStrands?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:47

Hard cap on the number of strands kept per curve object, applied after strandStride. Defaults to no limit.

---

segmentsPerStrand?

optional segmentsPerStrand?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:56

Number of ribbon segments generated per strand.

Remarks

When omitted, each control point interval becomes one segment. Setting a lower value resamples the strand along its spline, which is the cheapest way to cut triangle count without dropping strands.

---

widthScale?

optional widthScale?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:64

Multiplier applied to the source's width values.

Remarks

Ribbon geometry needs to be wider than a physical strand to stay visible without coverage-aware shading. Defaults to 1.

---

minWidth?

optional minWidth?: number

Defined in: libs/loaders/src/curves/strandribbon.ts:69

Minimum ribbon half-width in world units, applied after widthScale. Defaults to 0.

---

crossSection?

optional crossSection?: boolean

Defined in: libs/loaders/src/curves/strandribbon.ts:80

Emit two perpendicular ribbon sheets per strand instead of one.

Remarks

A single sheet disappears when viewed edge-on. That is tolerable for a dense cap, where neighbouring strands cover the gap, but not for sparse or planar hair, where a whole group can share the degenerate angle and vanish at once. Crossed sheets double the triangle count and remove the failure. Defaults to true.

---

nodeName?

optional nodeName?: string

Defined in: libs/loaders/src/curves/strandribbon.ts:82

Name assigned to the generated root node. Defaults to Hair.