tagged3d: Find tags on rgl objects.

View source: R/scene.R

tagged3dR Documentation

Find tags on rgl objects.

Description

Objects with material properties may have an arbitrary string set as a tag. This function retrieves the id values associated with a given tag, or the tags set on given ids.

Usage

tagged3d(tags = NULL, ids = NULL, full = FALSE, subscene = 0)

Arguments

tags

A vector of tags to use for selection.

ids

A vector of ids to report the tags on.

full

logical; whether to return a dataframe containing id, type, tag, or a vector of ids or tags.

subscene

Where to look: by default, the whole scene is searched. NA restricts the search to the current subscene, or a subscene id can be given.

Details

Exactly one of tags and ids must be specified.

Value

A dataframe is constructed with columns

id

item id

type

item type

tag

item tag

matching the specified tags or ids value. If full = TRUE, the full dataframe is returned, otherwise just the requested ids or tags.

If ids is specified, the return value will be in the same order as ids).

Author(s)

Duncan Murdoch

Examples

open3d()
ids <- plot3d(rnorm(10), rnorm(10), rnorm(10), tag = "plot")
unclass(ids)
tagged3d("plot")
tagged3d(ids = ids, full = TRUE)

rgl documentation built on Oct. 28, 2024, 5:07 p.m.