Crank Storyboard Suite
		Next

Crank Storyboard Suite

Crank Software Inc.

                    4017 Carling Ave, Suite 302
                    Ottawa,Ontario,Canada
                    K2K 2A3
                    1.613.595.1999
                    <info@cranksoftware.com>

Copyright © 2016 All Rights Reserved. For more information email info@cranksoftware.com or visit http://www.cranksoftware.com

Table of Contents

I. Crank Storyboard Suite

1. Storyboard Suite Overview

Introduction

Compatibility with Previous Versions

Storyboard Architecture

Graphical Composition Elements
Events and Actions
Data Variables and the Data Manager
Maintaining State and Reacting to Changes
Execution Pipeline
Execution Environment
Animations
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
Direct Editing

Storyboard Designer Views

Actions View
Application Model View
Animation Timeline View
Images View
Layers View
Navigator View
Outline View
Problems View
Properties View
Templates View
Variables View
Notes View

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
Translation and Internationalization
OpenGL ES 2.0 Custom Shader, 3D Model and Compressed Texture Support
Working With Templates
Working with Multiple Application Design Files
Circles and Arcs
9-Patch
Groups
Scrolling Layers
Target Configuration
User Defined Actions
User Defined Render Extensions
Photoshop Re-Import Feature

Storyboard Designer Utilities

Design Notes
GoTo Dialog
Storyboard Search Dialog
Resize Storyboard Application
Resource Clean Up Wizard
Consolidate Images Wizard
Trim Images Wizard
Split Images Wizard
Merge Control Images

Collaboration and Team Development

Revision Control System Integration
Comparing and Merging Model Files
Comparing and Merging Projects

3. Storyboard Engine

Introduction

Target Configuration

Application Files
Setting up Storyboard Engine
Running Storyboard Engine
Command line Options
Plugins

Custom Shader Support

Font Environment Variable

System Specific Requirements

Linux FBDEV x86, armle
Microsoft WinCE, Compact7 win32, armle
Yocto Jethro Linux kernel (3.14) OpenGL, FBDEV, armle

4. Storyboard Media

Introduction

Media Actions

gra.media.new.audio
gra.media.new.video
gra.media.volume
gra.media.seek
gra.media.stop
gra.media.playpause

Media Events

gre.media.exit
gre.media.timeupdate
gre.media.statechange
gre.media.complete
gre.media.error

Media backends

gstreamer-backend
Gstreamer pipeline
External render extensions

5. Event Definitions

Standard Event Definitions

System Events
Pointer Events
Keyboard Events
Screen Manager Events
Focus Events
Table Events
Table Scroll Events
Layer Scroll Events
Mobile Events (Android and iOS)
Android Events
Windows Embedded Compact 2013 (WEC2013) Events

Plugin Specific 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
gre.rendermgr.error

6. Action Definitions

Built-in Action Definitions

gra.screen
gra.screen.fade
gra.screen.hold
gra.screen.release
gra.sendevent
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.resource.dump_def
gra.playback

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.screen.glswitch
gra.screen.glrotate
gra.screen.glflip
gra.screen.gldoors
gra.screen.gltip
gra.screen.glcube
gra.screendump
gra.timer

7. Render Extension Definitions

Common Render Extension Options

Render Extension Alignment

Fill Render Extension Options

Polygon Render Extension Options

Rectangle Render Extension Options

Image Render Extension Options
Image Alignment

Text Render Extension Options

External Render Extension Options

3D Model Render Extension Options

8. Scripting with Lua

Lua Function Parameters

Passing Extra Parameters to Functions

Storyboard Lua Integration

Lua Execution Environment

Asynchronous Lua Support

Lua Debugger

Introduction
Configuration
Debugging

Storyboard Lua API

Storyboard Lua DOM Module

gredom.get_application
gredom.get_object
DOMOBJECT:get_name
DOMOBJECT:get_type
DOMOBJECT:get_parents
DOMOBJECT:get_children
DOMOBJECT:get_variables
Lua DOM Samples

Storyboard Lua Android Integration

Storyboard Lua Android Integration

