normal3d {affiner}R Documentation

3D normal vectors

Description

normal3d() is an S3 generic that computes a 3D normal vector.

Usage

normal3d(x, ...)

## S3 method for class 'Coord3D'
normal3d(x, cross, ..., normalize = TRUE)

## S3 method for class 'character'
normal3d(x, ..., normalize = TRUE)

## S3 method for class 'Plane3D'
normal3d(x, ..., normalize = TRUE)

Arguments

x

Object to compute a 3D normal vector for such as a Plane3D object

...

Passed to other methods such as as_coord3d().

cross

A Coord3D vector. We'll compute the normal of x and cross by taking their cross product.

normalize

If TRUE normalize to a unit vector

Value

A Coord3D (normal) vector

Examples

normal3d("xy-plane")
normal3d(as_coord3d(2, 0, 0), cross = as_coord3d(0, 2, 0))

[Package affiner version 0.1.3 Index]