R/rgl.orthoview.R

In obreschkow/rglplus: Extension of the 'rgl' 3D Visualization Package

#' @title Display orthogonal projection
#'
#' @description Display orthogonal projection on principal Cartesian planes, with scene centre in the image centre.
#'
#' @importFrom rgl plot3d box3d identityMatrix rotationMatrix view3d
#'
#' @param plane character string, which can be either of `xy`, `yx`, `yz`, `zy`, `zx`, `xz`, where the  first letter is the axis displayed from left to right and the second letter is the axis displayed from bottom to top. The third axis points either out of the screen or into the screen following the right-hand convention.
#' @param fov field of view in degrees, as used in \code{\link[rgl]{view3d}}.
#' @param ... additional arguments for \code{\link[rgl]{view3d}}.
#'
#' @return None
#'
#' @author Danail Obreschkow
#'
#' @examples
#' rgl::plot3d(array(runif(60),c(20,3)), col=rainbow(20), axes=FALSE,
#'             xlim=c(0,1), ylim=c(0,1), zlim=c(0,1), xlab='', ylab='', zlab='')
#' rgl::box3d()
#' rgl.orthoview('xy', fov=20)
#'
#' @seealso \code{\link{rgl.camera}}
#'
#' @export rgl.orthoview

rgl.orthoview = function(plane='xy', fov=0, ...) {
  if (plane=='xy') {
    um = rgl::identityMatrix()
  } else if (plane=='yx') {
    um = rgl::rotationMatrix(3*pi/2,0,0,1)%*%rgl::rotationMatrix(pi,0,1,0)
  } else if (plane=='yz') {
    um = rgl::rotationMatrix(3*pi/2,0,1,0)%*%rgl::rotationMatrix(3*pi/2,1,0,0)
  } else if (plane=='zy') {
    um = rgl::rotationMatrix(pi/2,0,1,0)
  } else if (plane=='xz') {
    um = rgl::rotationMatrix(3*pi/2,1,0,0)
  } else if (plane=='zx') {
    um = rgl::rotationMatrix(pi/2,0,1,0)%*%rgl::rotationMatrix(pi/2,0,0,1)
  } else {
    stop('unknown plane')
  }
  rgl::view3d(userMatrix=um, fov=fov, ...)
}