Storyboard Designer Utilities

Storyboard Designer offers many features to assist with the efficient development of your embedded user interface. Some of these features improve performance by reducing potential runtime inefficiencies, while other features speed the development of the application by providing greater insight into an existing design or allowing multiple designers to work in parallel on the application's user interface.

Design Notes

The Design Notes export wizard is used to generate an HTML or PDF report of the storyboard project.

The Design Note export can be accessed from File > Export > Storyboard Design Notes or by right-clicking a Storyboard GDE file and selecting Export Storyboard Design Notes. This will open a dialog allowing the user to select the file system location for the design report and the format, HTML or PDF, that the design report should be exported to.

The Design Notes report can be customized to contain a variety of information about the design model. Some of the available content options include screen transition information, content thumbnails, resource usage, and event and variable bindings.

It is also possible to generate headless Design Note exports from the Storyboard Design files that can be used from a command line or scripting environment.

PATH_TO_INSTALL/Storyboard_Designer/storyboard/Storyboard -application
com.crank.gdt.designreport.designreport model=PATH_TO_GDE_MODEL format=[pdf|html]
output=PATH_TO_OUTPUT_FILE
				

The model is the full path to the Storyboard Designer model file and output parameter specifies the file system path where the report and associated resources will be created. The format parameter can be set to either html or pdf to indicate HTML or PDF outputs respectively.

GoTo Dialog

The GoTo dialog provides a quick way to locate and navigate to items in the application design. The GoTo dialog is activated when the CTRL+1 (Windows/Linux) or COMMAND+1 (Mac) keys are pressed while working in the main editor.

The Name and Value entries allow you to narrow the search criteria for the object you wish to find. The text entered here will filter the results in the list to only display search results matching what you have typed:

Name

This selection limits the search to the primary name of the objects being searched. The name field also searches the name attributes of render extension and action attributes.

Value

This selection limits the search to the value field of actions or render extensions being searched.

Storyboard Search Dialog

Storyboard Search provides an extension of the Go To functionality. Rather than providing the ability to see and navigate to a single selection, the results of a search are displayed in a tree format.

To search, invoke the Search dialog via the Search menu item or the CTRL+H key command. This will open up the search criteria dialog.

Similar to the GoTo dialog, the Name and Value search criteria allow model object names to be searched or in the case of actions and render extension arguments and variables also their values.

The search results will be displayed hierarchically in the Search view:

Where applicable, double clicking the results will cause the appropriate model element to be selected and brought forward in the main Storyboard editor.

Resize Storyboard Application

Use the Resize Storyboard Application dialog to create a new Storyboard Designer model file, with different screen width and height settings, based on an existing model file.

The application resize action dialog allows a Storyboard Designer model file to resize its screen dimensions. Since all of the layers, controls, and render extensions in a model are placed at specific locations within the model, the resize operation provides several parameters to allow the layers, controls and render extensions to be either re-positioned or re-scaled as appropriate.

The output of the resize action is a new model file located in the same file system location as the source model file. Creating this new scaled model file next to the original model file allows the designer to validate and inspect the scaled result before deciding to replace the original file.

Render Extension Resizing

Adjust Line Width: The resize action will change the width of lines that appear in any render extension with the style set to “Line”. The line width will be scaled by the value of the smallest scale factor, be it that of height or that of width.

Image Render Extension Resizing

Enable Scaling: The resize action will enable the scale flag on all image render extensions. Maintain Control to Render Extension Size Ratio: “Enable Scaling” by itself will stretch images to fit the entire control and may not have the desired effect. This option will preserve the ratio from Control to Render Extension so the images will not look disproportionate or out of place within the control.

Text Render Extension Resizing

Adjust Font Point Size: The text font size will be scaled by the value of the smallest scale factor, be it that of height or that of width.

Animation Resizing

Adjust Location: The resize action will scale the start and end values for grd_x, grd_y. Adjust Size: The resize action will scale the start and end values for grd_width and grd_height.

Data Change Resizing

