codeworld-api-0.3: Graphics library for CodeWorld

Safe HaskellNone
LanguageHaskell98

CodeWorld

Contents

Synopsis

Entry points

drawingOf Source #

Arguments

:: Picture

The picture to show on the screen.

-> IO () 

Draws a Picture. This is the simplest CodeWorld entry point.

animationOf Source #

Arguments

:: (Double -> Picture)

A function that produces animation frames, given the time in seconds.

-> IO () 

Shows an animation, with a picture for each time given by the parameter.

activityOf Source #

Arguments

:: world

The initial state of the interaction.

-> (Event -> world -> world)

The event handling function, which updates the state given an event.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

Runs an interactive CodeWorld program that responds to events. Activities can interact with the user, change over time, and remember information about the past.

debugActivityOf Source #

Arguments

:: world

The initial state of the interaction.

-> (Event -> world -> world)

The event handling function, which updates the state given an event.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

Runs an interactive CodeWorld program in debugging mode. In this mode, the program gets controls to pause and manipulate time, and even go back in time to look at past states.

groupActivityOf Source #

Arguments

:: Int

The number of participants to expect. The participants will be ^ numbered starting at 0.

-> StaticPtr (StdGen -> world)

The initial state of the activity.

-> StaticPtr (Int -> Event -> world -> world)

The event handling function, which updates the state given a participant number and user interface event.

-> StaticPtr (Int -> world -> Picture)

The visualization function, which converts a participant number and the state into a picture to display.

-> IO () 

Runs an interactive multi-user CodeWorld program that is joined by several participants over the internet.

unsafeGroupActivityOf Source #

Arguments

:: Int

The number of participants to expect. The participants will be ^ numbered starting at 0.

-> (StdGen -> world)

The initial state of the activity.

-> (Int -> Event -> world -> world)

The event handling function, which updates the state given a participant number and user interface event.

-> (Int -> world -> Picture)

The visualization function, which converts a participant number and the state into a picture to display.

-> IO () 

A version of groupActivityOf that avoids static pointers, and does not check for consistency.

simulationOf Source #

Arguments

:: world

The initial state of the simulation.

