R/brainvr-modifying.R

In BrainVR/brainvr-reader: Loading, preprocessing and visualising logs from brainvr framework based app

#' Moves all positions to correspond to the new 0, 0 coordinate
#'
#' Operates on given BrainvrObject, as it needs to fix not only player log,
#' but potential goal positions in the object as well
#' @param obj BrainvrObject with player log and positions data to be translated
#' @param offset New X, Z and Y vector. Needs to be a int vector of lenght 3 (X, Y, Z).
#' @returns BrainvrObject
#' @example
#' \dontrun{
#' obj <- translate_position(obj, (3, 0, -6))
#' }
#' @export
translate_positions <- function(obj, offset) {
  obj <- transform_object(obj, "translate", translate_positions_df,
                          translate_positions_list, offset)
  return(obj)
}

#' Mirrors X and Y to negative and recomputes rotation
#'
#' @param obj
#' @return BrainvrObject with mirrored axes and rotation
#' @example
#' \dontrun{
#' obj <- mirror_axes(obj)
#' }
#' @export
mirror_axes <- function(obj) {
  obj <- transform_object(obj, "mirror", mirror_positions_df,
                          mirror_positions_list)
  return(obj)
}

#' Resizes the map to fit the new constraints.
#'
#' @param multiplier Conversion of a single unit to a new metric
#' @param obj BrainvrObject
#' @return ModifiedUnity object
#'
#' @example
#' \dontrun{
#' obj <- resize_layout(obj, 0.5) #makes it half as large
#' }
#' @export
#'
resize_layout <- function(obj, multiplier) {
  obj <- transform_object(obj, "resize", resize_positions_df,
                          resize_positions_list, multiplier)
  return(obj)
}

#' Loads goal positions to the Brainvr object
#'
#' Current brainvr experiement already have this in the positions settings files.
#' Might reting how this entire thing works in the future
#' @param obj Brainvr object
#' @param df data.frame with goal positions. Goal row must correspond to goal order
#'
#' @return
#'
#' @examples
#' @noRd
add_goal_positions <- function(obj, df, ...) {
  UseMethod("add_goal_positions")
}
#' @export
add_goal_positions.brainvr <- function(obj, df) {
  # VALIDATIONS
  obj$goal_positions <- df
  return(obj)
}

#' Adds goal order vector to determine in what order goals came
#'
#' Current brainvr experiement already have this in the experiment settings files.
#' Might reting how this entire thing works in the future
#' @param obj Brainvr object
#' @param order vector of goal order. eg. (1, 3, 5, 1)
#'
#' @return Brainvr object with added field
#' @export
#'
#' @examples
#' @noRd
add_goal_order <- function(obj, order, ...) {
  UseMethod("add_goal_order")
}
#' @export
add_goal_order.brainvr <- function(obj, order) {
  # validate numebr of goals
  # validate if numbers
  obj$goal_order <- order
  return(obj)
}

#' Smooths positions and recalculates distances
#'
#' @param obj BrainvrObject
#' @param type median, spline
#' @param ... optional parameters for the smoothing. VIZ. navr::smooth_positions_df
#' @importFrom navr smooth_positions
#' @return Brainvr object with smoothed positions
#' @export
smooth_positions.brainvr <- function(obj, type, ...) {
  obj$data$position <- navr::smooth_positions_df(obj$data$position, type, ...)
  obj$data$position <- navr::add_distances(obj$data$position)
  return(obj)
}