Adjust Location: The resize action will scale values for grd_x, grd_y. Adjust Size: The resize action will scale values for grd_width and grd_height. For the best results we recommend performing a resize action will each of the options enabled and revisiting the resize dialog if one or some of the options did not produce the desired results. The resizer is a tool to reduce the amount of time spent in the event that an application must be resized, with that said, there is usually some fine grain touches left to be completed by the application developer.

TIP: When binding variables to render extension x, y, width and height, it is good practice to append the variable name with a corresponding “grd_”. For example if binding a variable to the width attribute of a render extension containing a logo, a good variable name is “logo_grd_width”. By naming these variables in such a fashion, the resizer will find these variables during the Animation and Data Change Action resize.

Resource Clean Up Wizard

Run the Resource Clean Up wizard from within the Images view or by selecting the model file in the Navigator view and selecting Resource Clean Up... from the menu.

The Resource Clean Up wizard is used to remove resources that are present in the workspace but are no longer referenced by the project. In the wizard, the list on the left side contains the resources (fonts, images) and is used to select the resources that should be maintained/kept in the project. All resources that are not selected will be permanently removed from the project and file system. The preview on the right side contains a preview of the selected resource and the file system location of that resource.

This tool can only detect those resources that are directly referenced by the project. It is important that resources that are referenced from external programs or scripts be manually checked so as to prevent their removal from the project.

Once all of the resources to remove have been identified, selecting OK will perform the permanent removal of those files from the file system.

Consolidate Images Wizard

The Consolidate Images Wizard can be launched from the toolbar in the Images view.

Launching the Consolidate Images wizard will start an analysis of all of the images in the workspace. These images are compared byte by byte to determine if their content is identical and can safely be consolidated together into a single reference.

Once the analysis is complete, a dialog will present the results showing the duplicate images that have been detected and provides a visual comparison of the source and reference images to ensure that they are indeed different.

By default, all duplicates will be consolidated into a single reference. To remove a reference from being consolidated, deselect the item.

Selecting OK will search the model and consolidate variable and argument references to unify their references.

After all of the references have been combined there are likely to be a number of images that are no longer used. These can be immediately deleted from the workspace at this point.

Trim Images Wizard

The Trim Images Wizard can be launched from the toolbar in the Images view.

Launching the Image Trim wizard starts an analysis of either all (no selection made) or just the selected images from the Image view. It scans the image looking for transparent pixels on the borders of the image, in order to shrink the image to it's smallest possible size.

The Wizard displays the selected images (or all images, if no selection) that have any pixels to be trimmed. The image preview shows the candidate image, and provides information on how much of the image will get trimmed. By default, the wizard will make copies of the original, untrimmed files and keep them in your file system. If you would like to delete the original untrimmed files, simply unselect the appropriate checkbox.

The wizard will also refactor all controls containing this image, while maintaining the proper control size and the position of the image within each control.

Split Images Wizard

The Split Images Wizard can be launched from the toolbar in the Images view.

Launching the Image Split wizard starts an analysis of either all (no selection made) or just the selected images from the Image view. It scans the image once, looking for transparent pixels and calculates how the image should be split to get rid of the maximum amount of transparent pixels.

The preview displays a red outline of exactly how the image will be split, and will update according to how many horizontal and vertical splits you specify. The percent of pixels eliminated is displayed in the top right corner.

When you select OK in the dialog the image split operation will proceed on those images you have selected. After splitting the images, all references in your app to the previous image will be refactored such that the controls containing those images will be replaced with the new split images positioned appropriately.

If you would like to leave the controls as they are and not perform the refactoring, simply deselect the "Refactor controls" check box at the bottom of the wizard.

Merge Control Images

This Merge Control Images can be launched from the Application Model view or by right clicking on the desired controls: right click on control(s) Manage -> Merge Control Images.

This can be used when you have one or more controls with static image content that will not change during runtime. It is sometimes more efficient to flatten those render extensions into a single static image. The controls must be in the same layer for the wizard to work correctly.