IEMGui

IEMGui Font

class pdpy_lib.iemgui.iemfont.IEMFont(face=None, points=None, json=None, xml=None, **kwargs)

Bases: Base

Represents the IEM gui fonts

This IEM gui object represents an IEM Font

Parameters

• face (int) – An index that refers to a font-face or font-family

• points (int) – An integer representing the font size in points

• json (dict) – A JSON representation of the object.

• xml (xml.etree.ElementTree.Element or None) – An Xml Element with the appropriate element structure.

• **kwargs (optional) – Other keyword arguments are ignored.

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Label

class pdpy_lib.iemgui.iemlabel.IEMLabel(pd_lines=None, json=None, xml=None, **kwargs)

Bases: Base

The IEM IEMLabel Obj

This IEM gui object represents an IEM Label

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• xml (xml.etree.ElementTree.Element or None) – An Xml Element with the appropriate element structure.

• **kwargs (optional) –

  Keyword arguments are:

  • label: (str) the label text

  • x: (int) the x-offset of the label

  • y: (int) the y-offset of the label

  • fface: (int) the font face of the label

  • fsize: (int) the font size of the label

  • lbcolor: (str) the color of the label

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Bang

class pdpy_lib.iemgui.bng.Bng(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Bang object, aka. bng

This IEM gui object represents an IEM Bang button.

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • size: the size of the button

  • hold: time of the button on hold

  • intrrpt: the interruption time of the button

  • init: the init flag to trigger the button on loadtime

  • bgcolor: the background color of the bang

  • fgcolor: the foreground of the bang

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Canvas

class pdpy_lib.iemgui.cnv.Cnv(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Canvas object, aka. cnv or my_canvas

This IEM gui object represents an IEM canvas.

Parameters

• pd_lines (list) – A list of pure data tokens representing this object

• json (dict) – A json dictionary representing this object

• **kwargs (optional) –

  Keyword arguments are:

  • size: the size of the canvas mouse selection box

  • width: the width of the canvas area

  • height: the height of the canvas area

  • bgcolor: the background color of the canvas

  • fgcolor: the foreground of the canvas

  • flag: a flag

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Number Box

class pdpy_lib.iemgui.nbx.Nbx(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Number Box object, aka. nbx

This IEM gui object represents an IEM Number box (Number2)

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • digits_width: the width of the number box in digits.

  • height: the height of the numbers

  • lower: the lower limit of the number box range

  • upper: the upper limit of the number box range

  • log_flag: a flag to enable logarithmic value scaling

  • init: the init flag to trigger the number box on loadtime

  • value: the initial value of the number box (with init)

  • log_height: upper limit of the log scale (with log_flag)

  • bgcolor: the background color of the bang

  • fgcolor: the foreground of the bang

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Radio

class pdpy_lib.iemgui.radio.Radio(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Radio object, aka. hradio or vradio

This IEM gui object represents an IEM horizontal or vertical radio selector.

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • size: the size of each radio button

  • flag: a flag

  • init: the init flag to trigger the radio on loadtime

  • number: the number of buttons

  • value: the initial value of the radio button (with init)

  • bgcolor: the background color of the radio

  • fgcolor: the foreground of the radio

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Slider

class pdpy_lib.iemgui.slider.Slider(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Slider object, aka. vsl or hsl

This IEM gui object represents an IEM horizontal or vertical slider.

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • width: the width of the slider

  • height: the height of the slider

  • lower: the lower limit of the slider range

  • upper: the upper limit of the slider range

  • log_flag: a flag to enable logarithmic value scaling

  • init: the init flag to trigger the slider on loadtime

  • value: the initial value of the number box (with init)

  • log_height: upper limit of the log scale (with log_flag)

  • bgcolor: the background color of the radio

  • fgcolor: the foreground of the radio

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Toggle

class pdpy_lib.iemgui.toggle.Toggle(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Toggle Obj, aka. tgl

This IEM gui object represents an IEM toggle.

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • size: the size of the toggle square

  • init: the init flag to trigger the toggle on loadtime

  • flag: a flag

  • nonzero: the non-zero value when toggle is on.

  • bgcolor: the background color of the toggle

  • fgcolor: the foreground of the toggle

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.

IEMGui Vu Meter

class pdpy_lib.iemgui.vu.Vu(pd_lines=None, json=None, **kwargs)

Bases: Obj

The IEM Vu Meter Object, aka. vu.

This IEM gui object represents an IEM Vu Meter.

Parameters

• pd_lines (list) – The lines of the Pure Data patch that define the object.

• json (dict) – A JSON representation of the object.

• **kwargs (optional) –

  Keyword arguments are:

  • width: the width of the vu meter area

  • height: the height of the vu meter area

  • scale: flag to draw the dB scale or not

  • flag: another flag.

  • bgcolor: the background color of the vu meter

  • fgcolor: the foreground of the vu meter

  Other keyword arguments are passed to pdpy_lib.iemgui.iemlabel.IEMLabel and pdpy_lib.patching.comm.Comm

See also

pdpy_lib.utilities.default.Default

For default parameters.