ellipsoid.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/objects.R
\name{ellipsoid}
\alias{ellipsoid}
\title{Ellipsoid Object}
\usage{
ellipsoid(
  x = 0,
  y = 0,
  z = 0,
  a = 1,
  b = 1,
  c = 1,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)
}
\arguments{
\item{x}{Default `0`. x-coordinate of the center of the ellipsoid.}

\item{y}{Default `0`. y-coordinate of the center of the ellipsoid.}

\item{z}{Default `0`. z-coordinate of the center of the ellipsoid.}

\item{a}{Default `1`. Principal x-axis of the ellipsoid.}

\item{b}{Default `1`. Principal y-axis of the ellipsoid.}

\item{c}{Default `1`. Principal z-axis of the ellipsoid.}

\item{material}{Default  \code{\link{diffuse}}.The material, called from one of the material
functions \code{\link{diffuse}}, \code{\link{metal}}, or \code{\link{dielectric}}.}

\item{angle}{Default `c(0, 0, 0)`. Angle of rotation around the x, y, and z axes, applied in the order specified in `order_rotation`.}

\item{order_rotation}{Default `c(1, 2, 3)`. The order to apply the rotations, referring to "x", "y", and "z".}

\item{flipped}{Default `FALSE`. Whether to flip the normals.}

\item{scale}{Default `c(1, 1, 1)`. Scale transformation in the x, y, and z directions. If this is a single value,
number, the object will be scaled uniformly. Note: emissive objects may not currently function correctly when scaled.}
}
\value{
Single row of a tibble describing the ellipsoid in the scene.
}
\description{
Note: this is just a scaled sphere.
}
\examples{
#Generate an ellipsoid in a Cornell box
if(run_documentation()) {
generate_cornell() \%>\%
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 50, c = 50)) \%>\%
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
}

#Change the axes to make it taller rather than wide:
if(run_documentation()) {
generate_cornell() \%>\%
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 200, c = 100, material = metal())) \%>\%
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
}

#Rotate it and make it dielectric:
if(run_documentation()) {
generate_cornell() \%>\%
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 200, c = 100, angle = c(0, 0, 45),
                       material = dielectric())) \%>\%
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
}
}