Inset#

Import

from scenet import Inset

Defined in

scenet.ir (source)

Install

pip install scenet

Since

0.10

Stability

Public: follows semantic versioning. Below 1.0, a minor release may change it, and the CHANGELOG says how.

class scenet.ir.Inset[source]#

Bases: Strict

A small panel set into a corner of another, and drawn over it.

Readers do not agree on when to read an inset: in Cohn’s 2013 experiments, overlap split them about evenly between the inset and the panel under it. So the order is stated rather than guessed – after its parent, unless read: before.

Example

>>> from scenet import Inset
>>> inset = Inset(use="detail", at="bottom_left", size=0.25)
>>> inset.read.value
'after'

See also

Corner and InsetOrder, what it takes.

use: str#

The name of a panel under panels:, set into this one.

at: Corner#

The corner of its parent the inset sits in, a gutter in from both edges.

size: float#

The inset’s width and height, as a fraction of its parent’s: above 0, at most 0.5.

read: InsetOrder#

When the inset is read: after its parent, or before it.