groovy.aprint.transform
[Groovy] Class ScaleHelper

java.lang.Object
  groovy.aprint.transform.ScaleHelper

class ScaleHelper
extends java.lang.Object

Class helper for finding tracks in the scale / instrument

ACCOMPAGNEMENT

java.lang.String ACCOMPAGNEMENT

ACCOMPAGNMENT

java.lang.String ACCOMPAGNMENT

BASS

java.lang.String BASS

COUNTER_MELODY

java.lang.String COUNTER_MELODY

MELODY

java.lang.String MELODY

MELODY3

java.lang.String MELODY3

registerSets

java.lang.Object registerSets

scale

org.barrelorgandiscovery.scale.Scale scale

ScaleHelper

ScaleHelper(org.barrelorgandiscovery.instrument.Instrument ins, java.util.Map m = null)

ScaleHelper

ScaleHelper(org.barrelorgandiscovery.scale.Scale s, java.util.Map m = null)

ScaleHelper

ScaleHelper(java.util.Map m)

find

Track find(java.lang.String note)

find a track associated to a note (the note is given in parameter) the search is done wheter the note is associated to a specific RegisterSet (BASS, ACCOMPAGNMENT, MELODY ...) if the Track is not found, the method return null

Returns:

the found track or NULL

Parameters:

note - the note represented as String with octave eg : "D5"

getDrumTracks

Track[] getDrumTracks()

alias for getPercussionTracks, for english people

Returns:

getNoteTracks

Track[] getNoteTracks()

get all the tracks containing a note definition

getNotes

Note[] getNotes()

get Notes

getPercussionTracks

Track[] getPercussionTracks()

get all the tracks containing a percussion (drum) definition

getRegisterTracks

Track[] getRegisterTracks()

get all the tracks containing registers definitions

getScale

org.barrelorgandiscovery.scale.Scale getScale()

Get the underlying scale

Returns:

the scale

getTracks

Track[] getTracks()

get Tracks

notes

Note[] notes(java.lang.String registerSet)

get all the notes of a registerset

propertyMissing

java.lang.Object propertyMissing(java.lang.String name)

track

Track track(int t)

get a track object from its index

track

Track track(Note n)

get a track associated to a note, independently of the registerset

track

Track track(Note n, java.lang.String registerSet)

get a note track in a specific register set, if the registerset is null, the method returns the first note encountered

parameter:

n the note to find

parameter:

registerSet the registerset in which finding the track, if null it ignore the registerset

Returns:

null if the track hasn't been found

trackWithoutOctave

Track trackWithoutOctave(Note n)

Find a track with this not (independently of the octave)

Returns:

the track, or null if not found

Parameters:

n - the note

trackWithoutOctave

Track trackWithoutOctave(Note n, java.lang.String registerSet)

find a track in a register set independently of the octave

tracks

Track[] tracks(Note[] notes, java.lang.String registerSet)

get all the tracks associated to notes in a registerset nota : if the registerset is null, the search is done in all registersets

Returns:

the track list, containing nulls if track is not found

tracks

Track[] tracks(Note[] notes)

get all the tracks associated to notes in all registerset

tracksWithoutOctave

Track[] tracksWithoutOctave(Note[] notes, java.lang.String registerSet)

get all the tracks to notes without octave, when the note is not found, a null is returned in the array

parameter:

notes an array containing the notes to find

tracksWithoutOctave

Track[] tracksWithoutOctave(Note[] notes)

Get All tracks associated to given notes, without octave match

Returns:

Parameters:

notes

transformFor

TransformHelper transformFor(org.barrelorgandiscovery.scale.Scale s)

Create a transform helper to the scale given in parameter

transformFor

TransformHelper transformFor(ScaleHelper s)

Create a transform helper to the scale helper given in parameter

Groovy Documentation