MiniLight.Component

Documentation

type HookMap = HashMap Text (Text, Object -> Value)

class HasComponentEnv c where

Minimal complete definition

componentEnv

Methods

componentEnv :: Lens' c ComponentEnv

_callbacks :: Lens' c (Maybe HookMap)

_uid :: Lens' c Text

Instances

HasComponentEnv ComponentEnv

Defined in MiniLight.Component

Methods

componentEnv :: Lens' ComponentEnv ComponentEnv

_callbacks :: Lens' ComponentEnv (Maybe HookMap)

_uid :: Lens' ComponentEnv Text

data ComponentEnv

Environmental information, which are passed for each component

Constructors

ComponentEnv

Fields

• uid :: Text

  The unique id

• callbacks :: Maybe HookMap

  The hooks

Instances

HasComponentEnv ComponentEnv

Defined in MiniLight.Component

Methods

componentEnv :: Lens' ComponentEnv ComponentEnv

_callbacks :: Lens' ComponentEnv (Maybe HookMap)

_uid :: Lens' ComponentEnv Text

emit

Arguments

:: (HasLoopEnv env, HasComponentEnv env, MonadIO m, EventType et)

=> Maybe Text

target component ID

-> et

-> LightT env m ()

Emit a signal, which will be catched at the next frame.

emitGlobally :: (HasLoopEnv env, HasComponentEnv env, MonadIO m, EventType et) => et -> LightT env m ()

Emit a signal globally.

class ComponentUnit c where

CompoonentUnit typeclass provides a way to define a new component. Any ComponentUnit instance can be embedded into Component type.

Minimal complete definition

figures

Methods

update :: (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => c -> LightT env m c

Updating a model.

figures :: (HasLightEnv env, MonadIO m, MonadMask m) => c -> LightT env m [Figure]

Descirbes a view. The figures here would be cached. See also useCache for the cache configuration.

draw :: (HasLightEnv env, MonadIO m, MonadMask m) => c -> LightT env m ()

Drawing a figures.

onSignal :: (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> c -> LightT env m c

Event handlers

useCache

Arguments

:: c

A model value in the previous frame

-> c

A model value in the current frame

-> Bool

Return True if a cache stored in the previous frame should be used.

beforeClearCache :: (HasLightEnv env, MonadIO m, MonadMask m) => c -> [Figure] -> LightT env m ()

To be called just before clearing caches. If you want to destroy cached textures for memory efficiency, override this method.

NB: Freeing SDL textures and figures are not performed automatically. You must call freeFigure at your own risk.

Instances

ComponentUnit Component

Defined in MiniLight.Component

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Component -> LightT env m Component

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> Component -> LightT env m Component

useCache :: Component -> Component -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> [Figure] -> LightT env m ()

ComponentUnit MessageEngine

Defined in Data.Component.MessageEngine

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => MessageEngine -> LightT env m MessageEngine

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageEngine -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageEngine -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> MessageEngine -> LightT env m MessageEngine

useCache :: MessageEngine -> MessageEngine -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageEngine -> [Figure] -> LightT env m ()

ComponentUnit Button

Defined in Data.Component.Button

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Button -> LightT env m Button

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Button -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Button -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> Button -> LightT env m Button

useCache :: Button -> Button -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Button -> [Figure] -> LightT env m ()

ComponentUnit Layer

Defined in Data.Component.Layer

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Layer -> LightT env m Layer

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Layer -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Layer -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> Layer -> LightT env m Layer

useCache :: Layer -> Layer -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Layer -> [Figure] -> LightT env m ()

ComponentUnit Selection

Defined in Data.Component.Selection

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Selection -> LightT env m Selection

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Selection -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Selection -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> Selection -> LightT env m Selection

useCache :: Selection -> Selection -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Selection -> [Figure] -> LightT env m ()

ComponentUnit AnimationLayer

Defined in Data.Component.AnimationLayer

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => AnimationLayer -> LightT env m AnimationLayer

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => AnimationLayer -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => AnimationLayer -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> AnimationLayer -> LightT env m AnimationLayer

useCache :: AnimationLayer -> AnimationLayer -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => AnimationLayer -> [Figure] -> LightT env m ()

ComponentUnit MessageLayer

Defined in Data.Component.MessageLayer

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => MessageLayer -> LightT env m MessageLayer

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageLayer -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageLayer -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> MessageLayer -> LightT env m MessageLayer

useCache :: MessageLayer -> MessageLayer -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => MessageLayer -> [Figure] -> LightT env m ()

data Component

A wrapper for ComponentUnit instances.

Instances

ComponentUnit Component

Defined in MiniLight.Component

Methods

update :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Component -> LightT env m Component

figures :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> LightT env m [Figure]

draw :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> LightT env m ()

onSignal :: forall env (m :: Type -> Type). (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, MonadMask m) => Event -> Component -> LightT env m Component

useCache :: Component -> Component -> Bool

beforeClearCache :: forall env (m :: Type -> Type). (HasLightEnv env, MonadIO m, MonadMask m) => Component -> [Figure] -> LightT env m ()

_unsafeAs :: ComponentUnit c => Lens' Component c

Unsafe coercing the component

newComponent :: (ComponentUnit c, HasLightEnv env, MonadIO m, MonadMask m) => Text -> c -> LightT env m Component

Create a new component.

getComponentSize :: (ComponentUnit c, HasLightEnv env, MonadIO m, MonadMask m) => c -> LightT env m (Rectangle Int)

Get the size of a component.

getUID :: Component -> Text

Get its unique id.

getHooks :: Component -> Maybe HookMap

Get the hooks

setHooks :: Component -> Maybe HookMap -> Component

Get the hooks

propagate :: Component -> Component

Clear the previous model cache and reflect the current model.