Control Behaviors

Content List

• Construction Kit Control Behaviors
  
  • Map
    
    • Map
      
    • Map Bridge
      
  • Construction Kit Scroll Control Behaviors
    
    • List Behavior
      
    • Scrollbar
      
    • Scroll View
      
    • Snap List Item Configuration
    • Snap List Item Extension
    • SubList Behavior
      
  • Circular Slider Behavior
    
  • Drawer Behavior
    
• Internal Control Behaviors
  
  • Caret
    
  • Handle Control State
    
  • DataContext
    
  • Edit Text
    
  • Selection Group
    
• Public Property Control Behaviors
  
  • Provide Alignment
    
  • Copy Size
    
  • Provide Color
    
  • Provide Margin
    
  • Property Provider
    
  • Render Node
    
  • Provide Image
    
  • Set Layout
    

  • Limitations

  • Provide Text
    
• Align Pivot
  
• Android Event Bridge
  
• Arc Align
  
• Blend Mode
  
• Breadcrumb Behavior
  
• Disable Control
  
• Enable Control
  
• Event Bridge
  
• Focus
  
• Focus Leave
  
• Hover
  
• HoverLeave
  
• IntervalSwitch
  
• Keyboard Behavior
  
• Menu Item
  
• MenuScreen
  
• Navigation Instruction View
  
• OnClick
  
• OnPressed
  
• OnTimer
  
• Orbit Camera Transform
  
• Page Indicator
  
• Rectangle Clipping Behavior
  
• Roll
  
• Touch Indication Behavior
  
• Transform Mesh2D
  
• Event Handler
  
• Virtual Key

---

Construction Kit Control Behaviors

Map Control Behaviors

Map

Provides the map rendering and navigation functionality.

Common Properties

Back to the menu

Map Bridge

Builds a bridge to MapBehavior forwarding touch events.

Common Properties

Back to the menu

---

Scroll Control Behaviors

List Behavior

ListBehavior is a list supporting scrolling itemwise and pagewise combined with either relative or absolute scrolling.

About implicit roles of ChildNodes

The first child node is used as content (Group2D) and the second as scrollable (Scrollbar).

Common Properties

Back to the menu

Scrollbar

Reflects the position of the scrollable behavior. E.g. ListBehavior2D.

About implicit roles of ChildNodes

A variable number of child nodes is used to control the following features.

- background: a RenderNode2D used as background
- prevItem: a control to navigate to the previous item
- nextItem: a control to navigate to the next item
- prevPage: a control to navigate to the previous page
- nextPage: a control to navigate to the next page
- marker: a control used as a thumb

Depending on the number of provided child nodes, the nodes are interpreted as follows.

- 1 child: marker
- 2 children: background, marker
- 3 children: prevPage, nextPage, marker
- 4 children: background, prevPage, nextPage, marker
- 5 children: prevItem, nextItem, prevPage, nextPage, marker
- 6 children: background, prevItem, nextItem, prevPage, nextPage, marker

Common Properties

Back to the menu

Scroll View

Scroll View is a Touchable Control that has a ContentAnchor which can be filled with various content. Depending on the size of the content and the configured Scroll View's Layout Size, a horizontal and/or vertical scrollbar appears.

Because of the fact that Scroll View supports horizontal and vertical scrolling, it receives the ScrollableEvent from Send Scrollable Event Behavior (can also be forwarded from a Scrollbar Behavior Scrollbar via Event Bridge Behavior).

Example Usage

Common Properties

This behavior does not have any configurable properties.

About implicit roles of ChildNodes

The first child node is used as content (Group2D), the second as vertical scrollbar (Scrollbar) and the third as horizontal scrollbar (Scrollbar).

Back to the menu

Snap List Item Configuration

SnapListItemConfigurationBehavior defines the snap position of the list and/or list item.

Information on how to use this behavior can be found in the chaper of the List Control.

Common Properties

