Skip to contents

Getter/Setter for the entrance-slot

Source: R/getters_setters.R, R/background.R
entrance.Rd

Works for background-class.

Usage

entrance(object)

entrance(object) <- value

# S4 method for class 'background'
entrance(object)

# S4 method for class 'background'
entrance(object) <- value

Arguments

object

An instance of the background-class.

value

Value with which to replace the original value of the entrance slot.

See also

background-class

Examples

# Initialize background
my_background <- background(shape = rectangle(center = c(0, 0), 
                                              size = c(2, 2)), 
                            objects = list(circle(center = c(0, 0), 
                                                  radius = 0.5)),
                            limited_access = list(segment(from = c(-1, -1), 
                                                          to = c(1, 1))), 
                            entrance = c(-1, 0), 
                            exit = c(1, 0)) 

# Access the entrance slot for the background
entrance(my_background)
#>      [,1] [,2]
#> [1,]   -1    0

# Change the entrance slot for the background
entrance(my_background) <- c(1, 0)
entrance(my_background)
#>      [,1] [,2]
#> [1,]    1    0