Skip to contents

Get a 3D Crown File

Source: R/get_crown_file.R
get_crown_file.Rd

Generate a specific 3D representation of a tree crown, given the parameters for the type of tree crown, the desired level of detail or resolution, and whether or not to offset the crown to align it with the trunk at the origin.

Usage

get_crown_file(
  tree = "oval",
  resolution = "medium",
  offset_origin = TRUE,
  solid = FALSE
)

Arguments

tree

Default "rounded". Crown type. Full list of options: "columnar" "pyramidal1" "pyramidal2" "oval" "palm" "rounded" "spreading1" "spreading2" "vase" "weeping"

resolution

Default "medium". Level of detail of the tree mesh. All options: "low" "medium" "high

offset_origin

Default TRUE. Whether to offset the crown so that the bottom of the tree will be exactly at the origin, aligning it with the trunk.

solid

Default FALSE. Whether the crown should be a solid mesh (TRUE), or a collection of flat 2D planes (FALSE).

Value

Filename of OBJ file (as .txt file)

Examples

#Get a crown OBJ
get_crown_file(tree = "rounded", resolution = "high")
#> [1] "/home/runner/work/_temp/Library/tree3d/extdata/highres/rounded_clean_offset.txt"