PitchClass explanation of what PitchClass is and/or does

Inherits from: Object

More detailed prose description of PitchClass.

See also: Object [some other help files]

Some Important Issues Regarding PitchClass (optional)

Explanation of the issues. For more information see Nil and [some other help files].

Creation / Class Methods

*new (pitch, octave, alter)

Short prose description of method.

pitch - Explanation of pitch. Default value is nil. Other information.

octave - Explanation of octave. Default value is 4. Other information.

alter - Explanation of alter. Default value is 0. Other information.

// inline example

g = PitchClass.new;

g.doSomething; // explanation

g.cleanUpMethod;

*initClass

Short prose description of method.

// inline example

g = PitchClass.initClass;

g.doSomething; // explanation

g.cleanUpMethod;

Accessing Instance and Class Variables

notenames

Explanation including the type of notenames and a link to its help file.

Default value is defaultValue.

notenums

Explanation including the type of notenums and a link to its help file.

Default value is defaultValue.

noteToScale

Explanation including the type of noteToScale and a link to its help file.

Default value is defaultValue.

scaleToNote

Explanation including the type of scaleToNote and a link to its help file.

Default value is defaultValue.

accToSize

Explanation including the type of accToSize and a link to its help file.

Default value is defaultValue.

sizeToAcc

Explanation including the type of sizeToAcc and a link to its help file.

Default value is defaultValue.

accToGuido

Explanation including the type of accToGuido and a link to its help file.

Default value is defaultValue.

pitch

Explanation including the type of pitch and a link to its help file.

Default value is nil.

note

Explanation including the type of note and a link to its help file.

Default value is nil.

pitchclass

Explanation including the type of pitchclass and a link to its help file.

Default value is nil.

freq

Explanation including the type of freq and a link to its help file.

Default value is nil.

acc

Explanation including the type of acc and a link to its help file.

Default value is nil.

octave

Explanation including the type of octave and a link to its help file.

Default value is nil.

keynum

Explanation including the type of keynum and a link to its help file.

Default value is nil.

alter_(arg1)

alter

Explanation including the type of alter and a link to its help file.

Default value is nil.

Doing Some Task (optional)

A short bit of prose explaining something about the task.

init (argpitch, argoctave, argalter)

Short prose description of method.

argpitch - Explanation of argpitch. Default value is nil. Other information.

argoctave - Explanation of argoctave. Default value is nil. Other information.

argalter - Explanation of argalter. Default value is nil. Other information.

// inline example

g = PitchClass.init;

g.doSomething; // explanation

g.cleanUpMethod;

calcpitch (thispitch, thisoctave)

Short prose description of method.

thispitch - Explanation of thispitch. Default value is nil. Other information.

thisoctave - Explanation of thisoctave. Default value is nil. Other information.

// inline example

g = PitchClass.calcpitch;

g.doSomething; // explanation

g.cleanUpMethod;

pitch_ (newpitch, newoctave)

Short prose description of method.

newpitch - Explanation of newpitch. Default value is nil. Other information.

newoctave - Explanation of newoctave. Default value is nil. Other information.

// inline example

g = PitchClass.pitch_;

g.doSomething; // explanation

g.cleanUpMethod;

guidoString

Short prose description of method.

// inline example

g = PitchClass.guidoString;

g.doSomething; // explanation

g.cleanUpMethod;

invert (center)

Short prose description of method.

center - Explanation of center. Default value is nil. Other information.

// inline example

g = PitchClass.invert;

g.doSomething; // explanation

g.cleanUpMethod;

transpose (aPitchInterval, direction)

Short prose description of method.

aPitchInterval - Explanation of aPitchInterval. Default value is nil. Other information.

direction - Explanation of direction. Default value is 'up'. Other information.

// inline example

g = PitchClass.transpose;

g.doSomething; // explanation

g.cleanUpMethod;

Examples

// what this example does

e = PitchClass.new;

e.instanceMethod(someObject);

e.cleanUp;

...