Property Name	Type	Description
ItemAlignment	SnapAlignmentOrientation::Enum	The location of the alignment base point within the list item. Possible values: Begin, Center, End
ItemAlignmentOffset	FeatStd::Float	The offset of the alignment point from the configured alignment base point. For End alignment a positive offset will move the alignment point from the list item end towards the list item begin.
ItemAlignmentOffsetInPercent	bool	The offset is either in percent (when set to true) or in pixel (when set to false). In case of percent the item size will be taken to calculate the pixel offset.

Back to the menu

Snap List Item Extension

SnapListItemExtensionBehavior registers a ListBehaviorExtension on the given ListBehavior for snapping the focused item to the configured list according to the snapping configuration of the list and the list item node.

Information on how to use this behavior can be found in the chaper of the List Control.

Common Properties

Property Name	Type	Description
ListBehavior	ListBehavior*	The ListBehavior that shall be extended. This property can be set in the right side of the Scene Tree Panel.
ListAlignment	SnapAlignmentOrientation::Enum	The location of the alignment base point within the list item. Possible values: Begin, Center, End
ListAlignmentOffset	FeatStd::Float	The offset of the alignment point from the configured alignment base point. For End alignment a positive offset will move the alignment point from the list item end towards the list item begin.
ListAlignmentOffsetInPercent	bool	The offset is either in percent (when set to true) or in pixel (when set to false). In case of percent the item size will be taken to calculate the pixel offset.
ItemAlignment	SnapAlignmentOrientation::Enum	The location of the alignment base point within the list item. Possible values: Begin, Center, End
ItemAlignmentOffset	FeatStd::Float	The offset of the alignment point from the configured alignment base point. For End alignment a positive offset will move the alignment point from the list item end towards the list item begin.
ItemAlignmentOffsetInPercent	bool	The offset is either in percent (when set to true) or in pixel (when set to false). In case of percent the item size will be taken to calculate the pixel offset.

Back to the menu

SubList Behavior

SubListBehavior extends the ListBehavior by special handling when being used in a child node of a ListBehavior.

SubListBehavior is a list supporting scrolling itemwise and pagewise combined with either relative or absolute scrolling.

Common Properties

Back to the menu

---

Circular Slider Behavior

This behavior provides the functionality of CircularSlider control by creating a radial mask and setting a rotation of knob node. This behavior is available for 2D scenes only.

Common Properties

Back to the menu

Drawer Behavior

The Drawer is a Layouting Behavior that can hide or show its content via Events or Touch Inputs. This will only work if the Node has a Group called 'Content' as Child. To support Touch Inputs there needs to be a Node called 'Knob' as Child.

Drawer Behavior to switch node on/off.

This behavior is available for 2D scenes only.

About implicit roles of ChildNodes

The first child node is used as content (Group2D) and the second as knob (RenderNode2D).
The knob node must be named "Knob" for proper dragging support (Touch).

Common Properties

Back to the menu

Linear Slider Behavior

This behavior provides the functionality of a linear Slider control. It must be used as a receiver in a process value chain and expects a normalized value in the range of 0.0 to 1.0.

This behavior is available for 2D scenes only.

Common Properties

Back to the menu

---

Internal Control Behaviors

Caret

Behavior which receives the CaretPositionChanged Event from the EditTextBehavior. It forwards the value to other behaviors (e.g. SetSize) and switches the blinking state.

Common Properties

Back to the menu

Handle Control State

Basic Behavior which handles the states of a control. Sends a StateEvent to StateConditions.

Example Usage

Common Properties

Back to the menu

DataContext

This behavior provides a local data context on the associated node that can act as a set of binding sources (if a binding source is set at that data context). It is internally used by other behaviors like the list behavior to set individual binding sources for items.

Common Properties

This behavior does not have any configurable properties.

Back to the menu

Edit Text

Control Behavior to make a TextNode editable. Receives KeyEvents and emits CaretPositionChanged Events. These can be received by the CaretBehavior to set the position of the caret node.

Common Properties

Back to the menu

Selection Group

Provides an ArrayProperty for Selection Objects. If one of them gets selected the others get deselected (Objects need a ChangeSelectionActionBehavior). Needs to be attached to a value Behavior.

Common Properties

Back to the menu

---

