1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
\name{rglShared}
\alias{rglShared}
\title{
Create shared data from an RGL object
}
\description{
The \pkg{crosstalk} package provides a way for
different parts of an interactive display to
communicate about datasets, using \dQuote{shared data} objects. When selection or filtering
is performed in one view, the result is mirrored
in all other views.
This function allows vertices of RGL objects
to be treated as shared data.
}
\usage{
rglShared(id, key = NULL, group = NULL,
deselectedFade = 0.1,
deselectedColor = NULL,
selectedColor = NULL,
selectedIgnoreNone = TRUE,
filteredFade = 0,
filteredColor = NULL)
}
\arguments{
\item{id}{
An existing RGL id.
}
\item{key}{
Optional unique labels to apply to each vertex.
If missing, numerical keys will be used.
}
\item{group}{
Optional name of the shared group to which
this data belongs. If missing, a random name
will be generated.
}
\item{deselectedFade, deselectedColor}{
Appearance of points that are not selected. See Details.
}
\item{selectedColor}{
Appearance of points that are selected.
}
\item{selectedIgnoreNone}{
If no points are selected, should the points be shown
in their original colors (\code{TRUE}), or in the
deselected colors (\code{FALSE})?
}
\item{filteredFade, filteredColor}{
Appearance of points that have been filtered out.
}
}
\details{
Some functions which normally work on
dataframe-like datasets will accept shared data
objects in their place.
If a selection is in progress, the alpha value for
unselected points is multiplied by \code{deselectedFade}.
If \code{deselectedColor} is \code{NULL}, the color is left
as originally specified; if not, the point is changed to
the color given by \code{deselectedColor}.
If no points have been selected, then by default points
are shown in their original colors. However, if
\code{selectedIgnoreNone = FALSE}, all points are displayed
as if unselected.
The \code{selectedColor} argument is similarly used to
change the color (or not) of selected points, and \code{filteredFade}
and \code{filteredColor} are used for points that
have been filtered out of the display.
}
\value{
An object of class \code{"SharedData"} (from the
optional \pkg{crosstalk} package) which
contains the x, y and z coordinates of the RGL object
with the given \code{id}.
}
\references{
\url{https://rstudio.github.io/crosstalk/index.html}
}
\author{
Duncan Murdoch
}
\seealso{
The \HTMLVignette{WebGL}{}{User Interaction in WebGL} vignette
gives more details.
}
\examples{
save <- options(rgl.useNULL = TRUE)
# rglShared requires the crosstalk package,
# and the slider and rglMouse require manipulateWidget
if (requireNamespace("crosstalk", quietly = TRUE) &&
requireNamespace("manipulateWidget", quietly = TRUE)) {
open3d()
x <- sort(rnorm(100))
y <- rnorm(100)
z <- rnorm(100) + atan2(x, y)
ids <- plot3d(x, y, z, col = rainbow(100))
# The data will be selected and filtered, not the axes.
sharedData <- rglShared(ids["data"])
# Also add some labels that are only displayed
# when points are selected
sharedLabel <- rglShared(text3d(x, y, z, text = 1:100,
adj = -0.5),
group = sharedData$groupName(),
deselectedFade = 0,
selectedIgnoreNone = FALSE)
if (interactive() || in_pkgdown_example())
crosstalk::filter_slider("x", "x", sharedData, ~x) \%>\%
rglwidget(shared = list(sharedData, sharedLabel), controller = .) \%>\%
rglMouse()
}
options(save)
}
|
