org.barrelorgandiscovery.scale

Class Scale

java.lang.Object

org.barrelorgandiscovery.scale.Scale

All Implemented Interfaces:

java.io.Serializable

public class Scale
extends java.lang.Object
implements java.io.Serializable

Implement a scale definition for an instrument / virtual book

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GAMME_STATE_COMPLETED scale state "completed"
static java.lang.String	GAMME_STATE_INPROGRESS scale state "In Progress"

Constructor Summary

Constructors

Constructor and Description

Scale(java.lang.String name, double width, double intertrackdistance, double trackwidth, double firsttrackaxisdistance, int tracknumber, AbstractTrackDef[] tracksdefinition, PipeStopGroupList registersets, double speed, ConstraintList constraintlist, java.lang.String infos, java.lang.String state, java.lang.String contact, VirtualBookRendering rendering, boolean preferredViewedInverted, boolean bookMovingRightToLeft, java.util.Map<java.lang.String,java.lang.String> properties) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	findNoteDefTrack(int midinote) look for a track associated to a midi note
int	findNoteDefTrack(int midinote, java.lang.String registersetname) get the first track associated with a mininote, for a register
int[]	findNoteDefTrack(java.lang.String registersetname) find all tracks associated to a specific registerset name
int	findPercussionDef(int percussion) get the track index for a given percussion
PercussionDef[]	findUniquePercussionDefs() Get all the percussion defs, this function remove the PercussionDef duplicated
java.util.Map<java.lang.String,java.lang.String>	getAllProperties() get All the properties
ConstraintList	getConstraints() Get a constraint list copy
java.lang.String	getContact() get the scale contact
double	getFirstTrackAxis() get the first track axis distance from the reference
static Scale	getGammeMidiInstance() utility function that create from scratch a dummy scale of the midi definition
java.lang.String	getInformations() get the informations
double	getIntertrackHeight() get the distance between each track (in mm)
java.lang.String	getName() get the scale name
PipeStopGroupList	getPipeStopGroupList() get a registerset liste copy
PipeStopGroupList	getPipeStopGroupListRef()
java.lang.String	getProperty(java.lang.String key) get the free property associated to this scale
VirtualBookRendering	getRendering() get the rendering associated to this scale
double	getSpeed() get the speed of the organ
java.lang.String	getState() get the scale state
int	getTrackNb() get track number
AbstractTrackDef[]	getTracksDefinition() get the definition of the tracks
double	getTrackWidth() get width of a track (in mm)
double	getWidth() get the width of the scale (the virtual book)
boolean	isBookMovingRightToLeft() get the book orientation
boolean	isPreferredViewedInversed() Get a flag indicating that the user prefer view the scale inverted
long	mmToTime(double mm) mm to Time
void	setBookMovingRightToLeft(boolean bookMovingRightToLeft) define the orientation of the book
double	timeToMM(long time) time to mm
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GAMME_STATE_INPROGRESS

public static final java.lang.String GAMME_STATE_INPROGRESS

scale state "In Progress"

See Also:

Constant Field Values

GAMME_STATE_COMPLETED

public static final java.lang.String GAMME_STATE_COMPLETED

scale state "completed"

See Also:

Constant Field Values

Constructor Detail

Scale

public Scale(java.lang.String name,
             double width,
             double intertrackdistance,
             double trackwidth,
             double firsttrackaxisdistance,
             int tracknumber,
             AbstractTrackDef[] tracksdefinition,
             PipeStopGroupList registersets,
             double speed,
             ConstraintList constraintlist,
             java.lang.String infos,
             java.lang.String state,
             java.lang.String contact,
             VirtualBookRendering rendering,
             boolean preferredViewedInverted,
             boolean bookMovingRightToLeft,
             java.util.Map<java.lang.String,java.lang.String> properties)
      throws ScaleException

Constructor

Parameters:

name - name of the scale

width - the width

intertrackdistance - intertrack distance in mm

trackwidth - with of a track in mm

firsttrackaxisdistance - first track axis distance in mm

