cue.spotlight

A cue that dims everything else in the environment and leaves what it wraps lit. On a graph the grid and the rules axis.label draws dim with the unlit marks, and the axes, their numbers, captions and the named values themselves stay: they are what the lit marks are read against.

cue.spotlightNodeExplained in Motion
On this page
Three frames of a spotlight: three curves at full strength, then the axes and two of the curves dimmed with only the teal curve lit, then all three at full strength again.Three frames of a spotlight: three curves at full strength, then the axes and two of the curves dimmed with only the teal curve lit, then all three at full strength again.

#Attributes

atImplicit
When the dimming starts, for a spotlight timed by a duration:: a step (1), a time on the scene's clock (1.5s) or a step with an offset (1 + 500ms). Unwritten, with no in: either, step 0. Not written with in: or out:.
Can be written as shorthand: cue.spotlight:value
in
When a HELD spotlight comes on, in place of at: and duration:: the rest of the environment stays down from here until out: — in: 2; out: 3 keeps the content lit for the whole of step 2, however long the reader stays on it.
out
When a held spotlight lets go: after its in:. Left out, it holds to the end of the scene.
in-duration
How long a held spotlight takes to dim the rest.
Default400ms
out-duration
How long a held spotlight takes to let go.
Default400ms
duration
How long the environment is dimmed, the first and last fifth of it spent dimming and letting go.
Default3s
easing
Accepted, and not read: the dimming comes on and goes off smoothly whatever it is set to.
linearsmooth
Defaultsmooth
sequential
Lights each element of the body in turn, top to bottom, each when the one before's duration has run.
Defaultfalse

#Allowed content

#Allowed in

#Examples

Three frames of a spotlight: a parabola and a line at full strength, then the line and the grid dimmed with only the parabola lit and the axes still full, then both at full strength again.Three frames of a spotlight: a parabola and a line at full strength, then the line and the grid dimmed with only the parabola lit and the axes still full, then both at full strength again.
graph{
    curve(expression: 2 * x + 3; colour: grey)
    cue.spotlight{
        curve(expression: x^2)
    }(
        at: 1
    )
}(
    x-domain: [-3, 4]
    y-domain: [0, 10]
)
Three frames of the second step: a curve and a point, then everything but the point dimming for four seconds.Three frames of the second step: a curve and a point, then everything but the point dimming for four seconds.
graph{
    curve(expression: x^2)
    cue.spotlight{
        point(x: 2; y: 4)
    }(
        at: 2
        duration: 4s
    )
}(
    x-domain: [-3, 3]
    y-domain: [0, 9]
)

#Notes

  • The other marks, the grid and the axes are dimmed, then let back up.
  • Nothing is drawn on the content itself; pair it with a cue.highlight for a ring as well.
  • On a code environment's lines it is a wash over them, as a highlight is.

#Writing guidance

  • Framing a readable graph — When to write a domain, the defaults left alone, naming a series, the ticks the prose reads, and one meaning per hue.

Last updated