AutoMovie API
    Preparing search index...

    Function createLight

    • A light a person carries, hangs or stands: a taper candle, a hand-held fire torch, a pendant lamp, a table lamp, a floor lamp or a hurricane lantern.

      A candle and a torch stand upright on the floor of their own space, +Y up; a pendant hangs from its hook at the origin, on the ceiling, its cord down to its shade; a table or floor lamp stands on its round base, its stem up to the lampholder inside its shade; a lantern stands on its fount, its globe above it and its cap on top, its bail raised over it along X. grip is where a hand holds it: anywhere along a candle's taper, a torch's shaft below its head, taken from -Z, a lamp's shade, taken from the side to aim it, or a lantern's bail top, hooked from above. A lantern hangs by its hook, the same bail top. light is where the light comes from, the frame a production places a light at: the top of a candle's wick or a torch's head with +Y up the flame, a lantern's burner at its globe's foot with +Y up the flame, a pendant's shade mouth with +Y down its beam, or a standing lamp's lampholder top with +Y up. The light itself is the render's, not the archetype's; the electric flashlight is createTorch's, its lens the beam's frame. A candle holder waits for a source of the sizes its contacts need, and a standing lamp's switch for its place and travel.

      Parameters

      • params: createLight.IParams

        The kind and any dimension the author fixes.

      • Optionalseed: string | number

        The seed that draws every dimension left free inside its band; absent, each takes the middle of its band.

      Returns Archetype<createLight.Affordance, createLight.Dimension>

      The light.

      For a fixed dimension outside its band.