OpenStrat
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
OpenStrat/ostrat.pgui

ostrat.pgui

package ostrat.pgui

The package attempts to encapsulate the various abstract canvas traits while the actual objects that populate a canvas go in package geom.

Attributes

Members list

Concise view

Type members

Classlikes

abstract class CanvasNoPanels(title: String) extends CanvasUser with PanelLike

A canvas that is not divided up into panels. A panel is a portion of the canvas that has its own origin and is clipped.

A canvas that is not divided up into panels. A panel is a portion of the canvas that has its own origin and is clipped.

Attributes

Graph
Supertypes
trait PanelLike
class Object
trait Matchable
class Any
Known subtypes
class CArcExs
class LsA1
class LsA10
class LsA11
class LsA12
class LsA13
class LsA1a
class LsA1b
class LsA2
class LsA3
class LsA3a
class LsA4
class LsA5
class LsA6
class LsA7
class LsA8
class LsA9
class LsB1
class LsB2
class LsB3
class LsC1
class LsC2
class LsC3
class LsC4
class LsC5
class LsC6
class LsC7
class LsC8
class LsD1
class LsD2
class LsD3
class LsD4
class LsD5
class BattleGui
class FlagsGui
class ColourGen
class TessGui
abstract class CanvasPanelled(title: String) extends CanvasUser

A canvas divided up into panels. Each panel is clipped and has its own origin.

A canvas divided up into panels. Each panel is clipped and has its own origin.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CmdBarGui
class LsE1
class LsE2
class GlobeGui
class ChessGui
class DLessGui
class G1HGui
class GThreeGui
class G2HGui
class BC305Gui
class CivGui
class NapGui
class WW1Gui
class WW2Gui
class ZugGui
class SqSysGui
class G1SGui
class GoGui
class MapGui
trait CanvasPlatform extends RectCenlign

An abstract Canvas interface implemented and to be implemented on various platforms. A concrete implementation will utilise canvas like an HTML canvas or a Scalafx canvas. This concrete implementation class must (can?) be mixed in with a a particular use trait like CanvSimple or CanvMulti. The default methods take the origin as the centre of the canvas. Note the Canvas Platform merely passes bare pointer event data to delegate functions. It does not process them in relation to objects painted on the Canvas.

An abstract Canvas interface implemented and to be implemented on various platforms. A concrete implementation will utilise canvas like an HTML canvas or a Scalafx canvas. This concrete implementation class must (can?) be mixed in with a a particular use trait like CanvSimple or CanvMulti. The default methods take the origin as the centre of the canvas. Note the Canvas Platform merely passes bare pointer event data to delegate functions. It does not process them in relation to objects painted on the Canvas.

It is really not a good idea to use this trait, use a sub class of this trait directly in your applications. You do not want to be thinking in terms of the imperative methods of this application. Use one of the provided classes like CanvasNoPanels or Canvas Panelled or create your own if the provided classes don't fulfill your needs.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CanvasFx
trait CanvasTopLeft extends CanvasPlatform

This trait is for Canvas Implementations with a Top left origin and downward y axis. It should not be used directly by graphical applications.

This trait is for Canvas Implementations with a Top left origin and downward y axis. It should not be used directly by graphical applications.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CanvasFx
trait CanvasTopLeftStubs extends CanvasTopLeft

This trait provides stub methods to allow development on a Canvas with incomplete functionality. Override the methods as desired but remove this trait form the inheritance hierarchy once full functionality has been implemented

This trait provides stub methods to allow development on a Canvas with incomplete functionality. Override the methods as desired but remove this trait form the inheritance hierarchy once full functionality has been implemented

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
abstract class CanvasUser(val title: String)

So the descendant classes need to set the canv.mouseup field to use the mouse and its equivalents.

