inside.object3d: Returns a numeric or logical vector for whether the 3D...

View source: R/inside.object3d.R

inside.object3dR Documentation

Returns a numeric or logical vector for whether the 3D positions given in 'x' are inside the object specified by 'object', 'center', 'angle' and 'par'.

Description

Returns a numeric or logical vector for whether the 3D positions given in 'x' are inside the object specified by 'object', 'center', 'angle' and 'par'.

Usage

inside.object3d(
  x,
  object = c("ellipsoid", "cuboid"),
  par = c(1, 1, 1),
  center = c(0, 0, 0),
  angle = 0,
  logical = FALSE
)

Arguments

x

is a three column matrix representing the x- y- and z-coordinates. If x is a vector, it is considered to be one single 3D point.

object

is string representing the type of object to use. Currently implemented are "ellipsoid" and "cuboid" (may be abbreviated).

par

is a vector of three elements representing the semi axis lengths for ellipsoid and the x-width, y-depth and z-height of cuboid.

center

is a vector of three elements representing the centre position of the object.

angle

is the angle of the major axis of the ellipsoid in the x-y-plane, in the case that object=="ellipsoid".

logical

is TRUE if the output should be locigal instead of numeric.


arnejohannesholmin/cpplot3d documentation built on April 14, 2024, 11:36 p.m.