net.raphimc.noteblocklib.format.nbs.model

Class NbsNote

java.lang.Object

net.raphimc.noteblocklib.model.Note

net.raphimc.noteblocklib.format.nbs.model.NbsNote

All Implemented Interfaces:

java.lang.Cloneable, NoteWithPanning, NoteWithVolume

public class NbsNote
extends Note
implements NoteWithVolume, NoteWithPanning

Field Summary

Fields inherited from class net.raphimc.noteblocklib.model.Note

instrument, key

Constructor Summary

Constructors

Constructor and Description
NbsNote(byte instrument, byte key)
NbsNote(NbsHeader header, NbsLayer layer, com.google.common.io.LittleEndianDataInputStream dis)
NbsNote(NbsLayer layer, byte instrument, byte key)
NbsNote(NbsLayer layer, byte instrument, byte key, byte velocity, short panning, short pitch)

Method Summary

Modifier and Type	Method and Description
NbsNote	clone()
boolean	equals(java.lang.Object o)
NbsLayer	getLayer()
float	getPanning()
short	getPitch() 100 = 1 key 1200 = 1 octave
short	getRawPanning()
byte	getRawVelocity()
float	getVolume()
int	hashCode()
void	setLayer(NbsLayer layer)
void	setPanning(float panning)
void	setPitch(short pitch)
void	setVolume(float volume)
void	write(NbsHeader header, com.google.common.io.LittleEndianDataOutputStream dos)

Methods inherited from class net.raphimc.noteblocklib.model.Note

getInstrument, getKey, getRawInstrument, getRawKey, setInstrument, setKey

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NbsNote

public NbsNote(NbsHeader header,
               NbsLayer layer,
               com.google.common.io.LittleEndianDataInputStream dis)
        throws java.io.IOException

Throws:

java.io.IOException

NbsNote

public NbsNote(NbsLayer layer,
               byte instrument,
               byte key,
               byte velocity,
               short panning,
               short pitch)

NbsNote

public NbsNote(NbsLayer layer,
               byte instrument,
               byte key)

NbsNote

public NbsNote(byte instrument,
               byte key)

Method Detail

write

public void write(NbsHeader header,
                  com.google.common.io.LittleEndianDataOutputStream dos)
           throws java.io.IOException

Throws:

java.io.IOException

getLayer

public NbsLayer getLayer()

Returns:

The NBS layer this note is in.

Since:

v0

setLayer

public void setLayer(NbsLayer layer)

Parameters:

layer - The NBS layer this note is in.

Since:

v0

getVolume

public float getVolume()

Specified by:

getVolume in interface NoteWithVolume

Returns:

The velocity/volume of the note, from 0% to 100%. Factors in the layer's volume.

Since:

v4

setVolume

public void setVolume(float volume)

Specified by:

setVolume in interface NoteWithVolume

Parameters:

volume - The velocity/volume of the note, from 0% to 100%. Does not change the layer's volume.

Since:

v4

getRawVelocity

public byte getRawVelocity()

getPanning

public float getPanning()

Specified by:

getPanning in interface NoteWithPanning

Returns:

The stereo position of the note block. (-100 is 2 blocks right, 0 is center, 100 is 2 blocks left). Factors in the layer's panning.

Since:

v4

setPanning

public void setPanning(float panning)

Specified by:

setPanning in interface NoteWithPanning

Parameters:

panning - The stereo position of the note block. (-100 is 2 blocks right, 0 is center, 100 is 2 blocks left). Does not change the layer's panning.

Since:

v4

getRawPanning

public short getRawPanning()

getPitch

public short getPitch()

100 = 1 key 1200 = 1 octave

Returns:

The fine pitch of the note block, from -32,768 to 32,767 cents (but the max in Note Block Studio is limited to -1200 and +1200). 0 is no fine-tuning. ±100 cents is a single semitone difference.

Since:

v4

setPitch

public void setPitch(short pitch)

Parameters:

pitch - The fine pitch of the note block, from -32,768 to 32,767 cents (but the max in Note Block Studio is limited to -1200 and +1200). 0 is no fine-tuning. ±100 cents is a single semitone difference.

Since:

v4

clone

public NbsNote clone()

Specified by:

clone in class Note

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Note

hashCode

public int hashCode()

Overrides:

hashCode in class Note