So the descendant classes need to set the canv.mouseup field to use the mouse and its equivalents.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CArcExs
class LsA1
class LsA10
class LsA11
class LsA12
class LsA13
class LsA1a
class LsA1b
class LsA2
class LsA3
class LsA3a
class LsA4
class LsA5
class LsA6
class LsA7
class LsA8
class LsA9
class LsB1
class LsB2
class LsB3
class LsC1
class LsC2
class LsC3
class LsC4
class LsC5
class LsC6
class LsC7
class LsC8
class LsD1
class LsD2
class LsD3
class LsD4
class LsD5
class BattleGui
class FlagsGui
class ColourGen
class TessGui
class CmdBarGui
class LsE1
class LsE2
class GlobeGui
class ChessGui
class DLessGui
class G1HGui
class GThreeGui
class G2HGui
class BC305Gui
class CivGui
class NapGui
class WW1Gui
class WW2Gui
class ZugGui
class SqSysGui
class G1SGui
class GoGui
class MapGui
abstract class CmdBarGui(title: String) extends CanvasPanelled

A simple 2 panel display, a man panel and a command bar.

A simple 2 panel display, a man panel and a command bar.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class LsE1
class LsE2
class GlobeGui
class ChessGui
class DLessGui
class G1HGui
class GThreeGui
class G2HGui
class BC305Gui
class CivGui
class NapGui
class WW1Gui
class WW2Gui
class ZugGui
class SqSysGui
class G1SGui
class GoGui
case class DispAnim(fAnim: Double => Unit, secs: Double) extends DispPhase

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait DispPhase
class Object
trait Matchable
class Any
trait DispObj

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
sealed trait DispPhase

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DispAnim
class DispStill
case class DispStill(fDisp: () => Unit) extends DispPhase

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait DispPhase
class Object
trait Matchable
class Any
trait GuiLaunch

A convenience trait for launching Apps.

A convenience trait for launching Apps.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Lessons.type
object DLessLaunch.type
object EGridLaunch.type
object G1HLaunch.type
object G1SLaunch.type
object ThreeLaunch.type
object G2HLaunch.type
object BcLaunch.type
object DungLaunch.type
object EarthBasicLaunch.type
object ChessLaunch.type
object NapLaunch.type
object WW1Launch.type
object WW2Launch.type
object GoLaunch.type
object CivLaunch.type
object ZugLaunch.type
trait GuiLaunchMore extends GuiLaunch

A GuiLaunch that actually uses the setting to construct the launch."

A GuiLaunch that actually uses the setting to construct the launch."

Attributes

Graph
Supertypes
trait GuiLaunch
class Object
trait Matchable
class Any
Known subtypes
object DLessLaunch.type
object EGridLaunch.type
object G1HLaunch.type
object G1SLaunch.type
object ThreeLaunch.type
object G2HLaunch.type
object BcLaunch.type
object DungLaunch.type
object EarthBasicLaunch.type
object ChessLaunch.type
object NapLaunch.type
object WW1Launch.type
object WW2Launch.type
case class GuiLaunchSimple(settingStr: String, default: (CanvasPlatform => Any, String)) extends GuiLaunch

The simplest launcher, not usre that this class really serves any purpose.

The simplest launcher, not usre that this class really serves any purpose.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait GuiLaunch
class Object
trait Matchable
class Any
Known subtypes
object GoLaunch.type
trait GuiLaunchStd extends GuiLaunch

A convenience trait for launching Apps that takes an Int and an Identifier as its settings.

A convenience trait for launching Apps that takes an Int and an Identifier as its settings.

Attributes

Graph
Supertypes
trait GuiLaunch
class Object
trait Matchable
class Any
Known subtypes
object CivLaunch.type
object ZugLaunch.type
abstract class MapGui(title: String) extends CanvasPanelled

A MapGui uses a CanvMulti. It has a main map panel and a top control panel. In addition translates between 2d game coordinates and 2d coordinates on the canvas. Allowing the canvas to display a moving, scalable 2d view though the Game map. The x coordinate increases from left to right, the y coordinate increases from bottom to top.