9. 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

10. Storyboard 3D Support

3D Rendering Fundamentals
The Scene Graph and Transformations
Material Support
Animation Support
Discussion on mapping FBX Animation data into meaningful structures
Support for Animation Takes

11. Optimizing Your Storyboard Application

Choosing the Right Image Format(s)
Frames Per Second
Scaling Images
Reducing Output Verbosity
Adjusting Engine Rendering Options
Memory
Measuring Performance

12. Storyboard Software Updates

Automatic Updates

II. Storyboard Design Tutorials

13. Creating a Storyboard Project from a Sample

Creating a New Application using the Storyboard Samples

Import
Import Sample
New Sample Project

14. Working with Multiple Application Design Files

Creating a Project
Resolving Conflicts

15. Creating a 3D Model Application

16. Creating a Multi-Touch Application

17. Adding Extra Libraries for Android

18. Adding Extra Libraries for iOS

19. Crank Public SVN

20. Exporting a Storyboard Project

21. Importing a Storyboard Project

III. Storyboard Target Tutorials

TI AM355 Starter Kit

Step 1: Importing A Storyboard Sample
Step 2: Exporting A Storyboard Application
Step 3: Selecting The Storyboard Embedded Engine
Step 4: Configuring The Target Platform
Step 5: Running The Storyboard Application

IV. Release Notes

23. Release Notes 4.0

Introduction

Storyboard Designer

Changes
Known Issues

Storyboard Engine

Changes
Known Issues

24. Release Notes 4.1

Introduction

Storyboard Designer

Changes
Known Issues

Storyboard Engine

Changes
Known Issues

25. Release Notes 4.2

Introduction

Storyboard Designer

Changes
Known Issues

Storyboard Embedded Engine

Changes
Known Issues

V. Licensing

26. END-USER LICENSE AGREEMENT

27. Crank Software Third Party License Guide

Introduction

Storyboard Designer

Lightweight Java Game Library

Storyboard Engine

Lua
SOIL
Option Parsing
XML Parsing
Imagination OpenGL libraries
FreeType library
Scanline edge-flag algorithm for antialiasing
General IFF format
GNU LESSER GENERAL PUBLIC LICENSE

Storyboard Engine Platform Specific Dependencies

All Simple Direct Media Layer (SDL) renderers
All Simple Direct Media Layer (SDL), OpenGL ES 2.0, and Fujitsu Jade renderers.

Bitstream Vera
Bitstream Deja Vu
Liberation
Roboto
Lato

List of Tables

3.1. Options
3.2. Action Manager Options
3.3. Data Manager Options
3.4. IO Manager Options
3.5. Model Manager Options
3.6. Render Manager Options: Windows, win32, OpenGL ES 2.0, x86
3.7. Render Manager Options: Linux, sdl, x86
3.8. Render Manager Options: Linux, fbdev, x86, armle
3.9. Render Manager Options: Linux, directfb, x86, armle
3.10. Render Manager Options: Linux, Windows CE, Windows Compact 7, Mac OSX, Neutrino 6.5, OpenGL ES 2.0, armle (Beagleboard)
3.11. Render Manager Options: QNX Neutrino 6.5, Linux, Fujitsu Jade, armle
3.12. Render Manager Options: WinCE 6.0, Windows Compact 7, win32, armle
3.13. Resource Manager Options
3.14. Screen Manager Options
3.15. 3D model rendering: libgre-plugin-model3d.so
3.16. Capture/Playback: libgre-plugin-capture-playback.so
3.17. Gesture: libgre-plugin-gesture.so
3.18. Linux Input Support: libgre-plugin-dev-input.so
3.19. Lua Scripting: libgre-plugin-lua.so
3.20. Linux Multi-touch Protocol: libgre-plugin-mtdev.so
3.21. Linux Touchscreen Support: libgre-plugin-tslib.so
3.22. Logger: libgre-plugin-logger.so
3.23. QNX input support: libgre-plugin-gfi-input.so
3.24. Storyboard IO: libgre-plugin-greio.so

		Next
		Part I. Crank Storyboard Suite