Public Property Control Behaviors

Provide Alignment

Provides properties to set the horizontal and vertical alignment. Especially for Controls.

Common Properties

Back to the menu

Copy Size

Copies the layout size to a target node. Especially for Controls to transfer the size from the control node to an inner node.

Common Properties

Back to the menu

Provide Color

Sets the color of a node with a Color effect attached (e.g. BitmapBrushColorBlend).

Common Properties

Advanced Properties

Back to the menu

Provide Margin

Provides property to set the margin. Especially for Controls.

Common Properties

Back to the menu

Property Provider

Offers to set a property of a selectable type. This property can then be used for other Behaviors (e.g. an image for Set Image or Provide Image).

Common Properties

Advanced Properties

Back to the menu

Render Node

Sets rendering of a node to enabled or disabled and provides the setting as a property for Controls.

Common Properties

Back to the menu

Provide Appearance

Sets the Appearance of a Render Node and provides the Appearance as a property for Controls.

This behavior is available for 3D scenes only.

Common Properties

Back to the menu

Provide Image

Sets the image of a node and provides the Image as a property for Controls.

Example Usage

Common Properties

Advanced Properties

Property Name	Type	Description
PropertyProvider	Behavior*	Property Behavior which contains the color which has to be set on the effect. This property is only available if "PropertyReference" is set to "Other". This property can be set in the right side of the Scene Tree Panel.
Image	SharedPointer<Candera::Image2D>	The image to set on the effect. This property is only available for 2D scenes if "PropertyReference" is set to "Self".
Texture	SharedPointer<Candera::TextureImage>	The image to set on the appearance. This property is only available for 3D scenes if "PropertyReference" is set to "Self".

Set Layout

Class Reference

Provides a published property to set the layout for Controls.

Limitations

Common Properties

Advanced Properties

Property Name	Type	Description
StackArrangement	Candera::StackLayouter::Arrangement	Selects arrangement for stack layouter. This property is only available if Layout is set to "Stack".
PropertyProvider	Behavior*	Property Behavior which contains the layout which has to be set on the effect. See Property Provider for more information. This property is only available if "PropertyReference"" is set to "Other".

Back to the menu

Provide Text

Modifies the text of a TextNode or CanvasText and provides the text as property for Controls.

Example Usage

Common Properties

Advanced Properties

Property Name	Type	Description
PropertyProvider	Behavior*	Property Behavior which contains the color which has to be set on the effect. This property is only available if "PropertyReference"" is set to "Other".
TrimmingText	FeatStd::String	Trimming text defines the text which replaces content overflowing the content area. This property is only available if "Trimming" is set to "CustomText".

Back to the menu

---

Align Pivot

Aligns all child nodes according to their pivot point.

Example Usage

Common Properties

This behavior does not have any configurable properties.

Back to the menu

Android Event Bridge

Builds a bridge for events between CGIStudio and an Android application. Receives JsonEvents from an Android Control and transforms them to an equivalent CGI Studio event.

This behavior is only available for Android platform.

Common Properties

Back to the menu

Arc Align

Aligns child nodes in a circular layout. Provides properties for the radius, orientation offset and the min and max angle.

Example Usage

Common Properties

Back to the menu

Blend Mode

Class Reference

Sets a blend mode from a given list of options. Depending on that option the behavior chooses the appropriate blend factors and operations. In 2D it sets the values on the effect and in 3D on the render-mode if one is attached on the same node.

The following blend modes are available:

The default blend mode comes in different variations, e.g. pre-multiplied, which should be applied if the alpha channel is pre-multiplied. The other blend modes are implemented according to the Porter-Duff composition modes.
In 3D there are two additional blend modes available:

Common Properties

Back to the menu

Breadcrumb Behavior

A breadcrumb used as a navigational aid in user interfaces. It allows users to keep track and maintain awareness of their location.

Common Properties

Back to the menu

Disable Control

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node gets disabled.

Back to the menu

Enable Control

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node gets enabled.

Back to the menu

Event Bridge

Builds a bridge for events between two nodes for direct event dispatching. The events are routed from the source node to the target node (only in one direction).

