Skip to contents

Rename a camera path keyframe

cellucid_camera_path_keyframe_rename.Rd

Give a keyframe another label, unique among the keyframes.

Usage

cellucid_camera_path_keyframe_rename(viewer, keyframe, label)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

keyframe

A keyframe, by its label as the Camera path list shows it. Text (at least 1 character). Required.

label

The new label. Text (at least 1 character). 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.keyframe.rename (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_keyframe_rename(viewer,
      keyframe = "x", label = "x")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}