Skip to contents

Set the navigation mode

cellucid_camera_navigation_set.Rd

Navigate a view by orbit, planar or free-fly (O, P and G); views with linked cameras share one mode.

Usage

cellucid_camera_navigation_set(viewer, view, mode)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

view

A view: "View N" as the Compare views list numbers its rows (the live view is View 1 while it is shown, the kept views follow in the order they were kept). Text. Required.

mode

"orbit", "planar" or "free" (free-fly). One of "orbit", "planar", "free". 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.navigation.set (Camera). 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.

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_navigation_set(viewer, mode = "orbit",
      view = "View 1")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}