Home
API: forms

Interface: BranchParams

lifecycle-kit

lifecycle-kit


lifecycle-kit / forms / BranchParams

Interface: BranchParams

Defined in: forms/rules/branch.ts:13

Properties

angle

readonly angle: number

Defined in: forms/rules/branch.ts:19

Fraction of a turn each child fans out from its parent's direction.


attachAt

readonly attachAt: number

Defined in: forms/rules/branch.ts:28

Where along the unit's own length (0..1) a child branch attaches.


depth

readonly depth: number

Defined in: forms/rules/branch.ts:15

How many recursive levels. 0 emits nothing; 1 is the unit alone.


part

readonly part: string

Defined in: forms/rules/branch.ts:29


shrink

readonly shrink: number

Defined in: forms/rules/branch.ts:26

How much smaller each generation is, 0..1 exclusive. A fern frond's leaflets shrinking toward the tip and a coral's branches thinning with each fork are the same continuous shrink factor at different values — not different rules.


splits

readonly splits: number

Defined in: forms/rules/branch.ts:17

How many children each branch splits into.