ScaleStream : Object

Description

This class is missing documentation.

Class Methods

Inherited class methods

Undocumented class methods

ScaleStream.new(scale, startDegree: 0)

Instance Methods

Inherited instance methods

Undocumented instance methods

.chooseScale(scaleDegree)

.curDegree

.curDegree = value

.performDegreeToKey(degree, stepsPerOctave, accidental: 0)

.performKeyToDegree(degree, stepsPerOctave: 12)

.performNearestInList(degree)

.performNearestInScale(degree, stepsPerOctave: 12)

.scale

.scale = value

Help template

Copy and paste the text below and save to HelpSource/Classes/ScaleStream.schelpTITLE:: ScaleStream summary:: (put short description here) categories:: Undocumented classes related:: Classes/SomeRelatedClass, Reference/SomeRelatedStuff, etc. DESCRIPTION:: (put long description here) CLASSMETHODS:: METHOD:: new (describe method here) ARGUMENT:: scale (describe argument here) ARGUMENT:: startDegree (describe argument here) returns:: (describe returnvalue here) INSTANCEMETHODS:: METHOD:: curDegree (describe method here) returns:: (describe returnvalue here) METHOD:: performDegreeToKey (describe method here) ARGUMENT:: degree (describe argument here) ARGUMENT:: stepsPerOctave (describe argument here) ARGUMENT:: accidental (describe argument here) returns:: (describe returnvalue here) METHOD:: chooseScale (describe method here) ARGUMENT:: scaleDegree (describe argument here) returns:: (describe returnvalue here) METHOD:: performNearestInList (describe method here) ARGUMENT:: degree (describe argument here) returns:: (describe returnvalue here) METHOD:: scale (describe method here) returns:: (describe returnvalue here) METHOD:: performNearestInScale (describe method here) ARGUMENT:: degree (describe argument here) ARGUMENT:: stepsPerOctave (describe argument here) returns:: (describe returnvalue here) METHOD:: performKeyToDegree (describe method here) ARGUMENT:: degree (describe argument here) ARGUMENT:: stepsPerOctave (describe argument here) returns:: (describe returnvalue here) EXAMPLES:: code:: (some example code) ::

TITLE:: ScaleStream

summary:: (put short description here)

categories:: Undocumented classes

related:: Classes/SomeRelatedClass, Reference/SomeRelatedStuff, etc.

​

DESCRIPTION::

(put long description here)

​

​

CLASSMETHODS::

​

METHOD:: new

(describe method here)

​

ARGUMENT:: scale

(describe argument here)

​

ARGUMENT:: startDegree

(describe argument here)

​

returns:: (describe returnvalue here)

​

​

INSTANCEMETHODS::

​

METHOD:: curDegree

(describe method here)

​

returns:: (describe returnvalue here)

​

METHOD:: performDegreeToKey

(describe method here)

​

ARGUMENT:: degree

(describe argument here)

​

ARGUMENT:: stepsPerOctave

(describe argument here)

​

ARGUMENT:: accidental

(describe argument here)

​

returns:: (describe returnvalue here)

​

METHOD:: chooseScale

(describe method here)

​

ARGUMENT:: scaleDegree

(describe argument here)

​

returns:: (describe returnvalue here)

​

METHOD:: performNearestInList

(describe method here)

​

ARGUMENT:: degree

(describe argument here)

​

returns:: (describe returnvalue here)

​

METHOD:: scale

(describe method here)

​

returns:: (describe returnvalue here)

​

METHOD:: performNearestInScale

(describe method here)

​

ARGUMENT:: degree

(describe argument here)

​

ARGUMENT:: stepsPerOctave

(describe argument here)

​

returns:: (describe returnvalue here)

​

METHOD:: performKeyToDegree

(describe method here)

​

ARGUMENT:: degree

(describe argument here)

​

ARGUMENT:: stepsPerOctave

(describe argument here)

​

returns:: (describe returnvalue here)

​

​

EXAMPLES::

​

code::

(some example code)

::

​