\n\n# About\nEZ-Tree is a procedural tree generator with dozens of tunable parameters. The standalone tree generation code is published as a library and can be imported into your own application for dynamically generating trees on demand. Additionally, there is a standalone web app which allows you to create trees within the browser and export as .PNG or .GLB files.\n\n# App\nhttps://eztree.dev\n\n# Installation\n\n```js\nnpm i @dgreenheck/ez-tree\n```\n\n# Usage\n\n```js\n// Create new instance\nconst tree = new Tree();\n\n// Set parameters\ntree.options.seed = 12345;\ntree.options.trunk.length = 20;\ntree.options.branch.levels = 3;\n\n// Generate tree and add to your Three.js scene\ntree.generate();\nscene.add(tree);\n```\n\nAny time the tree parameters are changed, you must call `generate()` to regenerate the geometry.\n\n# Running Standalone App Locally\n\nTo run the standalone app locally, you first need to build the EZ-Tree library before running the app.\n\n```bash\nnpm install\nnpm run app\n```\n\n# Running App with Docker\n\n```bash\ndocker compose build\ndocker compose up -d\n```\n\n# Tree Parameters\n\nThe `TreeOptions` class defines an options object that controls various parameters of a procedurally generated tree. Each property of this object allows for customization of the tree's appearance, including bark, branches, and leaves. Below is a detailed explanation of each property of the `TreeOptions` object.\n\n## General Properties\n\n- **`seed`**: Sets the initial value for random generation, ensuring consistent tree generation when using the same seed.\n- **`type`**: Defines the type of the tree, which can be set to one of the options from the `TreeType` enumeration (e.g., `TreeType.Deciduous`).\n\n## Bark Parameters\n\nThe `bark` object controls the appearance and properties of the tree trunk.\n\n- **`type`**: Specifies the type of bark texture to use, selected from the `BarkType` enumeration (e.g., `BarkType.Oak`).\n- **`tint`**: Determines the color tint applied to the bark, defined as a hexadecimal color value (e.g., `0xffffff` for white).\n- **`flatShading`**: Boolean property indicating whether to use flat shading (`true`) or smooth shading (`false`) for the bark.\n- **`textured`**: Boolean value that indicates if a texture is applied to the bark (`true` or `false`).\n- **`textureScale`**: Controls the scale of the bark texture in both the `x` and `y` axes. It is an object with properties `x` and `y` to define the scaling factors.\n\n## Branch Parameters\n\nThe `branch` object defines parameters for the trunk and branch levels of the tree.\n\n- **`levels`**: Number of recursive branch levels. Setting this to `0` creates only the trunk, while higher values add more branches.\n- **`angle`**: Defines the angle, in degrees, at which child branches grow relative to their parent branch. This is specified separately for each level.\n- **`children`**: Specifies the number of child branches at each level, with the index (`0`, `1`, `2`, etc.) representing the level.\n- **`force`**: Represents an external directional force encouraging tree growth, defined by `direction` (a vector object `{ x, y, z }`) and `strength` (a numeric value).\n- **`gnarliness`**: Defines how twisted or curled each branch level should be, specified for each level.\n- **`length`**: Length of the branches at each level. This is an object with keys representing each level.\n- **`radius`**: Radius (or thickness) of the branches at each level.\n- **`sections`**: Number of segments along the length of each branch level, controlling the resolution of the branch mesh.\n- **`segments`**: Number of radial segments that make up each branch, with a higher value resulting in a smoother cylinder.\n- **`start`**: Specifies where along the parent branch (as a fraction from `0` to `1`) the child branches should start forming.\n- **`taper`**: Controls the tapering of the branches at each level. A value between `0` and `1` defines the reduction in radius from base to tip.\n- **`twist`**: Defines the amount of twisting applied to each branch level.\n\n## Leaf Parameters\n\nThe `leaves` object defines properties that control the appearance and placement of leaves.\n\n- **`type`**: Specifies the type of leaf texture, selected from the `LeafType` enumeration (e.g., `LeafType.Oak`).\n- **`billboard`**: Defines how leaves are rendered. The `Billboard` enumeration can be set to `Single` or `Double` to indicate single or perpendicular double-sided leaves.\n- **`angle`**: Defines the angle of the leaves relative to the parent branch, in degrees.\n- **`count`**: Number of leaves to generate.\n- **`start`**: Specifies where along the length of the branch (as a value between `0` and `1`) leaves should start growing.\n- **`size`**: Size of the leaves, represented as a numeric value.\n- **`sizeVariance`**: Specifies how much variance in size each leaf instance should have, making the leaves look more natural.\n- **`tint`**: Tint color applied to the leaves, defined as a hexadecimal color value (e.g., `0xffffff` for white).\n- **`alphaTest`**: Sets the alpha threshold for leaf transparency, controlling the transparency of the leaf textures.\n\n","readmeFilename":"README.md"}