Common Properties

Back to the menu

Focus

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node gets focused.

Back to the menu

Focus Leave

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node's focus is left.

Back to the menu

Hover

See also: HoverLeave

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node gets hovered.

Example Usage

Back to the menu

HoverLeave

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node's hovering is left.

Example Usage

Back to the menu

IntervalSwitch

Sends Off or On value to Trigger Behaviors that belong to same node.

Common Properties

Back to the menu

Keyboard

This behavior provides the functionality of Keyboard control by managing the Keyboard Keys and setting their properties according to the Configuration Script.

Common Properties

Configuration String

The most important feature of the Keyboard Control is Configuration Script. It is parsed during layouting a scene which a keyboard is embedded on and keys (their appearance and their special functionalities) are arranged according to it.

The configuration script is simply a string. Each line of the string specifies a row of keys in the instance of keyboard and consists of space-separated list of key strings. A key string specifies a value that will be sent to a connected InputField. The most typical key string is simply a character or figure but it is not limited to it.

Following key strings have a special meaning:

Keyboard Control has public properties that customize labels of keys with the special meaning described above. One can set them custom text or image label.

Each key string (both regular and special) can be extended by a scaling factor in square brackets, e.g. SHIFT(Uppercase/en/US)[2] defines a key that sends to a state machine event with “Uppercase/en/US” string and the key itself is counted “2” times (like two different keys) when counting default width of a key in its row.

It is not obligatory to connect the Control to a state machine. There is a default set of layouts with lower- and uppercase english letters as well as digits and symbols with full switching support without a state machine.

Back to the menu

Menu Item

Class Reference

Menu Item Behavior defines the attached Node as an Menu Item. A Menu Item can interact with the Menu Screen Behavior. Sends Off or On value to Trigger Behaviors that belong to same node.

Common Properties

Back to the menu

MenuScreen

Class Reference

The Control represents a menu in the form of a grid of icons (instances of the Menu Item Control). It has configurable number of rows and columns as well as default and maximum number of screens. A user can swipe between neighbouring screens. The Control handles user input and forwards proper information to children MenuItem nodes. The children nodes may be removed and reordered in runtime.

Common Properties

Back to the menu

Navigation Instruction View

Behavior for displaying the instructions during navigation.

Common Properties

Back to the menu

OnClick

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node is clicked.

OnClick behavior allows to check for single, double or tripple (or any) Click events.

Example Usage

Back to the menu

OnPressed

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A set of actions can be configured, which will be executed when the node is pressed.

OnPressed behavior allows to check for Pressed and Released (and LongPressed) events.

Example Usage

Back to the menu

OnTimer

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior.

A timer node and a set of actions can be configured. These actions will be executed when the timer expires.

See also: Check Timer, Start Timer

This behavior is a Behavior Block.

Example Usage

Back to the menu

Orbit Camera Transform

When attached to a Node, the specified camera will orbit around that Node. PLAYER USE ONLY

Common Properties

Back to the menu

Page Indicator

Class Reference

Manages PageIndicator Control and its PageIndicatorElements.

Common Properties

Back to the menu

Rectangle Clipping Behavior

Clips the control to given rectangle.

Common Properties

Back to the menu

Roll

Class Reference

Roll is used for displaying and selecting entries representing Float values from range min..max with step size.

Common Properties

Advanced Properties

Back to the menu

Touch Indication Behavior

Used to display a touch indicator at the position where the screen is touched. Control must be positioned at position (0;0) if no offset to the touch location is desired.

Common Properties

Back to the menu

Transform Mesh2D

Class Reference

Performs a perspective projection of a 3D rotated effect (e.g. Bitmap or SolidColor effects) based on the configured origin, rotation and field of view.

Common Properties

Back to the menu

Event Handler

Passes a value to a Condition Behavior and if the response is positive, invokes an Action behavior.

Example Usage

Common Properties

Back to the menu

Virtual Key

Receives a Change Value Event with a boolean. True will start emitting Key Events, false will stop emitting Key Events.

Common Properties

Back to the menu

---