Crank Storyboard Suite

Crank Software Inc.


                    4017 Carling Ave, Suite 302
                    Ottawa,Ontario,Canada
                    K2K 2A3
                    1.613.595.1999 
                    
                


Table of Contents

I. Crank Storyboard Suite
1. Storyboard Suite Overview
Introduction
Storyboard Architecture
Graphical Composition Elements
Screens
Layers
Controls
Render Extensions
Events and Actions
Events
Event Naming Conventions
Event Format String
Actions
Action Naming Conventions
Data Variables
Storyboard Naming Conventions
Control and Layer Data Variables
Control variables
Layer variables
Table variables
Maintaining State and Reacting to Changes
Execution Pipeline
Trigger Event
Action Execution
Focus
Data Change
Display Render
Execution Environment
Animation
Screen Transitions
Timers
Animation Action
Scripting
External Communication (Storyboard IO)
Performance Considerations
2. Storyboard Designer
Introduction
Designer Environment
Storyboard Designer Workbench
Anatomy of a Storyboard Designer Project
Storyboard Simulator
Storyboard Designer Editor
Editing Content
Editor Toolbar
Storyboard Designer Views
Actions View
Application Model View
Animations View
Font Styles View
Images View
Layers View
Navigator View
Outline View
Problems View
Properties View
Templates View
Variables View
Variable Creation
Creating a Storyboard Designer Project
New Storyboard Application
Photoshop PSD File Import
Storyboard Embedded Engine Import
Existing Project Import
Storyboard Designer Development
Simulating and Exporting an Application
Simulating an Application
Exporting to a Storyboard Embedded Engine
Comparing Projects
Working With Templates
User Defined Actions
Storyboard Designer Utilities
Design Notes
GoTo Dialog
Resize Storyboard Application
Resource Clean Up Wizard
3. Storyboard Engine
Introduction
Storyboard Engine Environment
Storyboard Engine
Engine Manager Options
Action Manager
Data Manager
Model Manager
Render Manager
Resource Manager
Screen Manager
IO Manager
Plugins
Animation
Audio
Event Redirection
Gesture
Storyboard IO
Logger
Lua
Screen Path Transition
Screen Scale Transition
Soft Input/Virtual Keyboard
System
Timer
Linux touchscreen support
Linux input support
Polygon
External
Target Configuration
Application Files
Engine Plugins
System Specific Requirements
Linux SDL
Requirements:
Libraries:
Linux FBDEV
Requirements:
Libraries:
Extra Render Manager Options:
Linux DirectFB
Requirements:
Libraries:
Extra Render Manager Options:
Linux OpenVG 1.x
Requirements:
Libraries:
Extra Render Manager Options:
Linux OpenGL ES 1.x
Requirements:
Libraries:
Extra Render Manager Options:
Linux OpenGL ES 2.0
Requirements:
Libraries:
Extra Render Manager Options:
Neutrino SDL
Requirements:
Libraries:
Neutrino Advanced Graphics
Requirements:
Libraries:
Extra Render Manager Options:
Microsoft WinCE
Requirements:
Libraries:
Extra Render Options:
4. Event Definitions
Standard Event Definitions
System Events
gre.init
gre.quit
gre.redraw
Pointer events
gre.press
gre.release
gre.touch
gre.inbound
gre.outbound
Keyboard Events
gre.keydown
gre.keyup
Screen Manager Events
gre.screenshow.pre
gre.screenshow.post
gre.screenhide.pre
gre.screenhide.post
Focus Events
gre.gotfocus
gre.lostfocus
Table Events
gre.table.viewport
gre.cell.gotfocus
gre.cell.lostfocus
Plugin Event Definitions
gre.gesture.up
gre.gesture.down
gre.gesture.left
gre.gesture.right
gre.screendump.complete
timer.[name] Timer Events
gre.animate.complete.[name] Animation Events
5. Action Definitions
Built-in Action Definitions
gra.screen
gra.screen.fade
gra.screen.hold
gra.screen.release
gra.datachange
gra.screen.focus.set
gra.screen.focus.next
gra.screen.focus.prev
gra.screen.focus.direction
gra.table.scroll
gra.table.resize
gra.table.navigate
gra.log
gra.control.zorder
gra.resource.dump_def
Plugin Action Definitions
gra.lua
gra.animate
gra.animate.stop
gra.audio
gra.greio
gra.perf_state
gra.redirect
gra.screen.path
gra.screen.scale
gra.screendump
gra.timer
6. Render Extension Definitions
Common Render Extension Options
Render Extension Alignment
Fill
Fill Render Extension Options
Polygon
Polygon Render Extension Options
Rectangle
Rectangle Render Extension Options
Image
Image Render Extension Options
Image Alignment
Text
Text Render Extension Options
External
External Render Extension Options
7. Scripting with Lua
Lua Function Parameters
Passing Extra Parameters to Functions
Storyboard Lua Integration
Lua Execution Environment
Lua Debugger
Introduction
Configuration
Create a Storyboard Launch Configuration
Enable Lua Debugging
Create the Lua Debug Launch Configuration
Launch the Storyboard Application
Launch the Lua Debug Session
Debugging
Breakpoints
Variables
Stepping, Continuing and Terminating
Storyboard Lua API
gre.set_data
gre.get_data
gre.send_event
gre.send_event_target
gre.send_event_data
gre.greio_disconnect
gre.touch
gre.key_up
gre.key_down
gre.key_repeat
gre.redraw
gre.quit
gre.layer_move
gre.control_move
gre.get_control_attrs
gre.set_control_attrs
gre.get_layer_attrs
gre.set_layer_attrs
gre.set_layer_attrs_global
gre.get_table_attrs
gre.get_string_size
gre.resolve_data_key
gre.load_resource
gre.dump_resource
gre.walk_pool
gre.mstime
gre.env
8. Storyboard IO
Connecting to a Storyboard Application
Sending Events to a Storyboard Application
Setting Application Data
Receiving Events from a Storyboard Application
Storyboard IO Utilities
iogen
iorcv
Storyboard IO API
gre_io_add_mdata
gre_io_close
gre_io_free_buffer
gre_io_grow_buffer
gre_io_open
gre_io_receive
gre_io_send
gre_io_send_mdata
gre_io_serialize
gre_io_size_buffer
gre_io_unserialize
gre_io_zero_buffer
9. Optimizing Your Storyboard Application
Choosing the Right Image Format(s)
Frames Per Second
Scaling Images
Reducing Ouput Verbosity
Memory
Measuring Performance
II. Storyboard Design Tutorials
10. Creating a Storyboard Project from a Sample
Creating a New Application using the Storyboard Samples
Import
Import Sample
New Sample Project
III. Release Notes
11. Release Notes 1.3
Introduction
Storyboard Designer
Major Changes
Properties View
Drag and Drop in the Application View
Pop-up Preview
Audio
Templates
Resource Clean up
Goto
Minor Changes
Collaboration
PSD Import
Layer Asset Manager
Storyboard Engine
Major Changes
OpenGL ES 2.0
Runtime Updater
Windows Compact 7
Performance Information
Known Issues
12. Release Notes 1.2
Introduction
Storyboard Designer
Major Changes
Mac OS X Support
Collaboration Support with graphical model compare
UI Design Report
Minor Changes
Notes section now available for all model elements
More flexibility with variable selection
Support for offscreen controls
Win32 runtime is now located with all other runtimes
PSD import improvements
New control alignment options
Added recently used sort policy and readable names to action wizard
Strings with comma's or equal signs no longer need to be in a variable
Known Issues
Storyboard Engine
Major Changes
OpenGL ES 1.1
Animation Manager
Internationalization / Unicode Support
Minor Changes
Rotation support for negative numbers
Z co-ordinate for touch events
Keys events under windows all in upper case
gre.send_event_data() supports all data formats
gre.send_event_target()
gre.quit available on WinCE
WinCE and QNX memory optimization
Support for GIF images
Known Issues
13. Release Notes 1.1
Introduction
Storyboard Designer
Major Changes
Linux Host Storyboard Designer
Storyboard Project Merge
Lua Editor Improvements
Lua Debugger (Beta)
Minor Changes
Hot key support
Automatic addition of timer and animation complete events
Action and Variable view sorting and filtering
Animation wizard
Polygon Render Extension
Known Issues
Storyboard Engine
Major Changes
WinCE 6.0 Support for ARMLE
Linux DirectFB Support
Linux OpenVG Support (Beagleboard)
SH4 Support for Linux and QNX6
PPC Support for QNX6
Polygon Render Extension
Minor Changes
liblua.so / dll
Version information
Deployment Bundle (*.gapp) changes
Lua function to calculate string width
Lua function to globally set layer attributes
Lua events
Access control width and height
Move control Z-order
Arbitrary rotation
Screen manager option for available hardware layers
Software cursor support
Layer can now contain variable
Alpha blending for fbdev
Motion events moved to higher verbosity level
Storyboard IO support for Win32
Storyboard IO Channel name option
Load scaled images
Known Issues
Miscellaneous
Minor Changes
License Information
Documentation
IV. Licensing
14. Storyboard End-User License Agreement
15. Crank Software Third Party License Guide
Introduction
Lua
SOIL
Option Parsing
XML Parsing
Fonts
Deja Vu
Liberation
TTF Bitstream Vera
Dependencies
Linux Direct to Framebuffer (fbdev)
Freetype
Linux and QNX Neutrino Simple Direct Media Layer (SDL)
SDL
SDL image
libpng
libz
libjpeg
SDL ttf
Freetype