Skip to contents

End the camera path at its start

cellucid_camera_path_loop_back_set.Rd

Add or remove a last keyframe that returns the camera to the first one (two keyframes or more).

Usage

cellucid_camera_path_loop_back_set(viewer, enabled)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

enabled

true to end with the return, false to remove it. TRUE or FALSE. Required.

Value

A cellucid_action_request, at once and invisibly: the action is sent now, or when the viewer's channel opens. cellucid_action_result(request) returns its outcome (what it did, as names, counts and ids), or NULL when it had nothing to report; request$step is the history step it made.

Details

The viewer's action camera-path.loop-back.set (Camera path). It changes what the viewer shows: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: camera-path.

See also

cellucid_act() sends any action by its type, and cellucid_action_result() collects its answer.

Examples

if (interactive() && requireNamespace("SeuratObject", quietly = TRUE)) {
  data("pbmc_small", package = "SeuratObject")
  viewer <- cellucid_view(SeuratObject::UpdateSeuratObject(pbmc_small))
  request <- cellucid_camera_path_loop_back_set(viewer,
      enabled = FALSE)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}