Tremolo

class indicatortools.Tremolo(beam_count=3, is_slurred=None)

A (two-note) tremolo.

Example 1. With two beams:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo(beam_count=2)
>>> attach(tremolo, chord)
>>> show(chord) 

Example 2. With three beams:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo(beam_count=3)
>>> attach(tremolo, chord)
>>> show(chord) 

Tremolo affects the formatting of chords.

Tremolo has no effect when attached to notes or rests.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.Tremolo.Tremolo" [color=black, fontcolor=white, group=2, label=<<B>Tremolo</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.Tremolo.Tremolo"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

beam_count Gets beam count of tremolo.
is_slurred Is true when tremolo is slurred.
__copy__(\*args) Copies tremolo.
__eq__(expr) Is true when all initialization values of Abjad value object equal the initialization values of expr.
__format__([format_specification]) Formats stem tremolo.
__hash__() Hashes Abjad value object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of tremolo.

Read-only properties

Tremolo.beam_count

Gets beam count of tremolo.

Example 1. With two beams:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo(beam_count=2)
>>> attach(tremolo, chord)
>>> show(chord) 

Example 2. With three beams:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo()
>>> attach(tremolo, chord)
>>> show(chord) 

Set to positive integer.

Defaults to 3.

Returns positive integer.

Tremolo.is_slurred

Is true when tremolo is slurred. Otherwise false.

Example 1. Without slur:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo()
>>> attach(tremolo, chord)
>>> show(chord) 

Example 2. With slur:

>>> chord = Chord("<cs' e'>4")
>>> tremolo = indicatortools.Tremolo(is_slurred=True)
>>> attach(tremolo, chord)
>>> show(chord) 

Set to true or false.

Defaults to false.

Returns true or false.

Special methods

Tremolo.__copy__(*args)

Copies tremolo.

Example 1. Copies tremolo:

>>> import copy
>>> tremolo_1 = indicatortools.Tremolo(beam_count=2)
>>> tremolo_2 = copy.copy(tremolo_1)
>>> tremolo_1 == tremolo_2
True
>>> tremolo_1 is not tremolo_2
True

Returns new tremolo.

(AbjadValueObject).__eq__(expr)

Is true when all initialization values of Abjad value object equal the initialization values of expr.

Returns true or false.

Tremolo.__format__(format_specification='')

Formats stem tremolo.

Example 1. With two beams:

>>> tremolo = indicatortools.Tremolo(beam_count=2)
>>> print(format(tremolo))
indicatortools.Tremolo(
    beam_count=2,
    )

Example 2. With three beams:

>>> tremolo = indicatortools.Tremolo(beam_count=3)
>>> print(format(tremolo))
indicatortools.Tremolo(
    beam_count=3,
    )

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

Tremolo.__str__()

Gets string representation of tremolo.

Example 1. With two beams:

>>> tremolo = indicatortools.Tremolo(beam_count=2)
>>> str(tremolo)
'Tremolo(beam_count=2)'

Example 2. With three beams:

>>> tremolo = indicatortools.Tremolo(beam_count=3)
>>> str(tremolo)
'Tremolo(beam_count=3)'

Returns string.