OmniGSoft Template Overview
Reference - Attribute Value Rules
Reference - OGTemplate Reserved Type
Reference - LWComponent Class Signature
- LWButton
- LWLabel
- LWCheckBoxSet
- LWRadioButtonGroup
- LWTextField
- LWTextArea
- LWPasswordField
- LWTextView
- LWImageView
- LWSwitch
- LWSlider
- LWTextSlider
- LWScrollBar
- LWSpinner
- LWTextSpinner
- LWProgressBar
- LWColorSwatch
- LWTable
- LWTreeView
- LWListBox
- LWComboBox
- LWPropertyBox
- LWContentPane
- LWScrollPane
- LWSplitPane
- LWTeePane
- LWTabbedPane
- LWSlidingPane
- LWConsole
- LWListPane
- LWToolBox
- LWMenu
Reference - OGTemplate Constants

OmniGSoft Template Overview

About OmniGSoft Template

OmniGSoft template (hereinafter also referred to as "OGTemplate") is Pooka SDK®'s proprietary content template used to describes application content and generates scene graph based content (2D and 3D) once parsed by OGCanvas .

Here are some basic facts about OGTemplate:

OGTemplate file is derived from Java .properties file, with numbers of extensions added.
The file extension can be any thing desired, such as .properties, .txt, .plist.
However, the file extension is only defined by application developers and does not mean it can be treated and parsed by operating system like those well known property file types, such as macOS .plist file.
How OGTemplate is loaded by OGCanvas class
OGTemplate can be loaded from a file bundled in application package as application assets, or loaded from a in-memory wide-char C string. See functions loadTemplate() and loadTemplateByString() for more details.
The OGCanvas can have its template loaded by the loading functions by numbers of times and the result will be accumulated unless function unloadTemplate() is called. The loaded template is maintained by a Properties instance owned by the OGCanvas , to access this in-memory template, use the function getTemplate() .
OGTemplate file can be saved with one of the following encodings: Western European, UTF-8 and Unicode.
The line breaking token can be either Windows (CR LF) or Macintosh (CR).
File inclusion is supported by keyword #include, followed by the relative path of the OGTemplate file to be included. The file inclusion can help divide large template file into smaller ones or can be used to load a shared common "header" template for each individual template. For example:
#include "TemplateHeader/Common_header.txt" //Include the common header
Each line of OGTemplate defines a property, which can be a generic property if it is not recognized by the template parser, or a reserved property (or content property, see below) if its attribute type is recognized by the template parser.
The following template line defines a generic property, where the property name is PropertyName and the property value is PropertyValue.
PropertyName = PropertyValue
All names of property, attribute and parameter in OGTemplate are case-sensitive unless specially declared.
The property value can be further parsed into application content if the attribute type is a reserved type defined in OGTemplate, this property is referred to as content property; Otherwise, the property is stored and treated as a generic property.
Sample of generic property:
Golf_Course_Selected = 2 // The game scene selected
pars = 3,3,3,4,4,4,5,5,5 // The golf course pars (nine hole)
Sample of reserved / content property (note that the type values are reserved OGTemplate types):
sceneGUI = type:SceneSprite, x:0, y:0, width:240, height:320 //The scene
sptPageTitle = type:Sprite, container:sceneGUI, pos:(CENTER; 40), size:(240;20), \ //The page title
textSize:12, textAlignment:CENTER, bitmapFont:bmpFontText, text: Select Golf Course
btnNext = type:Sprite, GUItype:button, container:sceneGUI, \ //The "continue" button
x:200, y:200, texture:button.gif, text:Continue
The extensions added in OGTemplate
- Whole-line comment can be made by using token # or // at the beginning of the line.
  (Note: if using #, the character # must be the first character of the line)
  # This whole line is a comment line
  // This whole line is a comment line
- Line-end comment can be made by adding comment started with // after a property line.
  Note Inserting comment in the middle of the property line is not supported.
  sptBkg = type:Sprite, {PAGE_BKG} //Note: "PAGE_BKG" is defined in "Common_header.txt"
- A property can be referenced as a macro definition in later property lines. As long as the macro is defined earlier than the time it is referenced.
  - Simple (parameter-less) macro
    Simple macro is as simple as a generic property, it does not have any parameters.
    COMMON_FONT_PARA = glyphNumber:91, startCode:32, caseConvertion:NO_CONVERSION, monospace:FALSE //Macro defines font parameter
    bmpFontTitle = type:BitmapFont, bitmap:../BitmapFont/propFontTitle.png, {COMMON_FONT_PARA} //Macro referenced
    bmpFontTitleBright = type:BitmapFont, bitmap:../BitmapFont/propFontTitleBright.png, {COMMON_FONT_PARA} //Macro referenced
  - Parametered macro
    Parametered macro can contains numbers of formal arguments, at the time it is referenced, actual argument can be passed in to generate final result.
    BUTTON(w;h;text) = \ // Macro defines a button (w: width, h: height, text: text)
    container:sceneGUI, GUItype:BUTTON, size:([w];[h]), text:[text], \
    texture:Button/button.png, textureBright:Button/buttonBright.png, \
    textureEdgeInset:(11;3;11;3), bitmapFont:bmpFontText, textAlignment:CENTER, textVAlignment:MIDDLE
    btnBack = type:Sprite, {BUTTON(50;15;Back)}, GUItype:HYPERLINK, href:MainEntry.txt, posByRef:(15; 5; SCENE; POS_LEFTBOTTOM)
    btnStartGame = type:Sprite, {BUTTON(50;15;Start)}, GUItype:BUTTON, posByRef:(15; 5; SCENE; POS_RIGHTBOTTOM), defaultFocus:1

Template structure and syntax

OGTemplate file is composed by numbers of text line. A text line will be parsed as a property if it complies the property line format rules. The text at left side of the property separator is property name and the text at right side is property vale.
See the following picture. Property Format - 1

Note

Large property line can be broke into multiple lines by line continuation token \.
White space characters (space, tab) are trimmed off, therefore these white space characters can be inserted for better code indention.
All text lines that are not recognized as property line are ignored
Empty text lines are ignored
A property can reference other property defined earlier (also referred to as "macro") by characters { and }

Property parsed as generic property or content property

content property (see reference):
A property has attribute type and its value is a recognizable type (see the type value chart) defined in OGTemplate. A content property will be translated into Pooka SDK® application content element, such as a Sprite , a light weight component , or a texture or sound resource.
The following picture shows a content property comListBox5 is parsed and translated into a light weight component LWListBox .
Generic Property:
A property can not be recognized as a content property (see above) is treated as generic property. Generic property can carry any information that can only be understood by application itself, therefore it can be used to define application custom properties. Another important use of generic property is defining a macro that can be referenced by other properties.

Property Format - 2

Tip ALl OGTemplate separator tokens can be customized by application, see the following class members of OGCanvas for more dtails:

Attribute Syntax

Attribute is composed of the attribute name and its value. All attribute names are case-sensitive. For example, if attribute 'GUItype' is written as 'guiType', it will not be recognized properly.
Attribute values are assigned by the following segment in the name/value pair. Attribute value can be a single value, a complex value consists of several values, or an array of values.

Simple attribute
A single value is singled to the attribute
width:120, height:20, x:10, y:50, color:YELLOW, frameColor:BLACK
Attribute with complex value
Complex value are mutilple values enclosed in parenthesis ( and ), they must be separated by the parameter separator ;.
size:(120;20), pos:(10; 50), bkgColor:(150;130;180), frameColor:(60;40;80)
Attribute with complex value and value is an array
If one value is an array, then all the elements must be separated by the element separator |.
className:LWListBox(4; VERTICAL; FALSE; ASCENDING; FALSE; TRUE; 50; Apple|Banana|Blackberry|Cherry|Grape|Lemon|Orange|Peach|Pear|Watermelon; 3)

Regardless of the forms of the attribute value, all attribute value must met the specific rules of make them properly parsed, see Attribute Value Rules for more details.

Tip All separator tokens can be customized by application, see the following class members of OGCanvas for more details:

An OGTemplate Sample

The following sample OGTemplate comes from sample project "Space Defender". The asset file "EnterGame.txt" is the OGTemplate that makes the "Enter game" page for the game and the asset file "Common_header.txt" is the common header file defines some shared macros and is included by all other page templates.

EnterGame.txt

#include "TemplateHeader/Common_header.txt"     //Include the common header
ARROW_BTN   = textColor:(170;210;230), textShadow:BLACK, textShadowTransparency:150 // Macro: a button with arrow token
BTN_LEFT    = {BUTTON(20; 15;)}, tokentype:TOKEN_TRIANGLE_LEFT, {ARROW_BTN}         // Macro: button to switch to previous
BTN_RIGHT   = {BUTTON(20; 15;)}, tokentype: TOKEN_TRIANGLE_RIGHT, {ARROW_BTN}       // Macro: button to switch to next
#==========================================================
// The follow properties are used to persist the user selection on the game scene and fighter
// These two properties will be persistent across game sessions, see function OGCanvas::saveTemplate() for more details
sceneSelected   = 2     // The game scene selected
fighterSelected = 1     // The fighter selected
#==========================================================
// The SceneSprite
sceneGUI        = type:SceneSprite, pos:(CENTER; CENTER), size:(VIRTUAL_SCREEN_SHORT_SIDE; VIRTUAL_SCREEN_SHORT_SIDE), \
                    navigationMode:TAB_MODE, highlightFocusedItem:TRUE, navigationIndicatorColor:(255;165;0)
sptBkg          = type:Sprite, {PAGE_BKG}           //Note: "PAGE_BKG" is defined in "Common_header.txt"
sptSceneIndicator = type:DebugSprite, container:sceneGUI, {PAGE_SCENE_INDICATOR}    //For debug purpose only
sptPageTitle    = type:Sprite, {PAGE_TITLE(15; Select Scene and Fighter)}   //Note: "PAGE_TITLE" is defined in "Common_header.txt"
sptRuler1       = type:Sprite, {RULER(30)}      //Note: "RULER" is defined in "Common_header.txt"
sptRuler2       = type:Sprite, {RULER(210)}     //Note: "RULER" is defined in "Common_header.txt"
//...... The fighter preview window .......
sptFighterPreview = type:Sprite, container:sceneGUI, pos:(CENTER; 40), size:(40;40), \
                        textSize:9, textAlignment:CENTER, textOffsetY:45, bitmapFont:bmpFontText
btnLastSpaceFighter = type:Sprite, {BTN_LEFT}, pos:(60; 55)
btnNextSpaceFighter = type:Sprite, {BTN_RIGHT},pos:(160; 55)
//...... The scene preview window .......
sptScenePreview =   type:Sprite, container:sceneGUI, pos:(CENTER; 110), size:(70; 70), frameColor:(200;120;0), \
                    frameThickness:5, frameBevel:3, textSize:9, textAlignment:CENTER, textOffsetY:75, bitmapFont:bmpFontText
btnLastGameScene=   type:Sprite, {BTN_LEFT}, pos:(52; 140)
btnNextGameScene=   type:Sprite, {BTN_RIGHT}, pos:(172; 140)
//...... The buttons go to prev/next page .......
btnBack         = type:Sprite, {BUTTON(50;15;Back)}, GUItype:HYPERLINK, href:MainEntry.txt, posByRef:(15; 5; SCENE; POS_LEFTBOTTOM)
btnStartGame    = type:Sprite, {BUTTON(50;15;Start)}, GUItype:BUTTON, posByRef:(15; 5; SCENE; POS_RIGHTBOTTOM), defaultFocus:1

Common_header.txt

// Page default settings
defaultSetting = type:PageSetting, defaultTextSize:10, defaultTextColor:WHITE, defaultTextColorBright:WHITE
# =============================================================================
// BitmapFont definition
COMMON_FONT_PARA    = glyphNumber:91, startCode:32, caseConvertion:NO_CONVERSION, monospace:FALSE
bmpFontTitle        = type:BitmapFont, bitmap:../BitmapFont/propFontTitle.png, {COMMON_FONT_PARA}, glyphCondensing:200
bmpFontTitleBright  = type:BitmapFont, bitmap:../BitmapFont/propFontTitleBright.png, {COMMON_FONT_PARA}, glyphCondensing:200
bmpFontPage         = type:BitmapFont, bitmap:../BitmapFont/propFontPage.png, {COMMON_FONT_PARA}, glyphCondensing:200
bmpFontText         = type:BitmapFont, bitmap:../BitmapFont/propFontText.png, {COMMON_FONT_PARA}, glyphCondensing:100
# =============================================================================
// Some macro definitions works as style definition
PAGE_BKG                = container:sceneGUI, pos:(CENTER; CENTER), size:(VIRTUAL_SCREEN_LONG_SIDE; VIRTUAL_SCREEN_LONG_SIDE), \
                            texture:Misc/bkg.gif, textureTiling:TRUE
PAGE_TITLE(y; text)     = container:sceneGUI, pos:(CENTER; [y]), size:(200; 12), text:[text], bitmapFont:bmpFontPage, \
                            textAlignment:CENTER, textSize:14
PAGE_SUB_TITLE(y; text) = container:sceneGUI, pos:(10; [y]), size:(160; 20), text:[text], bitmapFont:bmpFontTitle, \
                            textAlignment:LEFT, textSize:14
PAGE_TEXT(x;y;w;h;text) = container:sceneGUI, bitmapFont:bmpFontText, textAlignment:LEFT, pos:([x];[y]), size:([w];[h]), \
                            text:[text]
PAGE_SCENE_INDICATOR    = sizeByRef:(0;0;SCENE;SIZE_POINT), frameColor:(64;0;0)
BUTTON(w;h;text)        =   \                   // A regular button
                        container:sceneGUI, GUIType:BUTTON, size:([w];[h]), text:[text], \
                        texture:Button/button.png, textureBright:Button/buttonBright.png, \
                        textureEdgeInset:(11;3;11;3), bitmapFont:bmpFontText, textAlignment:CENTER, textVAlignment:MIDDLE
RADIO_BUTTON(x;y;text;state;group) = \          // A radio button
                        container:sceneGUI, GUIType:CHECKBOX, persistent:TRUE, \
                        pos:([x];[y]), size:(55;14), text:[text], textOffset:(14;2), bitmapFont:bmpFontText, \
                        textAlignment:LEFT, textureOutputSize:(12;12), \
                        texture:Button/radioButton.png, textureBright:Button/radioButtonOn.png, state:[state], group:[group]
CHECK_BOX(x;y;text;state) = \                   // A check button
                        container:sceneGUI, GUIType:CHECKBOX, persistent:TRUE, \
                        pos:([x];[y]), size:(170;28), text:[text], textOffset:(14;2), bitmapFont:bmpFontText, \
                        textAlignment:LEFT, textureOutputSize:(12;12), \
                        texture:Button/checkbox.png, textureBright:Button/checkboxOn.png, state:[state]
TIP_BOX                 = \                     // A tip box
                        container:sceneGUI, GUIType:BUTTON, texture:Misc/TipBox.png, pos:(CENTER;CENTER), size:(180;160), \
                        textureEdgeInset:(15;15;15;15), bitmapFont:bmpFontText, textAlignment:Left, textPadding:8, textSize:9, \
                        visible:FALSE
RULER(y)                = \                     // A ruler (separate sub-content)
                        container:sceneGUI, pos:(CENTER;[y]), size:(220;4), texture:Misc/ruler.png

Using OGTemplate to organize application control flow

In many ways, OGTemplate files work just like web pages (HTML) that consists of a website. In the case of the Pooka SDK® application, one OGTemplate construct one application page, same as one HTML page that constructs a single web page. User can navigate through application pages, just like they navigate through web pages when visiting a web site.

Some applications, particularly a game application, the control flow can be complicated. The application control flow can be established by application pages. Just like the control flow of a role playing game shown in the right side picture. A well prepared story board or diagram can help application designer easily plan the overall control flow and then the application developers can implement the design by OGTemplate.

The user interactivity can be responded by register event listeners. There are numbers of user input event that can be used to implement the page navigation, the most important event are:

Others event may also be very useful when implement application control flow:

Reference - Attribute Value Rules

Attribute value will be parsed as the corresponding type when the property is parsed by OGCanvas .

A text string

// Text string as a Sprite's text
txtTitle = type:Sprite, container:sceneGUI, x:20, y:100, text:Input Your Name^c, textSize:16
// Text string as a destination page's URL
btnClose=type:Sprite, GUIType:HYPERLINK, href:GUI/MainEntryPage.properties, container:GSettingMenu, ...
// Text string as a Tip-box's name
btnAboutDifLevel=type:Sprite, GUIType:TIPLINK, href:txtAboutDifLevel, ..., text:?

A primitive type

A primitive type can be a boolean, integer, hexadecimal, float, etc.

Boolean value

// Boolean value for various atributes
txtTitle = type:Sprite, container:sceneGUI, textBold:TRUE, textUnderline:0, textItalic:false, visible:1, ...

Integer value

// Integer value as the Sprite's position and size
txtTitle = type:Sprite, container:sceneGUI, x:20, y:100, width:240, height:180, ...
// Integer value as the Sprite's text font size
sptPageTitle = type:Sprite, container:sceneGUI, ..., textSize:12

hexadecimal value

// Hexadecimal alue as Sprite's background and frame color
txtTitle = type:Sprite, container:sceneGUI, color:#A08020, frameColor:#FF00FF, ...

float value

// Floating number as 3D group's radius
grpElephant=type:Group3D, container:scene3D, model:elephant.3ds, radius:3.50f
// Floating number as Sprite's texture rotation angle
sptButtterfly = type:Sprite, container:SceneGUI, ..., textureRotation:45.f

A complex value consists of numbers of parameters

sptPicFrame = type:Sprite, container:sceneGUI, pos:(20; 100), size:(300; 200), color:(255;255;0), frame:(0;0;128)

dirLight1 = type:Light, container:scene3D, dir:(0.5f; -0.5f; 0.2f), color:WHITE

sceneGame = type:Scene3D, x:0, y:0, bkgColor:(0; 0; 100), ambient:(100; 100; 100), cameraPos:(0.f; 100.f; -300.f), cameraLookAt:(0.f; -20.f; 0.f), cameraLens:(60.f; 200.f; 400.f)

grpJetFighterF15 = type:Group3D, container:sceneGame, model:models/F_15.3DS, pos:(-200.f; 1000.f; 0.f)

An OGTemplate constants

btnHelp = type:Sprite, container:sceneGUI, GUItype:BUTTON, textAlignment:CENTER, color:LIGHTGRAY, frameColor:DARKBLUE

An application asset (image, sound, template file) name

In OGTemplate, an application asset is specified by its relative path (relative to the application package root)

btnExit = type:Sprite, GUItype:button, container:sceneGUI, texture:../GUI/button.gif // An image asset
textureFighter = type:Texture, src:../Images/Fighter.jpg // An image asset
grp3DEarth = type:Group3D, container:scene3D, model:models/Earth.3DS, ... // A 3D model asset
envMusic = type:Sound, src:../Sounds/music.wav // A sound asset

A name of another property defined in the same scope

sceneConsole = type:SceneSprite, x:0, y:0, width:240, height:320 // Defines a SceneSprite
btnExit = type:Sprite, container:sceneConsole, GUItype:BUTTON, pos:(0; 10) // References that SceneSprite

gameDifficultyLevel=type:CheckboxGroup, selected:1 // Define a check-box group
rdoRookie=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, ... // Make this check-box belong to that check-box group
rdoVeteran=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, ... // Make this check-box belong to that check-box group
rdoAce=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, ... // Make this check-box belong to that check-box group

A reference to another property definition (macro) defined earlier

TEXTURE_BTN = Button/button.png
TEXTURE_BTN_BRT= Button/buttonBright.png
BUTTON(w;h;text)= container:sceneGUI, GUIType:BUTTON, size:([w];[h]), text:[text], \
texture:{TEXTURE_BTN}, textureBright:{TEXTURE_BTN_BRT}, \
textureEdgeInset:(11;3;11;3), bitmapFont:bmpFontText, textAlignment:CENTER, textVAlignment:MIDDLE

btnBack = type:Sprite, {BUTTON(50;15;Back)}, GUItype:HYPERLINK, href:MainEntry.txt, posByRef:(15; 5; SCENE; POS_LEFTBOTTOM)
btnStartGame = type:Sprite, {BUTTON(50;15;Start)}, GUItype:BUTTON, posByRef:(15; 5; SCENE; POS_RIGHTBOTTOM), defaultFocus:1

Reference - OGTemplate Reserved Type

List of Reserved Type (Content Property)

Content properties are parsed and translated into application content. A property is parsed as content property when its attribute type is a reserved type defined by OGTemplate. The following chart show all OGTemplate's reserved types (click the reserved type link for more details):

Reserved Type	Definition
type:PageSetting	Declares the default page settings for a OGCanvas
type:SceneSprite	Loads a SceneSprite into OGCanvas
type:Sprite	Loads a Sprite into SceneSprite
type:DebugSprite	Loads a Sprite into SceneSprite only under `DEBUG` build (for debug only)
type:Scene3D	Loads a Scene3D into OGCanvas
type:Group3D	Loads a Group3D into Scene3D
type:Chip3D	Loads a Chip3D into Scene3D
type:Box3D	Loads a Box3D into Scene3D
type:Fog	Loads a Scene3D::Fog into Scene3D
type:Light	Loads a Light into Scene3D
type:LOD	Loads a LOD (level of detail) for a Group3D
type:Texture	Loads a Texture resource into OGCanvas
type:BitmapFont	Loads a BitmapFont resource into OGCanvas
type:Sound	Loads a Sound resource into OGCanvas
type:ComplexParameter	Loads a property as a complex parameter.

page

type:PageSetting - Defines Default Page Settings

Default:

False

scene

type:SceneSprite / type:Scene3D - Loading a 2D / 3D Scene

Default:

(0.f; 1.f; 0.f)

sprite

type:Sprite / type:DebugSprite - Loading a Sprite

Default:

Default:

LEFT_TOP

Background and Frame effect:

0pt

Text related:

text

Sets the text of the target Sprite , specified by a string.

Note For text contains reserved OGTemplate separator tokens (see Template structure and syntax), one of the following solutions can be used:

Use OGTemplate escape characters to encode the reserved OGTemplate separator tokens.

Escape Token   | Decoded Character |Note
---------------------------------------------------------
^c             | ':'               | colon
^cm            | ','               | comma
^sc            | ';'               | semi-comma
^q             | '"'               | quotation mark
^op            | '('               | opening parentheses
^cp            | ')'               | closing parentheses
^fs            | '/'               | forward slash
^bs            | '\'               | backward slash
^sp            | ' '               | one space character
^2sp           | '  '              | two space characters
               |                   |     
^n or \n       | \x0A              | new-line character
^tab           | \x09              | horizontal tab character
               |                   |     
^-             | nothing           | dummy escape code translated
               |                   | into nothing, used to
               |                   | separate two adjacent
               |                   | characters to avoid them
               |                   | from forming an escape code

Put the whole text string inside a pair of quotation marks ("..."). This solution does not work if the text string itself contains quotation mark.
Use function Sprite::setText() to set the sprite text programmatically. In this case, the passed-in text can be straightly assigned to the sprite without encoding applied.

texture

A Texture assigned to the target Sprite used to render its texture (background picture) under normal state , specified by a texture asset path or a texture object defined by another property.
See Sprite::texture

Syntax:

texture:asset texture:property #### Examples: # textureObj = type:Texture, src:themeBkg.png // Define a texture object
sptSample1 = type:Sprite, container:sceneMain, ..., texture:level5/texture/smileIcon.png, ... // Apply texture by a texture asset path
sptSample2 = type:Sprite, container:sceneMain, ..., texture:textureObj, ... // Apply texture by a texture object

Default:

tokenType

(0; 0)

Theme related effect:

themeType

Sets the theme type of the target Sprite , specified by one of theme type constants. See Sprite::setThemeType()
See Sprite::getThemeType()
See SpriteTheme::THEME_GUI_TYPE

Syntax:

GUIType:theme type constants

Examples:

themeType:THEME_BUTTON
themeType:THEME_EDITBOX
themeType:THEME_FRAME

Default:

Default:

ANYTHING

LWComponent Dedicated:

className

Provides the detailed class information of the target LWComponent Sprite .
This attribute is dedicated to loading a LWComponent into container OGCanvas . To make this attribute take effect, the other attribute GUIType must have value set to GUI_LWCOMPONENT, which indicated a light-weight component will be created instead of a regular sprite.

The detailed class information is provided by complex parameters with all arguments passed in the specific orders, as shown in the sample code.
Developer should refer to Reference - LWComponent Class Signature for more details.

Syntax:

className: (argument1; argument2; argument3; ...)

Examples:

Default:

Default:

True

Value / State related:

persistent

Sets whether the value maintained by the target interactive Sprite will be persistent across application sessions.
Caution This attribute has no effect if the target sprite is not an interactive sprite.
See Sprite
See Sprite::persistent
See Sprite::GUI_SPRITE_TYPE

Syntax:

persistent:boolean

Examples:

persistent:TRUE
persistent:false
persistent:1
persistent:0

Default:

False

CheckboxGroup

type:CheckboxGroup - Defining a checkbox group

PropName = type:CheckboxGroup, (more attributes), ...

selected

This attribute sets which checkbox Sprite in the checkbox group is currently selected.
The attribute is specified by a integer value that is the zero-based index of the current selected checkbox.
Note In Pooka SDK® application, there is no dedicated "radio button" sprite, checkbox sprites belongs to a CheckboxGroup work as radio buttons.
See Sprite::GUI_CHECKBOX
See OGCanvas::setCheckboxGroupSelection()
See OGCanvas::getCheckboxGroupSelection()
See Attribute group in OGTemplate reserved type Sprite.

Syntax:

selected:integer

Examples:

gameDifficultyLevel=type:CheckboxGroup, selected:1 rdoRookie=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, persistent:true, ...
rdoVeteran=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, persistent:true, ...
rdoAce=type:Sprite, GUIType:CHECKBOX, group:gameDifficultyLevel, persistent:true, ...

Default:

Examples:

textureSingleFrame:TRUE
textureSingleFrame:false
textureSingleFrame:1
textureSingleFrame:0

Default:

Examples:

bkgColor:(255; 128; 0)
bkgColor:#FF8000
bkgColor:DARKBLUE

Default:

CLEAR

sound

type:Sound - Loading a Sound

PropName = type:Sound, (more attributes), ...

src

The source of the target Sound to be loaded into the container OGCanvas , specified by a sound asset.
Note The value must be a valid asset path. If the specified sound source can not be found, the target sound will not be loaded.
See Sound

Syntax:

src:sound asset

Examples:

soundMusic = type:Sound, src:sounds/common/ambientMusic.wav

Default:

Examples:

cullingPolicy:CULLING_ON_OBJECT

Default:

Default:

Default:

Examples:

color:(255; 240; 220)
color:LIGHTGRAY

Default:

WHITE

3D light

type:Light - Loading 3D Light

PropName = type:Light, (more attributes), ...

dir

The direction of the target directional light , specified by complex value with three float vaues.
See Light
See Light::direction

Syntax:

dir:(float x; float y; float z)

Examples:

dirLight = type:Light, container:scene3D, dir:(0.5f; -0.5f; -0.2f), color:WHITE

Default:

(0.f; 0.f; 0.f)

color

The color of the target directional light in 24-bit R8G8B8 format, specified by complex parameters, hexadecimal value or a color constant.
Note In the current version OGTemplate, attribute color set the color value for both Light::diffuse and Light::specular .
See Light
See Light::diffuse
See Light::specular

Syntax:

color:hexadecimal
color:color constant
color:(int red; int green; int blue)

Examples:

color:(255; 240; 220)
color:LIGHTGRAY

Default:

Examples:

LODHouse = type:LOD, container:grpHouse, levelNum:3, segment:10.f, model:(models/house_high.3DS; models/house_medium.3DS; models/house_low.3DS), \
radius:50.f, unwantedObjectsWhenNormalize:SwimmingPool Driveway

Default:

NULL

Complex Parameter

type:ComplexParameter - Loading a complex parameter

PropName = type:ComplexParameter, (more attributes), ...

value

Sets the value of the target complex parameter. The value is assigned by a string and must be in extact format regarding to the usage of the target complex parameter.
There are only two usages of Complex Parameter in the current version Pooka SDK®:

Provides tool item definition for loading a LWToolBox, each property defines one tool item in LWToolBox
Provides menu item definition for loading a tag_LWMenu, each property defines one menu item in tag_LWMenu

Syntax:

value:string

Used as tool item definition for loading a LWToolBox:
value: (

string ; asset ; asset ; int ; int ; int ; int ; int ; int ; int ; int ; int ;

)

Used as menu item definition for loading a LWMenu:
value: (

int ; string ; asset ; asset ; int ; int ; int ; int ; int ; int

)

Examples:

Used as tool item definition for loading a LWToolBox:
ICON_TEXTURE = textureIconSet; textureIconSetBright
toolParaNew = type:ComplexParameter, value:(New; {ICON_TEXTURE}; 160; 128; 32; 32; center; 10; 10; 0; 0)
toolParaOpen = type:ComplexParameter, value:(Open; {ICON_TEXTURE}; textureIconsBright; 32; 192; 32; 32; center; 10; 10; 0; 0)
toolParaSave = type:ComplexParameter, value:(Save; {ICON_TEXTURE}; textureIconsBright; 0; 96; 32; 32; center; 10; 10; 0; 0)
toolParaExit = type:ComplexParameter, value:(Exit; {ICON_TEXTURE}; textureIconsBright; 192; 192; 32; 32; center; 10; 10; 0; 0)

Used as menu item definition for loading a LWMenu:
MENU_TEXTURE = textureIconSet; textureIconSetBright

menuFile = type:ComplexParameter, value:(SUBMENU; File; {MENU_TEXTURE}; 32; 0; 32; 32; comSubmenuFile)
menuEdit = type:ComplexParameter, value:(SUBMENU; Edit; {MENU_TEXTURE}; 64; 0; 32; 32; comSubmenuEdit)
menuTool = type:ComplexParameter, value:(SUBMENU; Tool; {MENU_TEXTURE}; 0; 0; 32; 32; comSubmenuTool)

menuNew = type:ComplexParameter, value:(ACTION; New; {MENU_TEXTURE}; 160; 128; 32; 32)
menuOpen = type:ComplexParameter, value:(ACTION; Open; {MENU_TEXTURE}; 32; 192; 32; 32)
menuSave = type:ComplexParameter, value:(ACTION; Save)
menuClose = type:ComplexParameter, value:(ACTION; Close)

menuFlatStyle = type:ComplexParameter, value:(CHECKBOX; Flat Style; NULL; NULL; -1; -1; -1; -1; FALSE)
menuShineAndShade = type:ComplexParameter, value:(CHECKBOX; Shine & Shade^n; NULL; NULL; -1; -1; -1; -1; TRUE)

menuThemePooka = type:ComplexParameter, value:(RADIOBUTTON; Theme Pooka; NULL; NULL; -1; -1; -1; -1; FALSE; grpThemeType)
menuThemeAmber = type:ComplexParameter, value:(RADIOBUTTON; Theme Amber; NULL; NULL; -1; -1; -1; -1; FALSE; grpThemeType)
menuThemeLime = type:ComplexParameter, value:(RADIOBUTTON; Theme Lime; NULL; NULL; -1; -1; -1; -1; TRUE; grpThemeType)
menuThemeMauve = type:ComplexParameter, value:(RADIOBUTTON; Theme Mauve^n; NULL; NULL; -1; -1; -1; -1; FALSE; grpThemeType)

Default:

N/A

Reference - LWComponent Class Signature

To load a Pooka SDK® built-in LWComponent by OGTemplate, detailed class information about the component need to be provided. The class infomration describes how the component should look like and how it behaves. The class signature consist of numbers of arguments passed in specific order, like the list-box component loaded by the following code:

LWConsole

Syntax:

className:LWConsole (

int ; int ; boolean ; boolean ; int ; int ; boolean

)

Examples:

comConsole2 = type:Sprite, container:sceneComponent, GUIType:LWCOMPONENT, \
                pos:(10;135), size:(210;100), \
                className:LWConsole(512;            // maximum line number for console's stream mode
                                    8;              // size of the text font
                                    FALSE;          // whether to use accordion style scroll bar
                                    TRUE;           // whether to use thin scroll bar
                                    YELLOW;         // default text color
                                    BLACK;          // background color
                                    TRUE)           // to wrapping text for stream mode

LWListPane

Syntax:

className:LWListPane (

int ; int[] ; int[] ; int[] ; int[] ; int ; int ; boolean ; boolean ; boolean

)

Examples:

comListPane2 = type:Sprite, container:sceneComponent, GUIType:LWCOMPONENT, \
        x:10, y:145, width:200, height:90, \
        className:LWListPane(   VERTICAL;       // layout type
                                25|25|25;       // width of each item for three view types (ICON, LIST, DETAIL)
                                25|25|25;       // height of each item for three view types (ICON, LIST, DETAIL)
                                2|2|2;          // horizontal padding of each item for three view types (ICON, LIST, DETAIL)
                                2|2|2;          // vertical padding of each item for three view types (ICON, LIST, DETAIL)
                                AS_SELECTION;   // type of the item usage
                                DARKGRAY;       // background color
                                TRUE;           // whether to use accordion style scroll bar
                                TRUE;           // whether to use thin (smaller) buttons
                                FALSE)          // whether to sort items

LWToolBox

Syntax:

className:LWToolBox (

int ; int ; int property[] .

)

Examples:

comToolBox2 = type:Sprite, container:sceneComponent, GUIType:LWCOMPONENT, \
                x:90, y:10, width:120, height:18, \
                className:LWToolBox(HORIZONTAL;         // layout type
                                    1;                  // the line number of the tools
                                    3;                  // the spacing between each tools
                                    toolParaNew|toolParaOpen|toolParaSave|toolParaExit) // the definition of all tool items
// Complex Parameter defines a Tool
// value:(string label; asset icon; asset iconBright; int iconClipX; int iconClipY; int iconClipW; int iconClipH; int iconAlignment; int iconWidth; int iconHeight; int iconOffsetX; int iconOffsetY)
toolParaNew =       type:ComplexParameter, value:(New; buttonIcons; buttonIconsBright; 160; 128; 32; 32; center; 10; 10; 0; 0)
toolParaOpen =      type:ComplexParameter, value:(Open; buttonIcons; buttonIconsBright; 32; 192; 32; 32; center; 10; 10; 0; 0)
toolParaSave =      type:ComplexParameter, value:(Save; buttonIcons; buttonIconsBright; 0; 96; 32; 32; center; 10; 10; 0; 0)
toolParaExit =      type:ComplexParameter, value:(Exit; buttonIcons; buttonIconsBright; 192; 192; 32; 32; center; 10; 10; 0; 0)

LWMenu

Syntax:

className:LWMenu (

int ; int ; int ; int ; property[] .

)

Examples:

comMainMenu = type:Sprite, container:sceneComponent, GUIType:LWCOMPONENT, \
            className:LWMenu(   HORIZONTAL;     // layout type
                                MAIN_MENU;      // type of the menu
                                30;             // width of the menu item
                                -1;             // the maximum displayed menu item number in a menu
                                menuFile|menuEdit|menuTool|menuWindow|menuHelp) // the definition of all menu items
MENU_TEXTURE = buttonIcons; buttonIconsBright   // a convenience macro
// Complex Parameter defines a menu item
// value:(int menuItemType; string label; asset icon; asset iconBright; int iconClipX; int iconClipY; int iconClipW; int iconClipH; int Extra Para 1; int Extra Para 2)
menuFile =      type:ComplexParameter, value:(SUBMENU; File; {MENU_TEXTURE}; 32; 0; 32; 32; comSubmenuFile)
menuEdit =      type:ComplexParameter, value:(SUBMENU; Edit; {MENU_TEXTURE}; 64; 0; 32; 32; comSubmenuEdit)
menuTool =      type:ComplexParameter, value:(SUBMENU; Tool; {MENU_TEXTURE}; 0; 0; 32; 32; comSubmenuTool)
menuWindow =    type:ComplexParameter, value:(SUBMENU; Window; {MENU_TEXTURE}; 96; 0; 32; 32; comSubmenuWindow)
menuHelp =      type:ComplexParameter, value:(SUBMENU; Help; {MENU_TEXTURE}; 192; 0; 32; 32; comSubmenuHelp)

Reference - OGTemplate Constants

Boolean Value Constants

Boolean value constants are used to be the meaningful alternative to indicate a boolean value 1 and 0. Each boolean constant is equivalent to one boolean value 1 or 0, use them properly can improve OGTemplate's readability.

FALSE / false

Equivalent to 0 and indicates boolean false.

TRUE / true

Equivalent to 1 and indicates boolean true.

NORMAL

Equivalent to 0 and indicates boolean false. Better used for Sprite 's attribute state.

Examples:

sptButtterfly = type:Sprite, ..., state:NORMAL

ACTIVE

Equivalent to 1 and indicates boolean true. Better used for Sprite 's attribute state.

Examples:

sptButtterfly = type:Sprite, ..., state:ACTIVE

UNCHECKED

Equivalent to 0 and indicates boolean false. Better used for editbox Sprite 's attribute state.

Examples:

detailLevel = type:CheckboxGroup, selected:2 chkDetailLevelLow = type:Sprite, ..., state:UNCHECKED, pos:(5;85), text:^spLow
chkDetailLevelParticle = type:Sprite, ..., state:UNCHECKED, pos:(40;85), text:^spParticle
chkDetailLevelNormal = type:Sprite, ..., state:CHECKED, pos:(5;95), text:^spNormal
chkDetailLevelHigh = type:Sprite, ..., state:UNCHECKED, pos:(40;95), text:^spHigh
chkDetailLevelMax = type:Sprite, ..., state:UNCHECKED, pos:(5;105), text:^spMax

CHECKED

Equivalent to 1 and indicates boolean true. Better used for editbox Sprite 's attribute state.

Examples:

detailLevel = type:CheckboxGroup, selected:2 chkDetailLevelLow = type:Sprite, ..., state:UNCHECKED, pos:(5;85), text:^spLow
chkDetailLevelParticle = type:Sprite, ..., state:UNCHECKED, pos:(40;85), text:^spParticle
chkDetailLevelNormal = type:Sprite, ..., state:CHECKED, pos:(5;95), text:^spNormal
chkDetailLevelHigh = type:Sprite, ..., state:UNCHECKED, pos:(40;95), text:^spHigh
chkDetailLevelMax = type:Sprite, ..., state:UNCHECKED, pos:(5;105), text:^spMax

Position Constants

CENTER

Make the target Scene or Sprite centered in the container OGCanvas or SceneSprite

Scene Size Constants

VIRTUAL_SCREEN_WIDTH

The width of the VirtualDevice in points1. See Pooka::Core::MiniAWT::VirtualDevice::screenWidth.

VIRTUAL_SCREEN_HEIGHT

The height of the VirtualDevice in points1. See Pooka::Core::MiniAWT::VirtualDevice::screenHeight.

VIRTUAL_SCREEN_SHORT_SIDE

The shorter side's length of the VirtualDevice in points1. See Pooka::Core::MiniAWT::VirtualDevice::screenShortSide.

VIRTUAL_SCREEN_LONG_SIDE

The longer side's length of the VirtualDevice in points1. See Pooka::Core::MiniAWT::VirtualDevice::screenLongSide.

Color Constants

Constants define the common color values, same as the constants defined in Color class.

CLEAR

clear, used for elements (such as background) that neede complete transparency

BLACK

Black (#000000)

WHITE

Black (#FFFFFF)

LIGHTGRAY

Light Gray (#C0C0C0)

GRAY

Gray (#808080)

DARKGRAY

Dark Gray (#404040)

RED

Red (#FF0000)

GREEN

Green (#00FF00)

BLUE

Blue (#0000FF)

YELLOW

Yellow (#FFFF00)

MAGENTA

Magenta (#FF00FF)

CYAN

Cyan (#00FFFF)

DARKRED

Dark Red (#800000)

DARKGREEN

Dark Green (#008000)

DARKBLUE

Dark Blue (#000080)

DARKYELLOW

Dark Yellow (#808000)

DARKMAGENTA

Dark Magenta (#800080)

DARKCYAN

Dark Cyan (#008080)

LIGHTRED

Light Red (#FF8080)

LIGHTGREEN

Light Green (#80FF80)

LIGHTBLUE

Light Blue (#8080FF)

LIGHTYELLOW

Light Yellow (#FFFF80)

LIGHTMAGENTA

Light Magenta (#FF80FF)

LIGHTCYAN

Light Cyan (#80FFFF)

Relative Position Constants

Constants define the relative positioning mode, used in attributes posByRef.

POS_CENTER

Indicates the target's (Scene or Sprite ) relative position is centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_CENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_H_CENTER

Indicates the target's (Scene or Sprite ) relative position is horizontally centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_H_CENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_V_CENTER

Indicates the target's (Scene or Sprite ) relative position is vertically centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_V_CENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_LEFT

Indicates the target's (Scene or Sprite ) relative position is left-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_LEFT and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_RIGHT

Indicates the target's (Scene or Sprite ) relative position is right-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_RIGHT and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_TOP

Indicates the target's (Scene or Sprite ) relative position is top-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_TOP and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_BOTTOM

Indicates the target's (Scene or Sprite ) relative position is bottom-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_BOTTOM and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_LEFTTOP

Indicates the target's (Scene or Sprite ) relative position is left-top-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_LEFTTOP and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_RIGHTTOP

Indicates the target's (Scene or Sprite ) relative position is right-top-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_RIGHTTOP and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_LEFTBOTTOM

Indicates the target's (Scene or Sprite ) relative position is left-bottom-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_LEFTBOTTOM and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_RIGHTBOTTOM

Indicates the target's (Scene or Sprite ) relative position is right-bottom-aligned to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_RIGHTBOTTOM and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_LEFTCENTER

Indicates the target's (Scene or Sprite ) relative position is left-aligned and horizontally centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_LEFTCENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_RIGHTCENTER

Indicates the target's (Scene or Sprite ) relative position is right-aligned and horizontally centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_RIGHTCENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_TOPCENTER

Indicates the target's (Scene or Sprite ) relative position is top-aligned and vertically centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_TOPCENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

POS_BOTTOMCENTER

Indicates the target's (Scene or Sprite ) relative position is bottom-aligned and vertically centered to the specified reference (OGCanvas , Scene or Sprite ).
See Scene::RELATIVE_POS_BOTTOMCENTER and functions Scene::setPositionByRef() / Sprite::setPositionByRef()

Relative Size Constants

Constants define the relative sizing mode, used in attributes sizeByRef.

SIZE_POINT

Indicates the target's (Scene or Sprite ) relative size is measured by the specified reference's (OGCanvas , Scene or Sprite ) size and a margin thickness, all in points1.
See Scene::RELATIVE_SIZE_BY_PIXEL and functions Scene::setSizeByRef() / Sprite::setSizeByRef()

SIZE_PERCENT

Indicates the target's (Scene or Sprite ) relative size is measured by the specified reference's (OGCanvas , Scene or Sprite ) size and a margin thickness, all in percents.
See Scene::RELATIVE_SIZE_BY_PERCENTAGE and functions Scene::setSizeByRef() / Sprite::setSizeByRef()

Relative Size/Position Reference Constants

Constants define the reference when doing relative positioning or sizing, used in attributes posByRef or sizeByRef.

CANVAS

Designate an OGCanvas as the reference when assigning relative size or position of a Scene or Sprite .
See Scene::RELATIVE_TO_CANVAS and functions Scene::setSizeByRef() / Sprite::setSizeByRef() / Scene::setPositionByRef() / Sprite::setPositionByRef()

SCENE

Designate an Scene as the reference when assigning relative size or position of a Scene or Sprite .
See Scene::RELATIVE_TO_SCENE and functions Scene::setSizeByRef() / Sprite::setSizeByRef() / Scene::setPositionByRef() / Sprite::setPositionByRef()

SPRITE

Designate an Sprite as the reference when assigning relative size or position of a Scene or Sprite .
See Scene::RELATIVE_TO_SPRITE and functions Scene::setSizeByRef() / Sprite::setSizeByRef() / Scene::setPositionByRef() / Sprite::setPositionByRef()

Keyboard Navigation Mode Constants

Constants define the keyboard navigation mode of SceneSprite , used in attribute navigationMode.

DISABLED

Constant indicates disabled keyboard navigation (keyboard navigation is unavailable).
See SceneSprite::NAVIGATION_DISABLED

INDEX_MODE

Constant indicates the index based keyboard navigation mode.
See SceneSprite::NAVIGATION_INDEXENTRY

TAB_MODE

Constant indicates the tab based keyboard navigation mode.
See SceneSprite::NAVIGATION_TAB

Keyboard TAB Navigation Method Constants

Constants define the TAB navigation method of SceneSprite , used in attribute tabMethod.

TAB_NAVIGATION

This direction-mode makes Tab navigation performed by clicking Tab key or Shift+Tab.
See SceneSprite::TAB_NAVIGATION

FOUR_WAY_NAVIGATION

This direction-mode performs Tab navigation by clicking four-way direction keys (Left, Right, Up, Down) and Enter key.
See SceneSprite::FOUR_WAY_NAVIGATION

X_NAVIGATION

This direction-mode performs Tab navigation by clicking horizontal direction keys (Left, Right) and Enter key.
See SceneSprite::X_NAVIGATION

Y_NAVIGATION

This direction-mode performs Tab navigation by clicking vertical direction keys (Up, Down) and Enter key.
See SceneSprite::Y_NAVIGATION

Anchor Type Constants

Constants define the anchor type or alignment type in Sprite , used in attributes anchorPoint and textureAlignment.

LEFT_TOP

Indicates the anchor point is at the left-top corner of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

RIGHT_TOP

Indicates the anchor point is at the right-top corner of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

LEFT_BOTTOM

Indicates the anchor point is at the left-bottom corner of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

RIGHT_BOTTOM

Indicates the anchor point is at the right-bottom corner of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

TOP_CENTER

Indicates the anchor point is at the top-side-center of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

BOTTOM_CENTER

Indicates the anchor point is at the bottom-side-center of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

LEFT_CENTER

Indicates the anchor point is at the left-side-center of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

RIGHT_CENTER

Indicates the anchor point is at the right-side-center of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

CENTER

Indicates the anchor point is at the center of the Sprite's bounding box.
See Sprite::POSITION_ANCHORPOINT_TYPE

Frame Bevel Type Constants

Constants define the frame bevel of a Sprite , used in attributes frameBevel and `frameBevelBright.

NONE

No frame bevel.
See GraphicsEngine::FRAME_BEVEL_TYPE

RAISED

The raised frame bevel.
See GraphicsEngine::FRAME_BEVEL_TYPE

SUNKEN

The sunken frame bevel.
See GraphicsEngine::FRAME_BEVEL_TYPE

RIDGE

The ridge frame bevel.
See GraphicsEngine::FRAME_BEVEL_TYPE

GROOVE

The groove frame bevel.
See GraphicsEngine::FRAME_BEVEL_TYPE

Text Horizontal Alignment Type Constants

Constants define the horizontal text alignment of a Sprite , used in attribute textAlignment.

LEFT

Text horizontal left-aligned mode.
See Sprite::ALIGN_LEFT

CENTER

Text horizontal center-aligned mode.
See Sprite::ALIGN_CENTER

RIGHT

Text horizontal right-aligned mode.
See Sprite::ALIGN_RIGHT

Text Vertical Alignment Type Constants

Constants define the vertical text alignment of a Sprite , used in attribute textVAlignment.

TOP

Text vertical top-aligned mode.
See Sprite::ALIGN_V_TOP

MIDDLE

Text vertical middle-aligned mode.
See Sprite::ALIGN_V_MIDDLE

BOTTOM

Text vertical bottom-aligned mode.
See Sprite::ALIGN_V_BOTTOM

Sprite Token Type Constants

Constants define the token type of a Sprite , used in attribute tokenType.

TOKEN_TRIANGLE_LEFT

Leftwards triangle token.
See TokenSprite::TOKEN_TRIANGLE_LEFT

TOKEN_TRIANGLE_RIGHT

Rightwards triangle token.
See TokenSprite::TOKEN_TRIANGLE_RIGHT

TOKEN_TRIANGLE_UP

Upwards triangle token.
See TokenSprite::TOKEN_TRIANGLE_UP

TOKEN_TRIANGLE_DOWN

Downwards triangle token.
See TokenSprite::TOKEN_TRIANGLE_DOWN

TOKEN_ARROW_LEFT

Leftwards arrow token.
See TokenSprite::TOKEN_ARROW_LEFT

TOKEN_ARROW_RIGHT

Rightwards arrow token.
See TokenSprite::TOKEN_ARROW_RIGHT

TOKEN_ARROW_UP

Upwards arrow token.
See TokenSprite::TOKEN_ARROW_UP

TOKEN_ARROW_DOWN

Downwards arrow token.
See TokenSprite::TOKEN_ARROW_DOWN

TOKEN_H_CURSOR

Horizontal cursor token.
See TokenSprite::TOKEN_H_CURSOR

TOKEN_V_CURSOR

Vertical cursor token.
See TokenSprite::TOKEN_V_CURSOR

TOKEN_DOT

Symbol dot token.
See TokenSprite::TOKEN_DOT

TOKEN_BOX

Symbol box token.
See TokenSprite::TOKEN_BOX

TOKEN_HOLLOW_BOX

Symbol hollow box token.
See TokenSprite::TOKEN_HOLLOW_BOX

TOKEN_X

Symbol "X" token.
See TokenSprite::TOKEN_X

TOKEN_INFO

Symbol "info" token.
See TokenSprite::TOKEN_INFO

TOKEN_EXCLAMATION

Symbol "!" token.
See TokenSprite::TOKEN_EXCLAMATION

TOKEN_CHECK

Check mark token.
See TokenSprite::TOKEN_CHECK

TOKEN_NODE_FOLDED

Folded (collapsed) node token.
See TokenSprite::TOKEN_NODE_FOLDED

TOKEN_NODE_EXPANDED

Expanded node token.
See TokenSprite::TOKEN_NODE_EXPANDED

TOKEN_CHECKBOX

Check box token.
See TokenSprite::TOKEN_CHECKBOX

TOKEN_RADIOBUTTON

Radio button token.
See TokenSprite::TOKEN_RADIOBUTTON

TOKEN_CHECKBOX_SIMPLE

Simplified check box token.
See TokenSprite::TOKEN_CHECKBOX_SIMPLE

TOKEN_RADIOBUTTON_SIMPLE

Simplified radio button token.
See TokenSprite::TOKEN_RADIOBUTTON_SIMPLE

TOKEN_ELLIPSIS

Symbol "..." token.
See TokenSprite::TOKEN_ELLIPSIS

TOKEN_PLUS

Symbol "+" token.
See TokenSprite::TOKEN_PLUS

TOKEN_MINUS

Symbol "-" token.
See TokenSprite::TOKEN_MINUS

Sprite GUI Type Constants

Constants define the GUI (graphical user interface) type of a Sprite , used in attribute GUIType.

STATIC

static content such as text, picture, information, etc.
See Sprite::GUI_STATIC

BUTTON

static content such as text, picture, information, etc.
See Sprite::GUI_BUTTON

CHECKBOX

static content such as text, picture, information, etc.
See Sprite::GUI_CHECKBOX

HYPERLINK

static content such as text, picture, information, etc.
See Sprite::GUI_HYPERLINK

TIPLINK

static content such as text, picture, information, etc.
See Sprite::GUI_TIPLINK

EDITBOX

static content such as text, picture, information, etc.
See Sprite::GUI_EDITBOX

LWCOMPONENT

static content such as text, picture, information, etc.
See Sprite::GUI_LWCOMPONENT

Hyper-link Destination Constants

REFERRAL

This constant is translated into the loading referral URL, which is the full OGTemplate asset path who is considered the referral to the current OGTemplate. When application user clicks a hyper-link Sprite with attribute href set by constant REFERRAL, the previous OGTemplate who loads the current OGTemplate will be opened.
See OGCanvas::loadTemplate

Examples:

btnBack=type:Sprite, GUIType:HYPERLINK, href:REFERRAL, container:SceneGUI, ...

Editbox Input Type Constants

Constants define the input type of an editbox Sprite , used in attribute inputType.

NATURAL_NUMBER

Indicates the editbox accepts natural numbers, including number 0.
See Sprite::EDITBOX_NATURAL_NUMBER

WHOLE_NUMBER

Indicates the editbox accepts [whole numbers] (positive integer)](https://en.wikipedia.org/wiki/List_of_types_of_numbers).
See Sprite::EDITBOX_WHOLE_NUMBER

INTEGER

Indicates the sprite-editbox accepts integer.
See Sprite::EDITBOX_INTEGER

REAL_NUMBER

Indicates the sprite-editbox accepts real numbers.
See Sprite::EDITBOX_REAL_NUMBER

ALPHANUMERIC

Indicates the sprite-editbox accepts POSIX/C Alphanumeric characters.
See Sprite::EDITBOX_ALPHANUMERIC

ANYTHING

Indicates the sprite-editbox accepts any characters.
See Sprite::EDITBOX_ANYTHING

Theme Type Constants

Constants define the theme type of a Sprite . See "Un-themed Sprite vs Themed Sprite" in class Sprite for more details.

THEME_UNTHEMED

Theme type makes sprite rendered without theme.
See SpriteTheme::THEME_GUI_UNTHEMED

THEME_STATIC

Theme type makes sprite rendered like a static UI element.
See SpriteTheme::THEME_GUI_STATIC

THEME_LABEL

Theme type makes sprite rendered like a label.
See SpriteTheme::THEME_GUI_LABEL

THEME_BUTTON

Theme type makes sprite rendered like a button.
See SpriteTheme::THEME_GUI_BUTTON

THEME_PUSHBUTTON

Theme type makes sprite rendered like a push-button.
See SpriteTheme::THEME_GUI_PUSHBUTTON

THEME_HYPERLINK

Theme type makes sprite rendered like a hyper-link.
See SpriteTheme::THEME_GUI_HYPERLINK

THEME_EDITBOX

Theme type makes sprite rendered like a edit-box.
See SpriteTheme::THEME_GUI_EDITBOX

THEME_CHECKBOX

Theme type makes sprite rendered like a check-box.
See SpriteTheme::THEME_GUI_CHECKBOX

THEME_RADIOBUTTON

Theme type makes sprite rendered like a radio-button.
See SpriteTheme::THEME_GUI_RADIOBUTTON

THEME_TRACK

Theme type makes sprite rendered like a static track.
See SpriteTheme::THEME_GUI_TRACK

THEME_BAR

Theme type makes sprite rendered like a static bar.
See SpriteTheme::THEME_GUI_BAR

THEME_TABLEHEADER

Theme type makes sprite rendered like a table header.
See SpriteTheme::THEME_GUI_TABLEHEADER

THEME_TABLECELL

Theme type makes sprite rendered like a table cell.
See SpriteTheme::THEME_GUI_TABLECELL

THEME_LISTITEM

Theme type makes sprite rendered like a generic list item element.
See SpriteTheme::THEME_GUI_LISTITEM

THEME_BACKGROUND

Theme type makes sprite rendered like a generic background element.
See SpriteTheme::THEME_GUI_BACKGROUND

THEME_FRAME

Theme type makes sprite rendered like a generic frame element.
See SpriteTheme::THEME_GUI_FRAME

Special Navigation Index Constants

Constants define special keyboard navigation index.
See SceneSprite::KEYBOARD_NAVIGATION_MODE

LEFT

One of the special keyboard navigation indices. When application user clicks the key LEFT , the target sprite will be virtually clicked.
See Sprite::setNavigationIndex()

RIGHT

One of the special keyboard navigation indices. When application user clicks the key RIGHT , the target sprite will be virtually clicked.
See Sprite::setNavigationIndex()

UP

One of the special keyboard navigation indices. When application user clicks the key UP , the target sprite will be virtually clicked.
See Sprite::setNavigationIndex()

DOWN

One of the special keyboard navigation indices. When application user clicks the key DOWN , the target sprite will be virtually clicked.
See Sprite::setNavigationIndex()

ENTER

One of the special keyboard navigation indices. When application user clicks the key ENTER , the target sprite will be virtually clicked.
See Sprite::setNavigationIndex()

3D Material Detail Level Constants

Constants define 3D material rendering detail level.
See Material3D::RENDERING_DETAIL_LEVEL
See Material3D::detailLevel

LOW_DETAIL

A low detail level.
See Material3D::LOW_DETAIL

PARTICLE_DETAIL

A particle detail level.
See Material3D::PARTICLE_DETAIL

NORMAL_DETAIL

A normal detail level.
See Material3D::NORMAL_DETAIL

HIGH_DETAIL

A high detail level.
See Material3D::HIGH_DETAIL

MAX_DETAIL

A maximum detail level.
See Material3D::MAX_DETAIL

3D Group Billboard Type Constants

Constants define 3D group billboard types.
See Group3D::BILLBOARD_TYPE
See Group3D::billboard

BILLBOARD_OFF

No billboard behavior.
See Group3D::BILLBOARD_OFF

BILLBOARD_ON_AXIS

Billboard behavior is performed along Y axis. This type of billboarding is usually used to create roughly symmetric objects such as trees.
See Group3D::BILLBOARD_ON_AXIS

BILLBOARD_ON_POINT

billboard behavior is performed on object's center point. This type of billboarding is usually used to create particle-like objects.
See Group3D::BILLBOARD_ON_POINT

3D Group Culling Policy Constants

Constants define branch-culling policies.
See Group3D::CLIPPING_POLICY
See Group3D::cullingPolicy

CULLING_OFF

No branch-culling.
See Group3D::CULLING_OFF

CULLING_ON_GROUP

Branch-culling is applied on every Group3D contained in Scene3D .
See Group3D::CULLING_ON_GROUP

CULLING_ON_OBJECT

Branch-culling is applied on every Object3D contained in Scene3D .
See Group3D::CULLING_ON_OBJECT

3D Chip orientation Constants

Constants define 3D Chip orientation types.
See Chip3D::CHIP_ORIENTATION

CHIP_ORIENTATION_X

Constant indicates the Chip3D is coplanar with Y-Z plane, i.e., orthogonal to X axis.
See Chip3D::CHIP_ORIENT_X

CHIP_ORIENTATION_Y

Constant indicates the Chip3D is coplanar with X-Z plane, i.e., orthogonal to Y axis.
See Chip3D::CHIP_ORIENT_Y

CHIP_ORIENTATION_Z

Constant indicates the Chip3D is coplanar with X-Y plane, i.e., orthogonal to Z axis.
See Chip3D::CHIP_ORIENT_Z

LWComponent Layout Type Constants

HORIZONTAL

Constant indicates the component layout suitable for size with horizontal orientation.
See LWComponent::LAYOUT_HORIZONTAL

VERTICAL

Constant indicates the component layout suitable for size with vertical orientation.
See LWComponent::LAYOUT_VERTICAL

COMPACT

Constant indicates the component layout favorable for tiny size.
See LWComponent::LAYOUT_COMPACT

LWLabel Background Type Constants

BACKGROUND_CLEAR

Constant indicates the target LWLabel has clear background.
See LWLabel::BACKGROUND_CLEAR

BACKGROUND_RAISED

Constant indicates the target LWLabel has solid-color background with raised frame bevel.
See LWLabel::BACKGROUND_RAISED

BACKGROUND_SUNKEN

Constant indicates the target LWLabel has solid-color background with sunken frame bevel.
See LWLabel::BACKGROUND_SUNKEN

LWListBox Item Sorting Policy Constants

UNSORTED

Constant indicates the target LWLabel has clear background.
See LWListBox::ITEM_UNSORTED

ASCENDING

Constant indicates the target LWLabel has solid-color background with raised frame bevel.
See LWListBox::ITEM_ASCENDING_SORT

DESCENDING

Constant indicates the target LWLabel has solid-color background with sunken frame bevel.
See LWListBox::ITEM_DESCENDING_SORT

LWComponent Expanding Policy Constants

LEFT_OR_UP

Constant indicates the component expands leftward or upward, depends on the component's layout direction.
See LWComponent::EXPAND_LEFT_UP

RIGHT_OR_DOWN

Constant indicates the component expands rightward or downward, depends on the component's layout direction.
See LWComponent::EXPAND_RIGHT_DOWN

LWComboBox Text-box Usage Constants

EXPAND_LIST

Indicates the combo-box's text-box is only used for expanding the drop-down list-box.
See LWComboBox::TEXTBOX_USAGE_EXPAND_LIST

ADD_ITEM

Indicates the combo-box's text-box can also be used for adding a new list item besides expanding the drop-down list-box.
See LWComboBox::TEXTBOX_USAGE_ADD_ITEM

FILTER_LIST

Indicates the combo-box's text-box can also be used for filtering the list items besides expanding the drop-down list-box.
See LWComboBox::TEXTBOX_USAGE_FILTER_LIST

LWScrollPane Scrollbar Type Constants

ALL

Indicates that the LWScrollPane has both horizontal and vertical scroll bars.
See LWScrollPane::SCROLLBAR_ALL

VERTICAL_ONLY

Indicates that the LWScrollPane only has vertical scroll bar.
See LWScrollPane::SCROLLBAR_VERTICAL_ONLY

HORIZONTAL_ONLY

Indicates that the LWScrollPane only has horizontal scroll bar.
See LWScrollPane::SCROLLBAR_HORIZONTAL_ONLY

NONE

Indicates that the LWScrollPane only has no scroll bars.
See LWScrollPane::SCROLLBAR_NONE

LWSplitPane Pane Size Mode Constants

FIXEDSIZE_SLIDING

Each of sub-panes takes the whole component space. When the divider is moved by application user, two sub-panes are moved together, one pane is slided in, while the other is slided out.
See LWSplitPane::PANE_FIXEDSIZE_SLIDING

FIXEDSIZE_OVERLAPPING

Each of sub-panes takes the whole component space. When the divider is moved by application user, one sub-pane overlap over the other sub-pane.
See LWSplitPane::PANE_FIXEDSIZE_OVERLAPPING

PANE_VARIABLESIZE

Tow sub-panes share the whole component space. The space used by one sub-pane is determined by the divider, when the divider is moved by application user, one sub-pane size is got expanded and the other is got squeezed.
See LWSplitPane::PANE_VARIABLESIZE

LWSlidingPane Paging Style Constants

GENERIC

Generic paging style
See LWSlidingPane::PAGING_GENERIC

HOMESCREEN

Home-screen style paging
See LWSlidingPane::PAGING_HOMESCREEN

EBOOK

Electronic-book style paging
See LWSlidingPane::PAGING_EBOOK

DOCUMENT

Electronic-document style paging
See LWSlidingPane::PAGING_DOCUMENT

PROGRAMMATIC

Programmatic paging style, which request coding to turn page
See LWSlidingPane::PAGING_PROGRAMMATIC

LWListPane Item Usage Type Constants

AS_ENTRY

Items are used as command entries, once clicked, the corresponding command will be executed.
See LWListPane::ITEM_USED_AS_ENTRY

AS_SELECTION

Items are used for selection. The selection can be either multi-choice selection or single-choice selection, depends on how user selects an item.
See LWListPane::ITEM_USED_AS_SELECTION

AS_MULTIPLE_CHOICE

Items are used for multi-choice selection.
See LWListPane::ITEM_USED_AS_MULTIPLE_CHOICE

AS_SINGLE_CHOICE

Items are used for single-choice selection.
See LWListPane::ITEM_USED_AS_SINGLE_CHOICE

LWMenu Menu Type Constants

MAIN_MENU

The main menu of an application.
See LWMenu::TYPE_MAIN_MENU

CONTEXT_MENU

The context menu, usually (but not required) brought out by right-click or long-press pointing device.
See LWMenu::TYPE_CONTEXT_MENU

SUB_MENU

The sub-menu owned by a parent menu and triggered by a menu item in its parent menu.
See LWMenu::TYPE_SUB_MENU

LWMenu Menu Item Type Constants

ACTION

The menu item is used to trigger an application-defined action.

SUBMENU

The menu item is used to show up a sub-menu.

CHECKBOX

The menu item is used as a check-box.

RADIOBUTTON

The menu item is used as a radio button, which belongs to a radio button group.

Notes

1 - When specify measurement related properties (position, size, thickness, font size, etc.) in OGTemplate, the unit is point; When specify these properties directly by class property in source code, the unit is pixel. See pixels and points in Developer Guide for more details.
For example, the following property line set the text font size of a sprite at 16 point, see textSize:16 in the code snippet.

sptPageTitle    = type:Sprite, container:sceneGUI, \
                textSize:16, \
                pos:(CENTER; 40), size:(240;20), textAlignment:CENTER, text: Select Golf Course

The sprite created by the OGTemplate may have its font size set to 16 pixels, 24 pixels, 32 pixels or any other numbers, depends on the real device's display size.

2 - When specify measurement in Bitmap coordinate system, the unit is pixel. See pixels and points in Developer Guide for more details.

Table of Contents

OmniGSoft Template Overview

About OmniGSoft Template

Template structure and syntax

Attribute Syntax

An OGTemplate Sample

EnterGame.txt

Common_header.txt

Using OGTemplate to organize application control flow

Reference - Attribute Value Rules

A text string

A primitive type

Boolean value

Integer value

hexadecimal value

float value

A complex value consists of numbers of parameters

An OGTemplate constants

An application asset (image, sound, template file) name

A name of another property defined in the same scope

A reference to another property definition (macro) defined earlier

Reference - OGTemplate Reserved Type

List of Reserved Type (Content Property)

type:PageSetting - Defines Default Page Settings

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

type:SceneSprite / type:Scene3D - Loading a 2D / 3D Scene

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples:

Default:

Syntax:

Examples: