ftt_add_cakepop: Add code to add primitives to a Blender script

In mikemahoney218/blender-forthetrees: See the Forest (Using 3D Renders in Blender)

Description

This function generates code that will, when run inside Blender, create mesh primitives within a scene.

Usage

ftt_add_cakepop(
  script,
  object,
  height = NULL,
  dbh = NULL,
  crown = TRUE,
  crown_radius = NULL,
  ...
)

## S4 method for signature 'mvdf_obj'
ftt_add_cakepop_method(
  object,
  script,
  height = NULL,
  dbh = NULL,
  crown = TRUE,
  crown_radius = NULL,
  ...
)

## S4 method for signature 'ftt_treesize'
ftt_add_cakepop_method(
  object,
  script,
  height = NULL,
  dbh = NULL,
  crown = TRUE,
  crown_radius = NULL,
  ...
)

Arguments

script	The Python script to append the generated code onto.
object	An object inheriting from mvdf_obj which will be used to calculate the x, y, and z positions for each primitive. One primitive will be created for each row of mvdf(object).
height	The height of the central bole, in meters.
dbh	The diameter of the central bole, in meters. Cake pops do not taper.
crown	Boolean: draw a "crown" sphere?
crown_radius	The radius of the crown, in meters. The crown is centered on the top of the bole.
...	Additional arguments to pass to the primitive creation call. The available arguments are different for each primitive, and are documented in the official Blender documentation at https://docs.blender.org/api/blender_python_api_current/bpy.ops.mesh.html.

Value

A length 1 character vector containing the Blender Python script with code for creating primitives added.

mikemahoney218/blender-forthetrees documentation built on Dec. 24, 2021, 1:27 a.m.