uk.co.dolphin_com.sscore

Class SSystem

java.lang.Object

uk.co.dolphin_com.sscore.SSystem

public class SSystem
extends java.lang.Object

A System is a range of bars able to draw itself in a Canvas, and is a product of calling SScore.layout()

draw() and drawWithOptions() draw the system into a canvas, the latter allowing item colouring (and requiring an additional licence)

getPartIndexForYPos(), getBarIndexForXPos() can be used to locate the bar and part under the cursor/finger

hitTest() is used to find the exact layout components (eg notehead, stem, beam) at a particular location (requiring a contents licence)

getComponentsForItem() is used to find all the layout components of a particular score item (requiring a contents licence)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSystem.BarRange define a range of bars which the system includes

Method Summary

Modifier and Type	Method and Description
Size	bounds() Get the bounding box of this system.
boolean	containsBar(int barIndex)
void	draw(android.graphics.Canvas canvas, android.content.res.AssetManager am, Point tl, float magnification) Draw this system at the given point.
void	drawWithOptions(android.graphics.Canvas canvas, android.content.res.AssetManager am, Point tl, float magnification, RenderItem[] renderItems) Draw the system allowing optional colouring of particular items/components in the layout
int	getBarIndexForXPos(float xpos) get the bar index of the bar enclosing the given x coordinate in this system
BarLayout	getBarLayout(int partIndex) get barline measurements for the part in this system
SSystem.BarRange	getBarRange() Get the start bar index and number of bars for this system.
android.graphics.RectF	getBoundsForItem(int item_h) Get a bounding box which encloses all layout components for a score item in this system
Component[]	getComponentsForItem(int item_h) Get an array of layout components which belong to a particular score item in this system
CursorRect	getCursorRect(android.graphics.Canvas canvas, int barIndex) Get the cursor rectangle for a particular system and bar
float	getDefaultSpacing() get the default vertical spacing to the next system
int	getPartIndexForYPos(float ypos) get the part index of the part enclosing the given y coordinate in this system
StaffLayout	getStaffLayout(int partIndex) get staff measurement for the part in this system
Component[]	hitTest(Point p) Get an array of components which intersect a given a point in this system
int	index() Get the index of this system from the top of the score.

Methods inherited from class java.lang.Object

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

Method Detail

index

public int index()

Get the index of this system from the top of the score.

Index 0 is the topmost.

Returns:

the index of this system

getBarRange

public SSystem.BarRange getBarRange()

Get the start bar index and number of bars for this system.

Returns:

the start bar and number of bars

containsBar

public boolean containsBar(int barIndex)

bounds

public Size bounds()

Get the bounding box of this system.

Returns:

the bounds

draw

public void draw(android.graphics.Canvas canvas,
                 android.content.res.AssetManager am,
                 Point tl,
                 float magnification)

Draw this system at the given point.

Parameters:

canvas - the Canvas

am - the AssetManager for loading fonts from assets

tl - the top left point to draw this system in the Canvas

magnification - the scale to draw at. NB This is normally 1, except during active zooming. The overall magnification is set in sscore_layout

drawWithOptions

public void drawWithOptions(android.graphics.Canvas canvas,
                            android.content.res.AssetManager am,
                            Point tl,
                            float magnification,
                            RenderItem[] renderItems)
                     throws ScoreException

Draw the system allowing optional colouring of particular items/components in the layout

Parameters:

canvas - the Canvas

am - the AssetManager for loading fonts from assets

tl - the top left point to draw this system in th Canvas

magnification - the scale to draw at. NB This is normally 1, except during active zooming. The overall magnification is set in sscore_layout

renderItems - each RenderItem object in the array defines special colouring of a particular score item

Throws:

ScoreException

getCursorRect

public CursorRect getCursorRect(android.graphics.Canvas canvas,
                                int barIndex)

Get the cursor rectangle for a particular system and bar

Parameters:

canvas - a canvas for measurement

barIndex - the index of the bar in the system

Returns:

the cursor info

getPartIndexForYPos

public int getPartIndexForYPos(float ypos)

get the part index of the part enclosing the given y coordinate in this system

Parameters:

ypos - the y coord

Returns:

the part index

getBarIndexForXPos

public int getBarIndexForXPos(float xpos)

get the bar index of the bar enclosing the given x coordinate in this system

Parameters:

xpos - the x coord

Returns:

the bar index

getDefaultSpacing

public float getDefaultSpacing()

get the default vertical spacing to the next system

Returns:

the default spacing

getStaffLayout

public StaffLayout getStaffLayout(int partIndex)

get staff measurement for the part in this system

Parameters:

partIndex - the 0-based part index

Returns:

staff measurements

getBarLayout

public BarLayout getBarLayout(int partIndex)

get barline measurements for the part in this system

Parameters:

partIndex - the 0-based part index

Returns:

barline dimensions

hitTest

public Component[] hitTest(Point p)
                    throws ScoreException

Get an array of components which intersect a given a point in this system

contents licence is required

Parameters:

p - the point

Returns:

array of intersecting Component

Throws:

ScoreException

getComponentsForItem

public Component[] getComponentsForItem(int item_h)
                                 throws ScoreException

Get an array of layout components which belong to a particular score item in this system

contents licence is required

Parameters:

item_h - the unique identifier for an item (eg note) in the score

Returns:

array of Component

Throws:

ScoreException

getBoundsForItem

public android.graphics.RectF getBoundsForItem(int item_h)
                                        throws ScoreException

Get a bounding box which encloses all layout components for a score item in this system

contents licence is required

Parameters:

item_h -

Returns:

the bounds of (all components of) the item

Throws:

ScoreException