directorWorld: Define a Movie World

In pmur002/director: Automate video demonstrations

Description

Define the world within which a movie will be generated.

realWorld represents the desktop on localhost.

dockerWorld describes a virtual environment based on a Docker image.

directorWorld should be used to define any new worlds.

shootVideo is called by makeMovie; it is only public so that new worlds can write a method for it.

Usage

realWorld
dockerWorld(image, volumes=NULL)
directorWorld(..., class)
shootVideo(world, ...)

Arguments

image	The name of a Docker image.
volumes	Volumes to mount within the Docker container.
...	Parameters that describe the world.
class	A unique class for the world, typically DirectorSomethingWorld.
world	A "DirectorWorld" object.

Details

When a movie is made, the shootVideo function is called with the world as its first argument. Each world class implements a shootVideo method.

Value

A "DirectorWorld" object.

Author(s)

Paul Murrell

See Also

makeMovie.

pmur002/director documentation built on Feb. 18, 2021, 10:23 p.m.