CodeWorld

Entry points

drawingOf

Arguments

:: Picture

The picture to show on the screen.

-> IO ()

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

animationOf

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.

simulationOf

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.

interactionOf

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.

collaborationOf

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

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

Instances

Monoid Picture

Methods

mempty :: Picture

mappend :: Picture -> Picture -> Picture

mconcat :: [Picture] -> Picture

data TextStyle

Constructors

Plain

Bold

Italic

data Font

Constructors

SansSerif

Serif

Monospace

Handwriting

Fancy

NamedFont !Text

blank :: Picture

A blank picture

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

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

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

Warning: Please use polyline instead of path.

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

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

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

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

Warning: Please used thickPolyline instead of thickPath.

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

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

A thin polygon with these points as vertices

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

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

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

A solid polygon with these points as vertices

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

A smooth curve passing through these points.

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

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

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

A smooth closed curve passing through these points.

loop :: HasCallStack => [Point] -> Picture

Warning: Please use closedCurve instead of loop.

A smooth closed curve passing through these points.

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

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

thickLoop :: HasCallStack => Double -> [Point] -> Picture

Warning: Please use thickClosedCurve instead of thickLoop.

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

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

A solid smooth closed curve passing through these points.

solidLoop :: HasCallStack => [Point] -> Picture

Warning: Please use solidClosedCurve instead of solidLoop.

A solid smooth closed curve passing through these points.

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

A thin rectangle, with this width and height

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

A solid rectangle, with this width and height

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

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

circle :: HasCallStack => Double -> Picture

A thin circle, with this radius

solidCircle :: HasCallStack => Double -> Picture

A solid circle, with this radius

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

A thick circle, with this line width and radius

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

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

Angles are in radians.

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

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

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

Angles are in radians.

text :: HasCallStack => Text -> Picture

A piece of text

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

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

A picture drawn entirely in this color.

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

A picture drawn entirely in this colour.

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

A picture drawn translated in these directions.

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

A picture scaled by these factors.

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

A picture scaled by these factors.

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

A picture rotated by this angle.

Angles are in radians.

pictures :: [Picture] -> Picture

(<>) :: Monoid m => m -> m -> m infixr 6

An infix synonym for mappend.

Since: 4.5.0.0

(&) :: Picture -> Picture -> Picture infixr 0

Binary composition of pictures.

coordinatePlane :: HasCallStack => Picture

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

Example:

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

codeWorldLogo :: HasCallStack => Picture

The CodeWorld logo.

type Point = (Double, Double)

type Vector = (Double, Double)

vectorLength :: Vector -> Double

vectorDirection :: Vector -> Double

vectorSum :: Vector -> Vector -> Vector

vectorDifference :: Vector -> Vector -> Vector

scaledVector :: Double -> Vector -> Vector

rotatedVector :: Double -> Vector -> Vector

Angle is in radians

dotProduct :: Vector -> Vector -> Double

Colors

data Color

Constructors

RGBA !Double !Double !Double !Double

Instances

Eq Color

Methods

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

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

Show Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

type Colour = Color

pattern RGB :: Double -> Double -> Double -> Color

pattern HSL :: Double -> Double -> Double -> Color

black :: Color

white :: Color

red :: Color

green :: Color

blue :: Color

cyan :: Color

magenta :: Color

yellow :: Color

aquamarine :: Color

orange :: Color

azure :: Color

violet :: Color

chartreuse :: Color

rose :: Color

brown :: Color

pink :: Color

purple :: Color

gray :: Double -> Color

grey :: Double -> Color

mixed :: Color -> Color -> Color

lighter :: Double -> Color -> Color

light :: Color -> Color

darker :: Double -> Color -> Color

dark :: Color -> Color

brighter :: Double -> Color -> Color

bright :: Color -> Color

duller :: Double -> Color -> Color

dull :: Color -> Color

translucent :: Color -> Color

assortedColors :: [Color]

An infinite list of colors.

hue :: Color -> Double

saturation :: Color -> Double

luminosity :: Color -> Double

alpha :: Color -> Double

fromHSL :: Double -> Double -> Double -> Color

Warning: Please use HSL instead of fromHSL.

Events

data Event

An event initiated by the user.

Values of this type represent events that the user triggers when using an interaction, defined with interactionOf.

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

Constructors

KeyPress !Text

KeyRelease !Text

MousePress !MouseButton !Point

MouseRelease !MouseButton !Point

MouseMovement !Point

Instances

Eq Event

Methods

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

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

Read Event

Methods

readsPrec :: Int -> ReadS Event

readList :: ReadS [Event]

readPrec :: ReadPrec Event

readListPrec :: ReadPrec [Event]

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data MouseButton

Constructors

LeftButton

MiddleButton

RightButton

Instances

Eq MouseButton

Methods

(==) :: MouseButton -> MouseButton -> Bool

(/=) :: MouseButton -> MouseButton -> Bool

Read MouseButton

Methods

readsPrec :: Int -> ReadS MouseButton

readList :: ReadS [MouseButton]

readPrec :: ReadPrec MouseButton

readListPrec :: ReadPrec [MouseButton]

Show MouseButton

Methods

showsPrec :: Int -> MouseButton -> ShowS

show :: MouseButton -> String

showList :: [MouseButton] -> ShowS

pattern PointerPress :: Point -> Event

pattern PointerRelease :: Point -> Event

pattern PointerMovement :: Point -> Event

Debugging

trace :: Text -> a -> a

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.