tracknumber - track number

tracksdefinition - tracks definition

registersets - registerset definitions

speed - speed

constraintlist - constraint list

infos - scale information (free text)

state - status of this scale

contact - contact for the scale

rendering - display renderer

preferredViewedInverted - is the reference on top

bookMovingRightToLeft - the book is moving on the instrument

properties - additional properties

Throws:

ScaleException

Method Detail

getIntertrackHeight

public double getIntertrackHeight()

get the distance between each track (in mm)

Returns:

the distance

getTrackWidth

public double getTrackWidth()

get width of a track (in mm)

Returns:

the width of tracks

getTrackNb

public int getTrackNb()

get track number

Returns:

the track number

getTracksDefinition

public AbstractTrackDef[] getTracksDefinition()

get the definition of the tracks

Returns:

an array containing the definition of the track (note, drum, register ...)

getFirstTrackAxis

public double getFirstTrackAxis()

get the first track axis distance from the reference

Returns:

getWidth

public double getWidth()

get the width of the scale (the virtual book)

Returns:

the width in mm

getName

public java.lang.String getName()

get the scale name

Returns:

the name

getSpeed

public double getSpeed()

get the speed of the organ

Returns:

speed in mm/s

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getGammeMidiInstance

public static Scale getGammeMidiInstance()

utility function that create from scratch a dummy scale of the midi definition

Returns:

the midi scale

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findNoteDefTrack

public int findNoteDefTrack(int midinote)

look for a track associated to a midi note

Parameters:

midinote - the midi note

Returns:

track index of this note, -1 returned else if not found

findUniquePercussionDefs

public PercussionDef[] findUniquePercussionDefs()

Get all the percussion defs, this function remove the PercussionDef duplicated

Returns:

an array of percussiondef in the scale

findNoteDefTrack

public int findNoteDefTrack(int midinote,
                            java.lang.String registersetname)

get the first track associated with a mininote, for a register

Parameters:

midinote -

registersetname -

Returns:

the track index, or -1 if not found

findNoteDefTrack

public int[] findNoteDefTrack(java.lang.String registersetname)

find all tracks associated to a specific registerset name

Parameters:

registersetname - name of the registerset

Returns:

a track list of the founded notes associated to the registerset

findPercussionDef

public int findPercussionDef(int percussion)

get the track index for a given percussion

Parameters:

percussion - midi code

Returns:

the index, -1 if not found

mmToTime

public long mmToTime(double mm)

mm to Time

Parameters:

mm - the distance

Returns:

the time in microseconds

timeToMM

public double timeToMM(long time)

time to mm

Parameters:

time - the time in microseconds

Returns:

the distance in mm

getPipeStopGroupList

public PipeStopGroupList getPipeStopGroupList()

get a registerset liste copy

Returns:

the copy

getPipeStopGroupListRef

public PipeStopGroupList getPipeStopGroupListRef()

getConstraints

public ConstraintList getConstraints()

Get a constraint list copy

Returns:

the constraintlist

getInformations

public java.lang.String getInformations()

get the informations

Returns:

getState

public java.lang.String getState()

get the scale state

Returns:

getContact

public java.lang.String getContact()

get the scale contact

Returns:

getRendering

public VirtualBookRendering getRendering()

get the rendering associated to this scale

Returns:

isPreferredViewedInversed

public boolean isPreferredViewedInversed()

Get a flag indicating that the user prefer view the scale inverted

Returns:

isBookMovingRightToLeft

public boolean isBookMovingRightToLeft()

get the book orientation

Returns:

setBookMovingRightToLeft

public void setBookMovingRightToLeft(boolean bookMovingRightToLeft)

define the orientation of the book

Parameters:

bookMovingRightToLeft -

getProperty

public java.lang.String getProperty(java.lang.String key)

get the free property associated to this scale

Parameters:

key -

Returns:

getAllProperties

public java.util.Map<java.lang.String,java.lang.String> getAllProperties()

get All the properties

Returns: