affiner (version 0.1.3)

as_coord2d: Cast to coord2d object

Description

as_coord2d() casts to a Coord2D class object

Usage

as_coord2d(x, ...)
# S3 method for angle
as_coord2d(x, radius = 1, ...)
# S3 method for character
as_coord2d(x, ...)
# S3 method for complex
as_coord2d(x, ...)
# S3 method for Coord3D
as_coord2d(
  x,
  permutation = c("xyz", "xzy", "yxz", "yzx", "zyx", "zxy"),
  ...,
  plane = as_plane3d("xy-plane"),
  scale = 0,
  alpha = angle(45, "degrees")
)
# S3 method for data.frame
as_coord2d(x, ...)
# S3 method for list
as_coord2d(x, ...)
# S3 method for matrix
as_coord2d(x, ...)
# S3 method for numeric
as_coord2d(x, y = rep_len(0, length(x)), ...)
# S3 method for Coord2D
as_coord2d(x, ...)

Value

A Coord2D class object

Arguments

x

An object that can be cast to a Coord2D class object such as a matrix or data frame of coordinates.

...

Further arguments passed to or from other methods

radius

A numeric vector of radial distances.

permutation

Either "xyz" (no permutation), "xzy" (permute y and z axes), "yxz" (permute x and y axes), "yzx" (x becomes z, y becomes x, z becomes y), "zxy" (x becomes y, y becomes z, z becomes x), "zyx" (permute x and z axes). This permutation is applied before the (oblique) projection.

plane

A Plane3D class object representing the plane you wish to project to or an object coercible to one using as_plane3d(plane, ...) such as "xy-plane", "xz-plane", or "yz-plane".

scale

Oblique projection foreshortening scale factor. A (degenerate) 0 value indicates an orthographic projection. A value of 0.5 is used by a “cabinet projection” while a value of 1.0 is used by a “cavalier projection”.

alpha

Oblique projection angle (the angle the third axis is projected going off at). An angle() object or one coercible to one with as_angle(alpha, ...). Popular angles are 45 degrees, 60 degrees, and arctangent(2) degrees.

y

Numeric vector of y-coordinates to be used.

Examples

df <- data.frame(x = sample.int(10, 3),
                 y = sample.int(10, 3))
as_coord2d(df)
as_coord2d(complex(real = 3, imaginary = 2))
as_coord2d(angle(90, "degrees"), radius = 2)
as_coord2d(as_coord3d(1, 2, 2), alpha = degrees(90), scale = 0.5)