-> (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

Shows a simulation, which is essentially a continuous-time dynamical system described by an initial value and step function.

debugSimulationOf Source #

Arguments

:: world

The initial state of the simulation.

-> (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

interactionOf Source #

Arguments

:: world

The initial state of the interaction.

-> (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> (Event -> world -> world)

The event handling function, which updates the state given a user interface event.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

Runs an interactive event-driven CodeWorld program. This is a generalization of simulations that can respond to events like key presses and mouse movement.

debugInteractionOf Source #

Arguments

:: world

The initial state of the interaction.

-> (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> (Event -> world -> world)

The event handling function, which updates the state given a user interface event.

-> (world -> Picture)

The visualization function, which converts the state into a picture to display.

-> IO () 

collaborationOf Source #

Arguments

:: Int

The number of participants to expect. The participants will be ^ numbered starting at 0.

-> StaticPtr (StdGen -> world)

The initial state of the collaboration.

-> StaticPtr (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> StaticPtr (Int -> Event -> world -> world)

The event handling function, which updates the state given a participant number and user interface event.

-> StaticPtr (Int -> world -> Picture)

The visualization function, which converts a participant number and the state into a picture to display.

-> IO () 

Runs an interactive multi-user CodeWorld program, involving multiple participants over the internet.

unsafeCollaborationOf Source #

Arguments

:: Int

The number of participants to expect. The participants will be ^ numbered starting at 0.

-> (StdGen -> world)

The initial state of the collaboration.

-> (Double -> world -> world)

The time step function, which advances the state given the time difference.

-> (Int -> Event -> world -> world)

The event handling function, which updates the state given a participant number and user interface event.

-> (Int -> world -> Picture)

The visualization function, which converts a participant number and the state into a picture to display.

-> IO () 

A version of collaborationOf that avoids static pointers, and does not check for consistent parameters.

Pictures

data Picture Source #

Instances
Semigroup Picture Source # 
Instance details

Defined in CodeWorld.Picture

Monoid Picture Source # 
Instance details

Defined in CodeWorld.Picture

data TextStyle Source #

Constructors

Plain 
Bold 
Italic 
Instances
Show TextStyle Source # 
Instance details

Defined in CodeWorld.Picture

data Font Source #

Instances
Show Font Source # 
Instance details

Defined in CodeWorld.Picture

Methods

showsPrec :: Int -> Font -> ShowS #

show :: Font -> String #

showList :: [Font] -> ShowS #

blank :: HasCallStack => Picture Source #

A blank picture

polyline :: HasCallStack => [Point] -> Picture Source #

A thin sequence of line segments, with these points as endpoints

path :: HasCallStack => [Point] -> Picture Source #

Warning: Please use polyline instead of path.path may be removed July 2019.

A thin sequence of line segments, with these points as endpoints

thickPolyline :: HasCallStack => Double -> [Point] -> Picture Source #

A thick sequence of line segments, with given line width and endpoints

thickPath :: HasCallStack => Double -> [Point] -> Picture Source #

Warning: Please used thickPolyline instead of thickPath.thickPath may be removed July 2019.

A thick sequence of line segments, with given line width and endpoints

polygon :: HasCallStack => [Point] -> Picture Source #

A thin polygon with these points as vertices

thickPolygon :: HasCallStack => Double -> [Point] -> Picture Source #

A thick polygon with this line width and these points as vertices

solidPolygon :: HasCallStack => [Point] -> Picture Source #

A solid polygon with these points as vertices

curve :: HasCallStack => [Point] -> Picture Source #

A smooth curve passing through these points.

thickCurve :: HasCallStack => Double -> [Point] -> Picture Source #

A thick smooth curve with this line width, passing through these points.

closedCurve :: HasCallStack => [Point] -> Picture Source #

A smooth closed curve passing through these points.

thickClosedCurve :: HasCallStack => Double -> [Point] -> Picture Source #

A thick smooth closed curve with this line width, passing through these points.

solidClosedCurve :: HasCallStack => [Point] -> Picture Source #

A solid smooth closed curve passing through these points.

rectangle :: HasCallStack => Double -> Double -> Picture Source #

A thin rectangle, with this width and height

solidRectangle :: HasCallStack => Double -> Double -> Picture Source #

A solid rectangle, with this width and height

thickRectangle :: HasCallStack => Double -> Double -> Double -> Picture Source #

A thick rectangle, with this line width, and width and height

circle :: HasCallStack => Double -> Picture Source #

A thin circle, with this radius

solidCircle :: HasCallStack => Double -> Picture Source #

A solid circle, with this radius

thickCircle :: HasCallStack => Double -> Double -> Picture Source #

A thick circle, with this line width and radius

arc :: HasCallStack => Double -> Double -> Double -> Picture Source #

A thin arc, starting and ending at these angles, with this radius

Angles are in radians.

sector :: HasCallStack => Double -> Double -> Double -> Picture Source #

A solid sector of a circle (i.e., a pie slice) starting and ending at these angles, with this radius

Angles are in radians.

thickArc :: HasCallStack => Double -> Double -> Double -> Double -> Picture Source #

A thick arc with this line width, starting and ending at these angles, with this radius.

Angles are in radians.

text :: HasCallStack => Text -> Picture Source #

Warning: Please used lettering instead of text.text may be removed July 2019.

A rendering of text characters.

lettering :: HasCallStack => Text -> Picture Source #

A rendering of text characters.

styledText :: HasCallStack => TextStyle -> Font -> Text -> Picture Source #

Warning: Please used styledLettering instead of styledText.styledText may be removed July 2019.

A rendering of text characters, with a specific choice of font and style.

styledLettering :: HasCallStack => TextStyle -> Font -> Text -> Picture Source #

A rendering of text characters onto a Picture, with a specific choice of font and style.

colored :: HasCallStack => Color -> Picture -> Picture Source #

A picture drawn entirely in this color.

coloured :: HasCallStack => Color -> Picture -> Picture Source #

A picture drawn entirely in this colour.

translated :: HasCallStack => Double -> Double -> Picture -> Picture Source #

A picture drawn translated in these directions.

scaled :: HasCallStack => Double -> Double -> Picture -> Picture Source #

A picture scaled by these factors.

dilated :: HasCallStack => Double -> Picture -> Picture Source #

A picture scaled by these factors.

rotated :: HasCallStack => Double -> Picture -> Picture Source #

A picture rotated by this angle.

Angles are in radians.

(<>) :: Semigroup a => a -> a -> a infixr 6 #

An associative operation.

(&) :: HasCallStack => Picture -> Picture -> Picture infixr 0 Source #

Binary composition of pictures.

coordinatePlane :: HasCallStack => Picture Source #

A coordinate plane. Adding this to your pictures can help you measure distances more accurately.

Example:

main = drawingOf (myPicture <> coordinatePlane) myPicture = ...

:: HasCallStack => Picture Source #

The CodeWorld logo.

rotatedVector :: Double -> Vector -> Vector Source #

Angle is in radians

Colors

data Color Source #

Constructors

RGBA !Double !Double !Double !Double 
Instances
Eq Color Source # 
Instance details

Defined in CodeWorld.Color

Methods

(==) :: Color -> Color -> Bool #

(/=) :: Color -> Color -> Bool #

Show Color Source # 
Instance details

Defined in CodeWorld.Color

Methods

showsPrec :: Int -> Color -> ShowS #

show :: Color -> String #

showList :: [Color] -> ShowS #

pattern RGB :: Double -> Double -> Double -> Color Source #

pattern HSL :: Double -> Double -> Double -> Color Source #

cyan :: Color Source #

Warning: Please use the RGB function instead of cyan.The variable cyan may be removed July 2020.

magenta :: Color Source #

Warning: Please use the RGB function instead of magenta.The variable magenta may be removed July 2020.

aquamarine :: Color Source #

Warning: Please use the RGB function instead of aquamarine.The variable aquamarine may be removed July 2020.

azure :: Color Source #

Warning: Please use the RGB function instead of azure.The variable azure may be removed July 2020.

violet :: Color Source #

Warning: Please use Purple instead of violet.The variable violet may be removed July 2020.

chartreuse :: Color Source #

Warning: Please use the RGB function instead of chartreuse.The variable chartreuse may be removed July 2020.

rose :: Color Source #

Warning: Please use the RGB function instead of rose.The variable rose may be removed July 2020.

assortedColors :: [Color] Source #

An infinite list of colors.

pattern White :: Color Source #

Warning: Please use white (lower case) instead of White.The value White may be removed July 2019.

pattern Black :: Color Source #

Warning: Please use black (lower case) instead of Black.The value Black may be removed July 2019.

pattern Gray :: Color Source #

Warning: Please use gray (lower case) instead of Gray.The value Gray may be removed July 2019.

pattern Grey :: Color Source #

Warning: Please use grey (lower case) instead of Grey.The value Grey may be removed July 2019.

pattern Red :: Color Source #

Warning: Please use red (lower case) instead of Red.The value Red may be removed July 2019.

pattern Orange :: Color Source #

Warning: Please use orange (lower case) instead of Orange.The value Orange may be removed July 2019.

pattern Yellow :: Color Source #

Warning: Please use yellow (lower case) instead of Yellow.The value Yellow may be removed July 2019.

pattern Green :: Color Source #

Warning: Please use green (lower case) instead of Green.The value Green may be removed July 2019.

pattern Blue :: Color Source #

Warning: Please use blue (lower case) instead of Blue.The value Blue may be removed July 2019.

pattern Purple :: Color Source #

Warning: Please use purple (lower case) instead of Purple.The value Purple may be removed July 2019.

pattern Pink :: Color Source #

Warning: Please use pink (lower case) instead of Pink.The value Pink may be removed July 2019.

pattern Brown :: Color Source #

Warning: Please use brown (lower case) instead of Brown.The value Brown may be removed July 2019.

Events

data Event Source #

An event initiated by the user.

Values of this type represent events that the user triggers when using an interactive program.

Key events describe the key as Text. Most keys are represented by a single character text string, with the capital letter or other symbol from the key. Keys that don't correspond to a single character use longer names from the following list. Keep in mind that not all of these keys appear on all keyboards.

  • Up, Down, Left, and Right for the cursor keys.
  • F1, F2, etc. for function keys.
  • Backspace
  • Tab
  • Enter
  • Shift
  • Ctrl
  • Alt
  • Esc
  • PageUp
  • PageDown
  • End
  • Home
  • Insert
  • Delete
  • CapsLock
  • NumLock
  • ScrollLock
  • PrintScreen
  • Break
  • Separator
  • Cancel
  • Help
Instances
Eq Event Source # 
Instance details

Defined in CodeWorld.Event

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Read Event Source # 
Instance details

Defined in CodeWorld.Event

Show Event Source # 
Instance details

Defined in CodeWorld.Event

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

Debugging

trace :: Text -> a -> a Source #

Prints a debug message to the CodeWorld console when a value is forced. This is equivalent to the similarly named function in Trace, except that it uses the CodeWorld console instead of standard output.