inheritance tree
Score.note PitchClassMixin
| |
`--------+----'
|
Note2 InChordMixinForNote InScaleMixinForNote
| | |
`------------------+---'-------------------'
|
Note
class definition
[concrete class] Note is an extension of the class Score.note defined by the Strasheela core. Whereas Score.note is style-neutral, Note is designed for harmonic CSPs.
All extensions of Score.note are defined by the three mixins PitchClassMixin, InChordMixinForNote and InScaleMixinForNote: see the documentation of these classes for further details.
class Note (Inheritance-free)
feat !InChordMixinForNoteType !InScaleMixinForNoteType !PitchClassMixinType
attr chords getChords getScales inChordB inScaleB isRelatedChord isRelatedScale octave pitchClass relatedChordBs relatedScaleBs scales
- getChords(X)
Returns the list of candidate chord objects, i.e. the value returned by the proc set via the getChords init argument.
- getInChordB(X)
- getInChordBParameter(X)
- getInScaleB(X)
- getInScaleBParameter(X)
- getInitInfo($ ...)
NB: the procedures given as init arguments to InChordMixinForNote and InScaleMixinForNote are lost when the score is transformed to a literal/textual representation (and thus their implicit constraints).
- getOctave(X)
- getOctaveParameter(X)
- getPitchClass(X)
- getPitchClassParameter(X)
- getRelatedChordBs(X)
Returns a list of 0/1-integers returned by {Map {} }. and are the functions given to initInChordMixinForNote.
- getRelatedScaleBs(X)
Returns a list of 0/1-integers returned by {Map {} }. and are the functions given to initInScaleMixinForNote.
- getScales(X)
Returns the list of candidate scale objects, i.e. the value returned by the proc set via the getScale init argument.
- init(...)
optional Arguments:
arguments of Score.note: duration (FD int), endTime (FD int), offsetTime (FD int), startTime (FD int), pitch (FD int), amplitude (FD int) amplitudeUnit (atom), ...
Please note that pitchUnit is not supported (it is set implicitly by the pitches per octave setting).
Note supports the following additional arguments:
octave (FD int), pitchClass (FD int),
inChordB (0/1 int), getChords (proc {$ Self Chords} ... end), isRelatedChord (proc {$ Self Chord B} ... end), inScaleB (0/1 int), getScales (proc {$ Self Scales} ... end), isRelatedScale (proc {$ Self Chord B} ... end)
- initInChordMixinForNote(...)
- initInScaleMixinForNote(...)
- initPitchClassMixin(octave:Oct pitchClass:PC)
- isInChord(B)
Returns an 0/1-int which states whether or not the pitch class of self is included in the pitch classes of its related chord. This definition is an alias for getInChordB.
- isInScale(B)
see doc isInChord
- nonChordPCConditions(Conditions)
Defines and applies a 'meta-rule' which conveniently defines a number of conditions which effect self dependent on the value of {self isInChord($)}. Conditions is a list of binary procs expecting self and an 0/1-int (declared within the proc). These conditions form alternative constraints on self. A typical condition example would be a boolean constraint whether self is a passing note, another whether self is a suspension.
If none of the given conditions is true, then self must be 'in' the chord (i.e. 1={self isInChord($)}). Similarily, if self is not in the chord, at least one of the conditions must be true. However, the opposite is not necessarily true: if one or more conditions are the case then self may or may not be in the chord and also if self is in the chord then one or more conditions still may or may not be true.
For instance, this meta-rule never constraints a note to necessarily be a non-chord note. You may however easily do this, e.g, by constraining {self isInChord($)}=0 directly -- which would have the consequence that one of Conditions must be true.
- nonScalePCConditions(Conditions)
see doc nonChordPCConditions
- noteInterval($ MyNote dbFeatures:DBFeats)
Expects a note object MyNote and returns the interval between self and MyNote. If the self is higher than MyNote, then the intervals direction is downwards (i.e. 0). Additional interval features can be specified with the optional argument dbFeatures (default nil).
end
