Graphics.Web.Processing.Core.Types

Collection of types.

Processing Script

data ProcScript

A complete Processing script.

It consists in several parts, most of them optional.

To generate each part of the code, use the ProcM monad and the functions from the Graphics.Web.Processing.Interface module. Then, run runProcM or execProcM to get the code result.

More abstract functions generate ProcScript values as well. See modules Graphics.Web.Processing.Mid and Graphics.Web.Processing.Simple for two alternative ways.

Constructors

ProcScript

Fields

proc_preamble :: ProcCode Preamble

proc_setup :: ProcCode Setup

proc_draw :: Maybe (ProcCode Draw)

proc_mouseClicked :: Maybe (ProcCode MouseClicked)

proc_mouseReleased :: Maybe (ProcCode MouseReleased)

proc_keyPressed :: Maybe (ProcCode KeyPressed)

Instances

Pretty ProcScript

emptyScript :: ProcScript

Empty script.

Script rendering

renderScript :: ProcScript -> Text

Render a script as a lazy Text.

renderFile :: FilePath -> ProcScript -> IO ()

Render a script using renderScript and write it directly in a file.

Processing Code

data ProcCode c

A piece of Processing code. The type parameter indicates what the context of the code is. This context will allow or disallow the use of certain commands.

Instances

Eq (ProcCode c)

Monoid (ProcCode a)

Pretty (ProcCode c)

Contexts

data Preamble

The preamble is the code that is executed at the beginning of the script.

Constructors

Preamble

data Setup

In the setup part, settings like size or frame rate are supplied.

Constructors

Setup

Instances

Drawing Setup

Context Setup

data Draw

The drawing loop.

Constructors

Draw

Instances

Drawing Draw

Context Draw

data MouseClicked

Code that is executed when the mouse is clicked.

Constructors

MouseClicked

Instances

Drawing MouseClicked

Context MouseClicked

data MouseReleased

Code that is executed when the mouse is released.

Constructors

MouseReleased

Instances

Drawing MouseReleased

Context MouseReleased

data KeyPressed

Code executed when a key is pressed.

Constructors

KeyPressed

Instances

Context KeyPressed

Proc_* types

class ProcType a

Class of Processing value types (Proc_* types).

Proc_* types are types from the world of Processing. Some of them are similar to Haskell types, like Proc_Bool and Bool. However, they are not equal. Proc_* types are instance of Eq. However, you should instead use methods from the analog Proc_Eq class. Proc_* types contain expressions instead of values. Think of 2+2 instead of 4. Under this situation, 2+2 /= 3+1, since they are different expressions, even if they evaluate to the same value. Actually, you will get True from the evaluation of 2+2 == 3+1, since the library is smart enough to figure out they have the same value. But, please, don't rely on this. Use the Proc_Eq and Proc_Ord classes instead. They return Processing boolean expressions instead of Bool values. Anyway, the types of the library will try to force you to use Proc_* types everywhere.

The reason this library stores expressions instead of values is that it needs to handle things like 2+x, where x is an unknown value. However, an effort is done to ensure that each expression is reduced to its minimum extension.

Instances

ProcType Proc_Text

ProcType Proc_Char

ProcType Proc_Image

ProcType Proc_Float

ProcType Proc_Int

ProcType Proc_Bool

Bool

data Proc_Bool

Boolean values.

Instances

Eq Proc_Bool

Ord Proc_Bool

Pretty Proc_Bool

Proc_Eq Proc_Bool

ProcType Proc_Bool

VarLength Proc_Bool

CustomValue Proc_Bool

true :: Proc_Bool

Value of True.

false :: Proc_Bool

Value of False.

fromBool :: Bool -> Proc_Bool

Cast a Bool value.

pnot :: Proc_Bool -> Proc_Bool

Negation.

(#||) :: Proc_Bool -> Proc_Bool -> Proc_Bool

Disjunction.

(#&&) :: Proc_Bool -> Proc_Bool -> Proc_Bool

Conjunction.

Int

data Proc_Int

Integer numbers.

Instances

Enum Proc_Int

Eq Proc_Int

Integral Proc_Int

Num Proc_Int

WARNING: signum method is undefined.

Ord Proc_Int

Real Proc_Int

Pretty Proc_Int

Proc_Ord Proc_Int

Proc_Eq Proc_Int

ProcType Proc_Int

VarLength Proc_Int

CustomValue Proc_Int

fromInt :: Int -> Proc_Int

Cast an Int value.

intToFloat :: Proc_Int -> Proc_Float

Cast a Proc_Int to a Proc_Float.

Float

data Proc_Float

Floating point numbers. The provided Eq instance checks the equality of the internal expression, not the value.

Instances

Eq Proc_Float

Floating Proc_Float

WARNING: sinh, cosh, asinh, acosh and atanh methods are undefined.

Fractional Proc_Float

Num Proc_Float

WARNING: signum method is undefined.

Ord Proc_Float

Pretty Proc_Float

Proc_Ord Proc_Float

Proc_Eq Proc_Float

ProcType Proc_Float

VarLength Proc_Float

CustomValue Proc_Float

fromFloat :: Float -> Proc_Float

Cast a Float value.

pfloor :: Proc_Float -> Proc_Int

Calculate the floor of a Proc_Float.

pround :: Proc_Float -> Proc_Int

Round a number to the closest integer.

Char

data Proc_Char

Type of characters.

Instances

Eq Proc_Char

Ord Proc_Char

Pretty Proc_Char

Proc_Eq Proc_Char

ProcType Proc_Char

VarLength Proc_Char

CustomValue Proc_Char

fromChar :: Char -> Proc_Char

Cast a Char value.

Text

data Proc_Text

Type of textual values.

Instances

Eq Proc_Text

Ord Proc_Text

IsString Proc_Text

Pretty Proc_Text

Proc_Eq Proc_Text

ProcType Proc_Text

VarLength Proc_Text

CustomValue Proc_Text

fromStText :: Text -> Proc_Text

Cast a strict Text value.

Image

data Proc_Image

Type of images.

Instances

Eq Proc_Image

Pretty Proc_Image

ProcType Proc_Image

VarLength Proc_Image

CustomValue Proc_Image

Processing classes

class Proc_Eq a where

Eq class for Proc_* values.

Methods

(#==) :: a -> a -> Proc_Bool

(#/=) :: a -> a -> Proc_Bool

Instances

Proc_Eq Proc_Text

Proc_Eq Proc_Char

Proc_Eq Proc_Float

Proc_Eq Proc_Int

Proc_Eq Proc_Bool

class Proc_Ord a where

Ord class for Proc_* values.

Methods

(#<=) :: a -> a -> Proc_Bool

(#<) :: a -> a -> Proc_Bool

(#>=) :: a -> a -> Proc_Bool

(#>) :: a -> a -> Proc_Bool

Instances

Proc_Ord Proc_Float

Proc_Ord Proc_Int

Conditional values

if_ :: ProcType a => Proc_Bool -> a -> a -> a

Conditional value.