A MapGui uses a CanvMulti. It has a main map panel and a top control panel. In addition translates between 2d game coordinates and 2d coordinates on the canvas. Allowing the canvas to display a moving, scalable 2d view though the Game map. The x coordinate increases from left to right, the y coordinate increases from bottom to top.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object MenuBranch

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class MenuBranch(text: String, val nodes: Seq[MenuNode]) extends MenuSub

Attributes

Companion:
object
Graph
Supertypes
class MenuSub
class MenuNode
class Object
trait Matchable
class Any
object MenuBranchDynamic

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class MenuBranchDynamic(text: String, val getSubMenu: () => Seq[MenuNode]) extends MenuSub

Attributes

Companion:
object
Graph
Supertypes
class MenuSub
class MenuNode
class Object
trait Matchable
class Any
abstract class MenuContextGraphic(seq: MenuSeq, x: Double, y: Double)

Not sure aboout this class

Not sure aboout this class

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
object MenuLeaf

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class MenuLeaf(text: String, val action: () => Unit) extends MenuNode

Attributes

Companion:
object
Graph
Supertypes
class MenuNode
class Object
trait Matchable
class Any
object MenuNode

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class MenuNode(val text: String)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MenuLeaf
class MenuSub
object MenuSeq

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
MenuSeq.type
object MenuSub

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
MenuSub.type
sealed abstract class MenuSub(text: String) extends MenuNode

Attributes

Companion:
object
Graph
Supertypes
class MenuNode
class Object
trait Matchable
class Any
Known subtypes
case class MouseButtonCmd(cmd: MouseButton => Unit)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Panel(outerCanv: CanvasPanelled, clipPoly: Polygon, cover: Boolean) extends PanelLike

A virtual panel created from the Canvas implemented using the clip function.

A virtual panel created from the Canvas implemented using the clip function.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait PanelLike
class Object
trait Matchable
class Any
trait PanelLike extends RectCenlign

The purpose of this trait is to give common methods for Panels and Simple Canvases. A SimpleCanvas is like a Panel but not a Panel.

The purpose of this trait is to give common methods for Panels and Simple Canvases. A SimpleCanvas is like a Panel but not a Panel.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CArcExs
class LsA1
class LsA10
class LsA11
class LsA12
class LsA13
class LsA1a
class LsA1b
class LsA2
class LsA3
class LsA3a
class LsA4
class LsA5
class LsA6
class LsA7
class LsA8
class LsA9
class LsB1
class LsB2
class LsB3
class LsC1
class LsC2
class LsC3
class LsC4
class LsC5
class LsC6
class LsC7
class LsC8
class LsD1
class LsD2
class LsD3
class LsD4
class LsD5
class BattleGui
class FlagsGui
class ColourGen
class TessGui
class Panel
object StdButton

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object Turn extends ShowSimple

Attributes

Graph
Supertypes
trait ShowNoDec
trait Show
trait TypeStr
class Object
trait Matchable
class Any
Self type
Turn.type
abstract class UnfixedMapGui(title: String) extends MapGui

So currently this is a turn based class allowing the selection of objects within the map. That is not the case for the Planet App where the planets move too quickly for selection. The focus centre is un fixed unlike the planet App.

So currently this is a turn based class allowing the selection of objects within the map. That is not the case for the Planet App where the planets move too quickly for selection. The focus centre is un fixed unlike the planet App.

Attributes

Graph
Supertypes
class MapGui
class Object
trait Matchable
class Any
Known subtypes

Types

Value members

Concrete methods

def clickButton(str: String, backColour: Colour)(cmd: MouseCmd): PolygonCompound

A button to react to different mouse buttons. The length varies with the String.

A button to react to different mouse buttons. The length varies with the String.

Attributes

def simpleButton(str: String, backColour: Colour)(cmd: => Unit): PolygonCompound

A button to react to different mouse buttons. The length varies with the String.

A button to react to different mouse buttons. The length varies with the String.

Attributes

Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL