@woosh/meep-engine 3.52.0 → 3.53.0

package/src/generation/foliage/config/BranchLevelConfig.d.ts

@@ -0,0 +1,288 @@
+/**
+ * Configuration for one recursion level of branch generation (0 = Trunk, 1 = Primary Boughs,
+ * 2 = Secondary Branches, 3 = Twigs).
+ */
+export class BranchLevelConfig {
+    /**
+     * @param {Partial<BranchLevelConfig>} [options]
+     * @returns {BranchLevelConfig}
+     */
+    static from(options?: Partial<BranchLevelConfig>): BranchLevelConfig;
+    /**
+     * Recursion level index (0 = trunk).
+     * @type {number}
+     */
+    level: number;
+    /**
+     * Number of longitudinal Cubic Hermite segments along the spine.
+     * @type {number}
+     */
+    segments: number;
+    /**
+     * Maximum radial vertices around the branch base (>= 3).
+     * @type {number}
+     */
+    radial_segments_max: number;
+    /**
+     * Minimum radial vertices at the branch tip (>= 3).
+     * @type {number}
+     */
+    radial_segments_min: number;
+    /**
+     * Nominal length (for level 0 in meters; for level > 0 as ratio of parent length or meters).
+     * @type {number}
+     */
+    length: number;
+    /**
+     * Relative random variance in length [0, 1].
+     * @type {number}
+     */
+    length_variance: number;
+    /**
+     * 1D Hermite curve scaling child length along parent normalized position t in [0, 1].
+     * @type {AnimationCurve}
+     */
+    length_profile: AnimationCurve;
+    /**
+     * Base radius as a fraction of branch length.
+     * @type {number}
+     */
+    radius_ratio: number;
+    /**
+     * Parametric taper factor in [0, 1] (1 = tapers to near-point, 0 = cylinder).
+     * @type {number}
+     */
+    taper: number;
+    /**
+     * 1D Hermite curve modulating radius along normalized spine position t in [0, 1].
+     * @type {AnimationCurve}
+     */
+    radius_profile: AnimationCurve;
+    /**
+     * Fraction [0, 0.95] at the base of this branch where no child branches spawn.
+     * @type {number}
+     */
+    bare_length_ratio: number;
+    /**
+     * Number of lateral child branch nodes spawned by a branch at this level into (level + 1).
+     * @type {number}
+     */
+    child_count: number;
+    /**
+     * Phyllotactic arrangement for children spawned along this branch.
+     * @type {PhyllotaxisMode|number}
+     */
+    phyllotaxis_mode: PhyllotaxisMode | number;
+    /**
+     * Number of branches per whorl when `phyllotaxis_mode === PhyllotaxisMode.Whorled`.
+     * @type {number}
+     */
+    whorl_count: number;
+    /**
+     * Random azimuthal jitter in radians.
+     * @type {number}
+     */
+    azimuth_jitter: number;
+    /**
+     * Axillary insertion (polar divergence) angle in radians from parent tangent.
+     * @type {number}
+     */
+    insertion_angle: number;
+    /**
+     * Random variation in insertion angle (radians).
+     * @type {number}
+     */
+    insertion_angle_variation: number;
+    /**
+     * 1D Hermite curve scaling insertion angle along parent normalized position t in [0, 1].
+     * Typically wider at bottom of crown (1.0) and steeper near apex (0.6).
+     * @type {AnimationCurve}
+     */
+    insertion_angle_profile: AnimationCurve;
+    /**
+     * Cumulative intrinsic pitch curvature (radians) along the spine.
+     * @type {number}
+     */
+    curvature: number;
+    /**
+     * S-curve reverse pitch curvature in second half of spine (radians).
+     * @type {number}
+     */
+    curve_back: number;
+    /**
+     * Helical azimuthal twist (radians per unit spine t).
+     * @type {number}
+     */
+    spiral_twist: number;
+    /**
+     * Gravitropism strength (positive bends downward toward -Y; negative bends upward toward +Y).
+     * @type {number}
+     */
+    gravitropism: number;
+    /**
+     * Phototropism / heliotropism steering toward sky (+Y) and outward from crown core.
+     * @type {number}
+     */
+    phototropism: number;
+    /**
+     * 3D Curl / Simplex noise gnarl displacement strength.
+     * @type {number}
+     */
+    gnarl_strength: number;
+    /**
+     * Spatial frequency of gnarl noise (cycles per meter).
+     * @type {number}
+     */
+    gnarl_frequency: number;
+    /**
+     * Probability [0, 1] per middle segment of dichotomous/sympodial splitting.
+     * @type {number}
+     */
+    split_probability: number;
+    /**
+     * Number of daughter stems at a fork (2 = dichotomous, 3 = trichotomous).
+     * @type {number}
+     */
+    split_count: number;
+    /**
+     * Divergence angle (radians) at a fork.
+     * @type {number}
+     */
+    split_angle: number;
+    /**
+     * Basal root flare radial expansion multiplier (typically > 0 on level 0 trunk).
+     * @type {number}
+     */
+    flare_amplitude: number;
+    /**
+     * Normalized trunk height [0, 0.5] over which root flare decays.
+     * @type {number}
+     */
+    flare_height_ratio: number;
+    /**
+     * Number of radial root buttress lobes around the trunk base.
+     * @type {number}
+     */
+    flare_lobes: number;
+    /**
+     * Cosine power sharpness of root buttress lobes.
+     * @type {number}
+     */
+    flare_sharpness: number;
+    /**
+     * Bark flute / longitudinal ridge amplitude (fraction of radius).
+     * @type {number}
+     */
+    flute_amplitude: number;
+    /**
+     * Circumferential flute count (integer).
+     * @type {number}
+     */
+    flute_frequency: number;
+    /**
+     * Number of initial rings used for seamless branch collar welding onto parent branch.
+     * @type {number}
+     */
+    collar_weld_rings: number;
+    /**
+     * Fraction of branch length spanned by the weld collar.
+     * @type {number}
+     */
+    collar_length_ratio: number;
+    /**
+     * Upper (adaxial crotch) collar radial flare multiplier.
+     * @type {number}
+     */
+    collar_spread_upper: number;
+    /**
+     * Lower (abaxial underside) collar radial flare multiplier.
+     * @type {number}
+     */
+    collar_spread_lower: number;
+    /**
+     * Blend factor [0, 1] for C1 parent-to-child normal interpolation across the weld collar.
+     * @type {number}
+     */
+    collar_normal_blend: number;
+    /**
+     * Initial lean tilt angle (radians) at the root of the stem (especially level 0 trunk).
+     * @type {number}
+     */
+    basal_lean: number;
+    /**
+     * Sympodial nodal recoil/deflection strength when lateral child branches emerge along this stem.
+     * @type {number}
+     */
+    nodal_kink_strength: number;
+    /**
+     * Per-segment phyllotactic / sympodial zig-zag deflection angle (radians).
+     * @type {number}
+     */
+    internode_zigzag: number;
+    /**
+     * Hermite tangent sharpness [0, 1] at segment nodes (0 = smooth curve, 0.7 = crisp woody elbow).
+     * @type {number}
+     */
+    kink_sharpness: number;
+    /**
+     * Terminal phototropic upward curl strength near the outer tip of lateral branches.
+     * @type {number}
+     */
+    tip_upcurl: number;
+    /**
+     * Biomechanical reaction-wood cross-sectional ovalization on inclined boughs [0, 0.5].
+     * @type {number}
+     */
+    oval_eccentricity: number;
+    /**
+     * 3D geometric bark ridge radial + tangential displacement amplitude (fraction of radius).
+     * @type {number}
+     */
+    bark_displacement: number;
+    /**
+     * Swelling collar boss amplitude on this parent stem around attached child branches.
+     * @type {number}
+     */
+    parent_collar_bulge: number;
+    /**
+     * Number of healed pruned-branch callus knots, burls, or eye scars along this stem.
+     * @type {number}
+     */
+    knot_count: number;
+    /**
+     * Radial amplitude of callus knots and burls (fraction of local branch radius).
+     * @type {number}
+     */
+    knot_strength: number;
+    /**
+     * @param {Partial<BranchLevelConfig>} [overrides]
+     * @returns {this}
+     */
+    applyOverrides(overrides?: Partial<BranchLevelConfig>): this;
+    /**
+     * @param {BranchLevelConfig} other
+     * @returns {this}
+     */
+    copy(other: BranchLevelConfig): this;
+    /**
+     * @returns {BranchLevelConfig}
+     */
+    clone(): BranchLevelConfig;
+    /**
+     * @param {BranchLevelConfig} other
+     * @returns {boolean}
+     */
+    equals(other: BranchLevelConfig): boolean;
+    /**
+     * @returns {number}
+     */
+    hash(): number;
+    /**
+     * @readonly
+     * @type {boolean}
+     */
+    readonly isBranchLevelConfig: boolean;
+}
+import { AnimationCurve } from "../../../engine/animation/curve/AnimationCurve.js";
+import { PhyllotaxisMode } from "./PhyllotaxisMode.js";
+//# sourceMappingURL=BranchLevelConfig.d.ts.map

package/src/generation/foliage/config/BranchLevelConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BranchLevelConfig.d.ts","sourceRoot":"","sources":["../../../../../src/generation/foliage/config/BranchLevelConfig.js"],"names":[],"mappings":"AAMA;;;GAGG;AACH;IAwSI;;;OAGG;IACH,sBAHW,QAAQ,iBAAiB,CAAC,GACxB,iBAAiB,CAM7B;IA/SD;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,UAFU,MAAM,CAEH;IAEb;;;OAGG;IACH,qBAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,qBAFU,MAAM,CAEQ;IAExB;;;OAGG;IACH,QAFU,MAAM,CAEH;IAEb;;;OAGG;IACH,iBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,gBAFU,cAAc,CAE0B;IAElD;;;OAGG;IACH,cAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,OAFU,MAAM,CAEH;IAEb;;;OAGG;IACH,gBAFU,cAAc,CAE8B;IAEtD;;;OAGG;IACH,mBAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,aAFU,MAAM,CAEC;IAEjB;;;OAGG;IACH,kBAFU,eAAe,GAAC,MAAM,CAEgB;IAEhD;;;OAGG;IACH,aAFU,MAAM,CAEA;IAEhB;;;OAGG;IACH,gBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,iBAFU,MAAM,CAEO;IAEvB;;;OAGG;IACH,2BAFU,MAAM,CAEiB;IAEjC;;;;OAIG;IACH,yBAFU,cAAc,CAEyC;IAEjE;;;OAGG;IACH,WAFU,MAAM,CAEC;IAEjB;;;OAGG;IACH,YAFU,MAAM,CAEC;IAEjB;;;OAGG;IACH,cAFU,MAAM,CAEG;IAEnB;;;OAGG;IACH,cAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,cAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,gBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,iBAFU,MAAM,CAEO;IAEvB;;;OAGG;IACH,mBAFU,MAAM,CAEQ;IAExB;;;OAGG;IACH,aAFU,MAAM,CAEA;IAEhB;;;OAGG;IACH,aAFU,MAAM,CAEG;IAEnB;;;OAGG;IACH,iBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,oBAFU,MAAM,CAEU;IAE1B;;;OAGG;IACH,aAFU,MAAM,CAEA;IAEhB;;;OAGG;IACH,iBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,iBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,iBAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,mBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,YAFU,MAAM,CAEE;IAElB;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,kBAFU,MAAM,CAEQ;IAExB;;;OAGG;IACH,gBAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,YAFU,MAAM,CAEE;IAElB;;;OAGG;IACH,mBAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,mBAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,qBAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,YAFU,MAAM,CAED;IAEf;;;OAGG;IACH,eAFU,MAAM,CAEK;IAYrB;;;OAGG;IACH,2BAHW,QAAQ,iBAAiB,CAAC,GACxB,IAAI,CA2DhB;IAED;;;OAGG;IACH,YAHW,iBAAiB,GACf,IAAI,CAsDhB;IAED;;OAEG;IACH,SAFa,iBAAiB,CAM7B;IAED;;;OAGG;IACH,cAHW,iBAAiB,GACf,OAAO,CAsDnB;IAED;;OAEG;IACH,QAFa,MAAM,CAuBlB;IAGL;;;OAGG;IACH,8BAFU,OAAO,CAE8B;CAN9C;+BA9gB8B,mDAAmD;gCAClD,sBAAsB"}