Predefined Behaviors

• Examples Using Predefined Behaviors
• Action Behaviors
• Condition Behaviors
• Control Behaviors
• Demonstration
• External Resource
• Graph
• IdentifierValueMap
• Layer
• Map
• Mixed Reality Behaviors
• Particle
• Scripting Behaviors
• State Machine Behaviors
• Streaming Behaviors
• Value Processing Behaviors
• Set Uniform
• BehaviorGroup

Examples Using Predefined Behaviors

Thermometer Example

1. Drag&drop a Slider Control and a Text Value Control from the Controls Panel of the Toolbox to the Scene Editor or the Scene Tree.

2. Set the Slider's Minimum to "-50,00" and the maximum to "+50,00".

3. Change the Text Value Control's "Format Text" Property to "%d °C".

4. Drag&drop a Forward Value Behavior (which is a Value Processing Behavior) from the Behaviors Panel of the Toolbox onto the Slider in the Scene Tree.

This is what the Scene Tree should look like now:

5. Select the Forward Value Behavior in the right side of the Scene Tree view. Set the Forward Value Behavior's Target Node to the Text Value Control you have added to the scene in step 1 by clicking on the magnifying glass on the right of the input field and selecting the Text Value Control in the "Choose Item" dialog.

After that, the Forward Value Behavior's Properties will look as follows.

6. Drag&drop a Value Behavior (which is a Value Processing Behavior) from the Behaviors Panel of the Toolbox onto the Text Value Control in the Scene Tree.

7. Select the Value Behavior on the right side of the Scene Tree View. Set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

8. Select the "Text Value" Control in the Scene Tree Panel and drag&drop two Action on Value Behaviors (which are Value Processing Behaviors) from the Behaviors Panel of the Toolbox onto the "Receivers" of the "Value Behavior" in right side of the SceneTree Panel.

9. Add a condition to the Action on Value Behaviors you have just added by dragging&dropping a Check processed Value Behavior (which is a Condition - Control Behavior) onto each of the Action on Value Behaviors you have just added.

10. Configure one of the Conditions to "LowerThan 0,00" and the other one to "GreaterThan 0,00".

11. Drag&drop a Set Color SetColor Action (which is a Action - Property Behavior) from the Toolbox view onto the Actions of each of the Action on Value Behaviors in the SceneTree.

12. Set the color to Blue on the Action on Value Behavior with the Condition Lower Than 0,00 and set the Color to Red on the Action on Value Behavior with the Condition Greater Than 0,00.

13. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

14. The text color of the Text Value Control displaying the temperature in degrees celcius will turn blue once the value of the slider gets lower than zero and it will turn red once the value becomes greater than zero.

Align Pivot Example

1. Drag&drop a Group from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree. Choose the follwing two Images from the Construction Kit (in the Solution Explorer) and drag&drop them onto the Group node in the SceneTree: GaugeBmP and GaugeNeedleBmp

2. Arrange the Controls in the SceneEditor so that "GaugeNeedleBmp" is the last entry of the Group Node in the Scene Tree.

3. Select the "Pivot only" Translation tool in the toolbar and move the pivot of "GaugeBmP" to the center of the image and the pivot of "GaugeNeedleBmp" to the usual center of rotation of a gauge needle.

4. Drag&drop the Align Pivot Behavior (which is a Control Behavior) from the Toolbox view onto the Group node in the SceneTree.

5. The Align Pivot Behavior does not have any properties to set. The pivots of the Bitmap Nodes are aligned and the result can be seen in the SceneEditor: The Needle image is positioned correctly in the Gauge image.

Arc Align Example

1. Drag&drop a Group from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree. And add four Text Nodes to this group by dragging&dropping them onto the Group node in the SceneTree.

2. Change the texts of the Text Nodes to "Text", "Text_1" etc. according to their names in the Scene Tree View.

3. Drag&drop the Arc Align Behavior (which is a Control Behavior) from the Toolbox view onto the Group node in the SceneTree.

4. Configure the Arc Align Behavior with a radius of 50 and AngleMinMax values of 0 and 90.

5. The result can be seen in the Scene Editor view: All nodes are aligned like an arc from 0 to 90 degrees.

Enable Rendering Example

1. Drag&drop a TextButton Control from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Drag&drop the OnClick Behavior (which is a Control Behavior) from the Toolbox view onto the TextButton node in the SceneTree. Additionally, drag&drop the Enable Rendering Behavior (which is a Action - Property Behavior) from the Toolbox view onto the "Actions" field of the OnClick Behavior on the right side of the Scene Tree.

3. Check the properties of the Enable Rendering Behavior. We want to change the visibility of the TextButton to invisible when it has been clicked (onClick), so the checkbox "Visible" has to remain unchecked.

4. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

Format String Example

1. Drag&drop a TextButton Control from the Controls panel and a TextNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree. Set the TextButton's Text to "Format String".

2. Drag&drop a Value Behavior (which is a Value Processing Behavior) from the Toolbox view onto the TextNode in the SceneTree. Set the Value Behavior's "AcceptValueEvent" property to true.

3. Drag&drop a Format String Behavior (which is a Value Processing Behavior) from the Toolbox view onto the Value Behavior's Receivers.

4. Set the Format String Behavior's "Text" property to "Score: %0.2f", in order to represent the value as formatted string.

5. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Toolbox view onto the TextButton's Actions on the right side of the SceneTree view.

6. Configure the Send Value as Event Behavior's Value property to datatype Int32 and value 10. Adjust the behavior's TargetNode by clicking on the magnifying glass on the right of the property.

7. Set the scene's TextNode as TargetNode for the Send Value as Event Behavior: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select the scene's TextNode and press OK.

8. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

9. When the TextButton is pressed, the Int32 value of 10 will be sent to the TextNode. This value is accepted by the TextNode and the behavior FormatString formats it to "Score: 10.00".

Forward Value Example

2. Position the Slider Control and Text Value Control in the Scene Editor View.

3. Change the Text Value Control's "Format Text" Property to "Value: %d".

4. Drag&drop a Forward Value Behavior (which is a Value Processing Behavior) from the Behaviors Panel of the Toolbox onto the Slider in the Scene Tree.

5. Select the Forward Value Behavior in the right side of the Scene Tree view. Set the Forward Value Behavior's Target Node to the Text Value Control you have added to the scene in step 1 by clicking on the magnifying glass on the right of the input field and selecting the Text Value Control in the Choose Item dialog.

After that, the Forward Value Behavior's Properties will look as follows.

6. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

7. When manipulating the slider, the Value of the Text Value Control changes according to the alteration on the slider.

Hover - Hover Leave Example

1. Drag&drop a Text Control from the Controls Panel of the Toolbox to the Scene Editor or the Scene Tree and change its text to "Hover".

2. Drag&drop a Hover Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the Text Control in the SceneTree. The Handle Control State Behavior is needed in order for the Text Control to receive Input Events.

3. Drag&drop a SetColor Behavior (which is an Action - Property Behavior) onto the Actions of the Hover Behavior on the right side of the SceneTree view.

4. Select the Set Color Behavior and change the Color to red.

5. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

6. When moving the mouse over the Text Control, the text color changes to red.

7. Drag&drop a Hover Leave Behavior (which is a Control Behavior) onto the TextNode.

8. Drag&drop a Set Color Behavior (which is an Action - Property Behavior) onto the Actions of the HoverLeave Behavior on the right side of the SceneTree view.

9. Select the Set Color Behavior and change the Color to green.

10. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

11. When moving the mouse over the Text Control, the text color changes to red (as it did before). When moving the mouse away again, the Text Control's color changes to green. Whenever you hover, it's getting red, when leaving, it's turning green.

Interpolate Value Example

1. Drag&drop a TextButton Control from the Controls panel and a TextNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree. Set the TextButton's Text to "Count to 10".

2. Drag&drop a Value Behavior (which is a Value Processing Behavior) from the Behaviors Panel of the Toolbox onto the TextNode in the Scene Tree.

3. Select the Value Behavior in the right side of the Scene Tree view. Set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

4. Drag&drop an Interpolate Value Behavior (which is a Value Processing Behavior) onto the Value Behavior's Receivers in the right side of the Scene Tree Panel.

5. Select the Interpolate Value Behavior on the right side of the Scene Tree View and set the UnitsPerSecond to 1,00 in the Properties view on the bottom right.

6. Drag&drop a Format String Behavior (which is a Value Processing Behavior) from the Toolbox onto the Interpolate Value Behavior's Receivers on the right side of the Scene Tree Panel.

7. Select the Format String Behavior on the right side of the Scene Tree view and set the Text property to "%d" in the Properties view.

8. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Toolbox view onto the TextButton's Actions on the right side of the SceneTree view.

9. Select the Send Value as Event Behavior on the right side of the Scene Tree Panel. Set the Value property to datatype "Float" and value "10" in the Properties view. Adjust the behavior's TargetNode by clicking on the magnifying glass on the right of the property.

10. Set the scene's TextNode as TargetNode for the Send Value as Event Behavior: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select the scene's TextNode and press OK.

11. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

12. When clicking on the TextButton, the value 10 gets sent to the TextNode, but the TextNode doesn't change to 10 immediately. The Interpolate Value Behavior makes the TextNode count up from 0 to 10 in one step per second.

Move Node Example

 1. Drag&drop a TextButton Control from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree and change the Text to "Move Node"

2. Select the TextButton in the Scene Tree View and delete all Behaviors that are automatically attached to the TextButton from the right side of the Scene Tree View.

3. Drag&drop a Value Behavior (which is a Value Processing Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Select the Value Behavior on the right of the Scene Tree View and set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

5. Drag&drop the Move Node Behavior (which is a Value Processing - Transformation Behavior) from the Behaviors Panel of the ToolBox onto the Value Behavior's Receivers.

6. Drag&drop an OnClick Behavior (which is a Control Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control.

7. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the OnClick Behavior's Actions Property.

8. Select the Send Value as Event Behavior on the right side of the Scene Tree View and set the value to datatype "Float" value "100,00" in the Properties view.

9. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

10. When Clicking on the TextButton in the Player, the Button moves to position 50, 50.

OnClick Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Drag&drop a OnClick Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

3. Drag&drop a Set Color SetColor Behavior (which is a Action - Property Behavior) from the Toolbox view onto the Actions of the OnClick Behaviors in the SceneTree.

4. Select the Set Color Behavior and change the Color to red.

5. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

6. When clicking on the SolidColorNode, the SolidColorNode's color changes to red.

OnPressed Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Drag&drop a OnPressed Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

3. Drag&drop a Set Color SetColor Behavior (which is a Action - Property Behavior) from the Toolbox view onto the Actions of the OnPressed Behaviors in the SceneTree.

4. Select the Set Color Behavior and change the Color to red.

5. Save your solution and start the CGIPlayer through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

6. When pressing the mouse left button on the SolidColorNode, the SolidColorNode's color changes to red.

Perform Transition Requests Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the 2D scene "Scene2D" in the SceneEditor or the Scene Tree view. Change the Scale X and Scale Y propertes to 3,0 each in the Properties view.

2. Open the already existing 3D scene "Scene3D" by double-clicking it in the Solution Explorer on the left.

3. Drag&drop a Cube Control from the Controls Panel of the Toolbox to the 3D Scene "Scene3D" in SceneEditor or the Scene Tree view.

4. Select the Cube Control in the Scene Tree view and set the Position properties to (0, 0, 0).

5. Switch back to the 2D scene "Scene2D" by double-clicking it in the Solution Explorer on the left.

6. Drag&drop a OnClick Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

7. Drag&drop a Perform Transition Requests Perform Transition Requests Behavior (which is a Action - Transition Behavior) from the Toolbox view onto the Actions of the OnClick Behaviors in right side of the SceneTree view.

8. Drag&drop two Transition Request Transition Request Behaviors (which are Action - Transition Behaviors) from the Toolbox view onto the Requests of the Perform Transition Requests Perform Transition Requests Behavior in the right side of the SceneTree view.

9. Select the first one of the two Transition Request Transition Request Behaviors. Set the Transition Request Transition Request Behavior's Identifier to the current scene (Scene2D) by clicking on the magnifying glass on the right of the input field and selecting the current 2D Scene (Scene2D) in the "Choose Item" dialog.

After that, the Transition Request Transition Request Behavior's Properties will look as follows.

10. Now, select the second Transition Request Transition Request Behaviors. Set the Transition Request Transition Request Behavior's Identifier to the 3D scene (Scene3D) by clicking on the magnifying glass on the right of the input field and selecting the 3D Scene (Scene3D) in the "Choose Item" dialog.

After that, the Transition Request Transition Request Behavior's Properties will look as follows.

11. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

12. You can see your 2D scene with the white SolidColorNode. When clicking on the SolidColorNode, a transition to the 3D scene is performed.

Render Child Nodes Example

1. Drag&drop two TextButton Controls from the Controls Panel of the Toolbox to the already existing Group Node of the Scene Tree and change their texts to "Button 1" and "Button 2".

2. Drag&drop an Event Handler Behavior (which is a Control Behavior) from the Toolbox view onto the Group Node in the Scene Tree view.

3. Select the Group Node in the Scene Tree view and drag&drop a Check Click Behavior (which is a Condition - Input Behavior) from the Toolbox view onto the Condition of the Group Node's EventHandler in the right side of the Scene Tree view.

4. Keep the Group Node selected in the Scene Tree view and drag&drop a Render Child Nodes Behavior (which is a Action - Property Behavior) from the Toolbox view onto the "Actions" of the Group Node's EventHandler on the right side of the Scene Tree view.

5. Select the "Render Child Nodes" Behavior in the right side of the Scene Tree view. In the Properties view set Index to "1,0" and OperationMode to to "SingleNode".

6. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

7. After clicking on one of the two buttons (no matter which one), "Button 2" will disappear and "Button 1" will get rendered.

8. Stop the Player by pressing on the Stop Button (next to the option "Generate and Play") and change the "Render Child Nodes" Behavior's Property: Set Index to "2,0".

9. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

10. After clicking on one of the two buttons (no matter which one), "Button 1" will disappear and "Button 2" will get rendered.

Send Value As Event Example

2. Rename the TextButton Controls to "DecreaseButton" and "IncreaseButton". Change the text of the DecreaseButton to "-" and the text of the IncreaseButton to "+".

3. Change the Text of the TextValue Control to "Count: %d" and arrange the three Controls as in the right picture below.

4. The value of the TextValue Control should be increased or decreased according to the pressed Button. To connect the TextButton Controls with the TextValue Control select one of the TextButtons. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) onto the Actions sections of both of the TextButton Controls' EventHandler.

5. Select the "SendValueAsEvent" Behavior of the "DecreaseButton" and change the Value to "-1,00" in the Properties view. As the value should change relative to the current value, the "ChangeValue" property has to be set to "Relative". Select the "SendValueAsEvent" Behavior of the "IncreaseButton" and change the Value to "1,00" in the Properties view. Again, the "ChangeValue" property has to be set to "Relative"

6. Both "SendValueAsEvent" Behaviors need to be configured with the "Text Value" Control as TargetNode by clicking on the magnifying glass on the right of the property.

7. Set the scene's TextValue Node as TargetNode for the Send Value as Event Behavior: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select the scene's TextValue Node and press OK. Repeat this for the second "SendValueAsEvent" Behavior.

8. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

9. When pressing the "-" Button, the Count value is decreased by one. When pressing the "+" Button, the Count value is increased by one.

Set Alpha Value Example

1. Drag&drop a TextButton Control from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree and change the Text to "Set Alpha Value"

2. Select the TextButton in the Scene Tree View and delete all Behaviors that are automatically attached to the TextButton from the right side of the Scene Tree View.

3. Select the TextButton Control in the SceneTree View and decrease its Alpha Value e.g. to 0,5 in the Item Tab of the Properties Panel.

4. Drag&drop a Value Behavior (which is a Value Processing Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

5. Select the Value Behavior on the right of the Scene Tree View and set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

6. Drag&drop the Set Alpha Value Behavior (which is a Value Processing - Effects Behavior) from the Behaviors Panel of the ToolBox onto the Value Behavior's Receivers.

7. Drag&drop an OnClick Behavior (which is a Control Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control.

8. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the OnClick Behavior's Actions Property.

9. Select the Send Value as Event Behavior on the right side of the Scene Tree View and set the value to datatype "Float" value "1,00" in the Properties view.

10. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

11. When Clicking on the TextButton in the Player, the Button moves to position 50, 50.

Set Image Example

1. Drag&drop a TextButton Control from the Controls Panel and a BitmapNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Position the TextButton Control and the BitmapNode next to each other in the Scene Editor.

3. Drag&Drop a Provide Image Behavior (which is a Control - Public Property Behavior) from the Behaviors Panel of the ToolBox onto the BitmapNode in the Scene Tree view.

4. Select the TextButton Control in the Scene Tree view and change its Text to "Set Image" in the Properties view.

5. Drag&Drop a Set Image Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the "Actions" field of the TextButton Control's EventHandler on the right side of the Scene Tree.

6. Select the newly added Set Image Behavior in right side of the Scene Tree view. Adjust the "Set Image" Behavior's Image Property by clicking the magnifying glass on the right of the input field.

7. Set the "Set Image" Behavior's image property: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select an image from the construction kit (a preview of the image is shown when moving the mouse over the image) and press OK.

8. Select the Set Image Behavior on the right side of the Scene Tree view and drag&drop it onto the BitmapNode on the left side of the Scene Tree view (you can see a little arrow and "Set Image").

9. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

10. When the TextButton is pressed, the configured image will be set to the BitmapNode and the image will appear.

Set Position Example

1. Drag&drop a TextButton Control from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree and change the Text to "Change Position".

2. Select the TextButton in the Scene Tree View and delete all Behaviors that are automatically attached to the TextButton from the right side of the Scene Tree View.

3. Drag&drop a Value Behavior (which is a Value Processing Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Select the Value Behavior on the right side of the Scene Tree View and set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

5. Drag&drop a Set Position Behavior (which is a Value Processing - Transformation Behavior) from the Behaviors Panel of the ToolBox onto the Value Behavior's Receivers.

6. Select the Set Position Behavior on the right side of the Scene Tree view and set its TranslationAxis Property to "AxisX"

7. Drag&drop an OnClick Behavior (which is a Control Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control.

8. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the OnClick Behavior's Actions Property.

9. Select the Send Value as Event Behavior on the right side of the Scene Tree View and set the value to datatype "Float" value "100,00" in the Properties view.

10. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

11. When Clicking on the TextButton in the Player, the Button's horizontal position (x coordinate) is set to 100, so it moves to the right.

Set Rotation Example

1. Drag&drop a TextButton Control from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree and change the Text to "Set Rotation".

2. Select the TextButton in the Scene Tree View and delete all Behaviors that are automatically attached to the TextButton from the right side of the Scene Tree View.

3. Drag&drop a Value Behavior (which is a Value Processing Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Select the Value Behavior on the right side of the Scene Tree View and set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox.

5. Drag&drop a Set Rotation Behavior (which is a Value Processing - Transformation Behavior) from the Behaviors Panel of the ToolBox onto the Value Behavior's Receivers.

6. Drag&drop an OnClick Behavior (which is a Control Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control.

7. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the OnClick Behavior's Actions Property.

8. Select the Send Value as Event Behavior on the right side of the Scene Tree View and set the value to datatype "Float" value "40,00" in the Properties view.

9. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

10. When Clicking on the TextButton in the Player, the Button is rotated 40° clockwise.

Set Scale Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Drag&drop a Value Behavior (which is a Value Processing Behavior) from the Behaviors Panel of the Toolbox onto the Text Value Control in the Scene Tree.

3. Select the Value Behavior on the right side of the Scene Tree View. Set the Value Behavior's AcceptValueEvent Property to "true" by checking the checkbox in the Properties view. Check the Minimum Checkbox and set the Minimum Value to 0,50. Check the Maximum Checkbox and set the Maximum Value to 3,00. Also, set the Variant Value to 1,00.

4. Select the SolidColorNode in the Scene Tree view and drag&drop an Interpolate Value Behavior (which is a Value Processing Behavior) onto the Value Behavior's Receivers in the right side of the Scene Tree Panel.

5. Select the Interpolate Value Behavior on the right side of the Scene Tree view and set the property "Units Per Second" to 1,00 in the Properties view.

6. Drag&Drop a Set Scale Behavior (which is a Value Processing - Transformation Behavior) onto the Interpolate Value Behavior's Receivers in the right side of the Scene Tree Panel.

7. Select the Set Scale Behavior and check the ScaleAlongY checkbox in the Properties view. Set the ScaleVextor2D Property to (1, 1).

8. Drag&drop two TextButton Controls from the Controls Panel of the Toolbox to the SceneEditor or the Scene Tree.

9. Configure the first TextButton Control to have the Text "Decrease". Configure the second TextButton Control to have the Text "Increase" and set it's Enabled Property to "false" by unchecking the Checkbox.

10. Drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Toolbox view onto the TextButton's Actions on the right side of the SceneTree view. Do this for both of the TextButton Controls.

11. Select the first TextButton Control (the one with text "Decrease") and then select its Send Value as Event Behavior on the right side of the Scene Tree view. Set the Value Property to 0,50. Adjust the behavior's TargetNode by clicking on the magnifying glass on the right of the property.

12. Set the scene's TextNode as SolidColorNode for the Send Value as Event Behavior: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select the scene's SolidColorNode and press OK.

13. Select the second TextButton Control (the one with text "Increase") and then select its Send Value as Event Behavior on the right side of the Scene Tree view. Set the Value Property to 3,00. Set the behavior's TargetNode to the scene's SolidColorNode as you just did for the first TextButton Control.

14. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

15. When clicking on the TextButton "Increase" in the Player, the size of the SolidColorNode is slowly increased. When clicking on the TextButton "Decrease", the size of the SolidColorNode is slowly decreased.

Set Text Example

1. Drag&drop a TextButton Control from the Controls panel and a TextNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree. Set the TextButton's Text to "Change Text".

2. Position the TextButton Control and the TextNode nicely in the Scene Editor.

3. Drag&Drop a Provide Text Behavior (which is a Control - Public Property Behavior) from the Behaviors Panel of the ToolBox onto the TextNode in the Scene Tree view.

4. Select the TextButton Control and drag&drop a Set Text Behavior (which is a Action - Property Behavior) from the Behaviors Panel of the ToolBox onto the "Actions" field of the TextButton Control's EventHandler on the right side of the Scene Tree.

5. Select the newly added Set Text Behavior in right side of the Scene Tree view and change the Text property to "Hallo" in the Properties view.

6. Select the Set Text Behavior on the right side of the Scene Tree view and drag&drop it onto the TextNode on the left side of the Scene Tree view (you can see a little arrow and "Set Text").

7. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

8. When the TextButton is pressed, the text of the TextNode will be changed to "Hallo".

Start Timer Example

1. Drag&drop a TextButton Control and a Text Control from the Controls panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Select the TextButton in the Scene Tree View and delete all Behaviors that are automatically attached to the TextButton from the right side of the Scene Tree View.

3. Set the TextButton Control's text to "Start Timer" and the Text Control's text to "Wait for Timer".

4. Drag&drop an OnClick Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the Text Control to receive Input Events.

5. Select the TextButton Control in the Scene Tree view and drag&drop a Start Timer Behavior (which is a Action - Control Behavior) from the Toolbox view onto the Actions of the TextButton Control's OnClick Behavior in the right side of the Scene Tree view.

6. Select the Start Timer Behavior in the right side of the Scene Tree view and set the Delay property to "1000" in the properties view. Set the Start Timer Behavior's Target Node to the Text Control you have added to the scene in step 1 by clicking the magnifying glass on the right side of the input filed and selecting the Text Value Control in "Choose Item" dialog.

After that, the Start Timer Behavior's Properties will look as follows.

7. Drag&drop an On Timer Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the Text Control to receive Input Events.

8. Select the Text Control in the Scene Tree view and drag&drop a Set Color Behavior (which is a Action - Property Behavior) from the Toolbox view onto the Actions of the Text Control's On Timer Behavior in the right side of the Scene Tree view.

9. Select the Set Color Behavior and change the Color to red.

10. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

11. When the TextButton "Start Timer" is pressed, a timer is started and after some time the Text Control's text changes its color.

Switch Image Example

1. Drag&drop a FlipBook Control from the Controls panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Drag&drop a Value Behavior (which is a Value Processing Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the TextButton Control in the SceneTree. The Handle Control State Behavior is needed in order for the Text Control to receive Input Events.

3. Select the Value Behavior in the right side of the Scene Tree view and set the "AcceptValueEvent" property to "True" in the Properties view.

4. Select the FlipBook Control in the Scene Tree view and drag&drop a Switch Image Behavior (which is a Value Processing - Effects Behavior) from the Toolbox view onto the Receivers of the FlipBook Control's Value Behavior in the right side of the Scene Tree view.

5. Drag&drop an OnClick Behavior (which is a Control Behavior) from the Behaviors Panel of the ToolBox onto the FlipBook Control in the SceneTree.

6. Select the FlipBook Control in the Scene Tree view and drag&drop a Send Value as Event Behavior (which is a Action - Property Behavior) from the Toolbox view onto the Actions of the FlipBook Control's OnClick Behavior in the right side of the Scene Tree view.

7. Select the Send Value as Event Behavior in the right side of the Scene Tree view and set the "Value" propert to "5,00".

8. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

9. When the FlipBook Control is clicked in the Player, the image of the FlipBook is switched.

Transform Gesture Action Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Select the SolidColorNode's SolodColorBushBlend effect and change the Size properties to 100,00 and 100,0 in the Properties view.
The SolidColorNode is going to be our touchable content, which should be large enough to touch it with two fingers. This could also be achieved by extending the touchable area of the RenderNode (defining the Bounding Rectangle). But please beware that this will have consequences on the laid out size.

3. Drag&drop a Transform Gesture Action Behavior (which is a Action - Gesture Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Select the Transform Gesture Action Behavior and configure Panning Minimum and Maximum values for x and y coordinate.

5. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

6. When panning the SolidColorNode you can drag it around in the area that has been defined in the Transform Gesture Action Behavior's Panning Properties. If you do have a touch screen available, you can also try pinching and rotating the SolidColorNode.

Transform Gesture Condition Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Select the SolidColorNode's SolidColorBushBlend effect and change the Size properties to 100,00 and 100,0 in the Properties view.
The SolidColorNode is going to be our touchable content, which should be large enough to touch it with two fingers. This could also be achieved by extending the touchable area of the RenderNode (defining the Bounding Rectangle). But please beware that this will have consequences on the laid out size.

3. Drag&drop a Event Handler Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Drag&drop an Event Handler Behavior (which is a Control Behavior) from the Toolbox view onto the SolidColorNode or its parent node in the Scene Tree view.

5. Select the SolidColorNode and drag&drop a Transform Gesture Condition Behavior (which is a Condition - Input Behavior) onto the Event Handler EventHandler's Condition on the right side of the Scene Tree View.

6. Select the SolidColorNode and drag&drop a Set Color Behavior (which is a Action - Property Behavior) onto the Event Handler EventHandler's Actions on the right side of the Scene Tree View.

7. Select the Set Color Behavior and change the Color to red.

8. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

9. When a transform gesture is detected, a TransformEvent is sent to the touched node. If the event matches the condition, the configured action will be performed. In our case, when a transform gesture is detected, the SetColor Action will be performed and the SolidColorNode changes its color.

Swipe Gesture Example

1. Drag&drop a SolidColorNode from the "Nodes 2D" Panel of the Toolbox to the SceneEditor or the Scene Tree.

2. Select the SolidColorNode's SolidColorBushBlend effect and change the Size properties to 100,00 and 100,0 in the Properties view.
The SolidColorNode is going to be our touchable content, which should be large enough to touch it with two fingers. This could also be achieved by extending the touchable area of the RenderNode (defining the Bounding Rectangle). But please beware that this will have consequences on the laid out size.

3. Drag&drop a Event Handler Behavior (which is a Control Behavior) and a Handle Control State Behavior (which is a Control - Internal Behavior) from the Behaviors Panel of the ToolBox onto the SolidColorNode in the SceneTree. The Handle Control State Behavior is needed in order for the TextButton Control to receive Input Events.

4. Select the SolidColorNode and drag&drop a Swipe Gesture Condition Behavior (which is a Condition - Input Behavior) onto the Event Handler EventHandler's Condition on the right side of the Scene Tree View.

5. Select the Swipe Gesture Condition Behavior and configure its direction to "Right".

6. Select the SolidColorNode and drag&drop a Set Color Behavior (which is a Action - Property Behavior) onto the Event Handler EventHandler's Actions on the right side of the Scene Tree View.

7. Select the Set Color Behavior and change the Color to red.

8. Copy the EventHandler (with both its Condition and its Action you configured in steps 3 - 6 of this example) by right-clicking on the EventHandler in the right side of the Scene Tree View and choosing "Copy" (or via keyboard shortcut use Ctrl+C). Paste the EventHandler by right-clicking on the Behaviors (the topmost entry, where it says "Behaviors") in the right side of the Scene Scene Tree view and choosing "Paste" (or via keyboard shortcut select the topmost entry where it says "Behaviors" and press Ctrl+V).

9. By duplicating the EventHandler you have created "Event Handler_1" with Condition "Swipe Gesture_1" and Action "Set Color_1".

10. Select the "Swipe Gesture_1" Condition and set its Direction to "Left". Select the "Set Color_1" Action and configure its color to Green.

11. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

12. In the beginning the SolidColorNode is white. But after a swipe to the right, the SolidColorNode is gets red. If you swipe to the left, the SolidColorNode gets green.

Scroll View Example

1. Drag&drop a ScrollView Control from the Controls Panel of the Toolbox to the Scene Editor or the Scene Tree.

2. Drag&drop a StackLayout from the "Nodes2D" Panel of the ToolBox onto the ContentAnchor of the ScrollView Control in the Scene Tree.

3. Change the Layouter Arrangement of the StackLayout to "vertical".

4. Drag&drop a Text Control from the Controls Panel, a BitmapNode from the "Nodes2D" Panel of the ToolBox and another Text Control from the Control Panel onto the StackLayout in the Scene Tree.

5. Select a Text Control in the Scene Tree View and set its width to "500" in the Layout Size Properties.

6. In the Control Properties change the Text Property to a longer, several lines long text (newlines can be achieved via Ctrl+Enter). Also set the Text Control to be Multiline and enable Word Wrap.

7. Repeat the previous two steps for the second Text Control.

8. Select the BitmapNode in the Scene Tree View before selecting the BitmapBrushBlend Effect on the right side of the Scene Tree View. Adjust the BitmapBrushBlend Effect's image by clicking on the magnifying glass on the right of the input field.

9. Set the BitmapBrushBlend Effect's image property: After clicking the magnifying glass in the properties panel, the "Select Item" Dialog is opened. Select an image from the construction kit (a preview of the image is shown when moving the mouse over the image) and press OK.

10. The SceneEditor now displays the ScrollView and its contents without the possibility to scroll.

11. Select the ScrollView Control in the Scene Tree View and set its Layout Size to a height of "400". After that, a vertical scrollbar is displayed in the SceneEditor.

12. Save your solution and start the Player through the Play button (with the option "Generate and Play") in the Toolbar on the top to see the result.

13. The ScrollView is displayed with a full functional scrollbar. When scrolling, you can check that all configured content is available: both Text Controls and one BitmapNode.

Process Value Changed Event - Slider Example

Process Value Changed Event - State Machine Example

1. Drag&drop a Button and a TextNode2D from the Toolbox into the Scene Editor or Scene Tree and arrange them in a way that both are clearly visible.

2. Create a new State Machine through the menu "State Machine" - "New State Machine...", which will open the "Add New State Machine" dialog. Adapt the State Machine's name to your needs and press "OK".

3. Select the created State Machine and make it a global State Machine by checking the "Is Global" property in the Properties panel.

4. Double-click your Global State Machine to open it in the State Machine Editor. Drag&drop a State from the tools in the top right corner of the State Machine Editor into the State Machine diagram.

5. Drag&drop a Transition from the tools in the top right corner onto one of the States in the diagram, then move the mouse and click the second state of the diagram, which will draw a Transition from one State to the other.

6. Perform the same action again, drawing a Transition in the other direction.

7. Select a State and add an OnEntry Action. To do this, press the "+" sign. Choose the "Send Value Changed As Event" from the drop-down list and configure a Float value of "1.00".

8. Click the magnifying glass next to the Target Node property to open the "Choose Item" dialog, where you can select the Scene's TextNode2D.

9. Now, select the other State and perform the same action again, but configure a different value in the "Send Value Changed As Event", e.g. a Float value of "2.00".

10. Drag&drop a "Process Value Changed Event" from the Toolbox onto the TextNode2D in the Scene Tree and drag&drop a "Format String" behavior onto the Receiver's part of the "Process Value Changed Event".

11. Select the Format String Behavior and enter "%d" in the Text Property.

12. Save your solution and start the Player. Whenever you press the button, a state transition will be performed. Each of the two states is configured with a different value (1.00 or 2.00), which will be sent as event. The TextNode2D will receive this value and display it. So, repeatedly pressing the button will change the displayed value from 1 to 2 and back to 1 etc.

Usecase for Send Value Changed as Event and reception in state machine(s) 

Triggering State Transitions using Buttons

This example demonstrates the usage of "Send Value Changed as Event" in combination with a local as well as a global state machine.

Setting up the Scene

For this example, two groups are used each with two buttons and a color node. The buttons are used to send events with values "0" and "1". The color node is used to display the corresponding state of the associated state machine.

1. Drag&Drop a StackLayout onto the scene and rename to "Group"

2. Drag&Drop a StackLayout onto the root group and rename to "GlobalGroup". Set the property "Layouter > Arrangement" to "Vertical"

3. Drag&Drop a TextNode into the GlobalGroup and change name and text to "Global". Add two TextButtons rename to "GlobalButton_Send_0" and "GlobalButton_Send_1" and change the text to "0" and "1". Add a SolidColorNode and rename to "GlobalTarget". Set property "StretchBehavior" to "Fill".

4. Repeat Step 2. and 3. using "Local" for the names (as displayed in the screenshot).

Setting up the State Machines

1. In Solution Explorer in "Solution > State Machines" from the context menu use "Add > New Item…". In the dialog select "StateMachine" and change name to "GlobalChangeColorOnEvent"

2. Open State Machine Editor by double clicking on the created state machine. It shows an initial state and a state with a transition.

3. Drag&Drop a new State onto StateMachine canvas. Rename the two states to "Value_Is_0" and "Value_Is_1".

4. Drag&Drop a Transition starting from State "Value_Is_0" to "Value_Is_1". Rename it to "If_Value_1". In the property panel in the "Transition" section set the property "Event" to "Value Changed" and property "Condition" to "Check Changed Value". In the "Condition parameters" section set "ConditionOperator" to "Equal" and "ConditionValue" to "Int32" and value "1".

5. Repeat Step 4. for the transition in opposite direction. Use "If_Value_0" as a name, and for the "ConditionValue" property use value "0".

6. In the "Solution Explorer" clone the state machine "GlobalChangeColorOnEvent" naming it "LocalChangeColorOnEvent".

7. Set the property settings of the cloned state machine (set "Transition > Event" to "Value Changed", "Transition > Condition" to "Check Changed Value", "Condition parameters > ConditionOperator" to "Equal" and "Condition parameters > ConditionValue" to "Int32" and value "0" and "1", respectively).

Connecting Scene and StateMachines

1. In Scene Tree open "GlobalButton_Send_1". From "Behaviors > Action > Property" drag&drop a "Send Value Changed As Event" action onto the buttons "Actions" section in the "Behaviors" tree. In the property panel of the added action, change "Value" to "Int32" and value "1" and "EventDispatchStrategy" to "Bubble".

2. Repeat Step 1 for the other buttons "GlobalButton_Send_0", "LocalButton_Send_1", and "LocalButton_Send_1", with values set accordingly.

3. In Solution Explorer open state machine "GlobalChangeColorOnEvent". Select Transition "If_Value_1". In the properties panel set "Condition Parameters > Sender" to "Scene2D > Group > GlobalGroup > GlobalButton_Send_1".

4. Repeat Step 3 for Transition "If_Value_0" using "GlobalButton_Send_0".

5. In the State Machine Editor, select state "Value_Is_0". From "Behaviors > Action > Property" drag&Drop a "Set Color" action onto the "On Entry Actions" section in the transition’s actions editor.

6. Select the new action and in the properties panel set "TargetNode" to "Scene2D > Group > GlobalGroup > GlobalTarget" and "Color" to a color that is associated with the global value "0" (for example #FFD900FF)

7. Repeat step 5 and 6 for state "Value_Is_1" (using a different color, such as #0E00FFFF)

8. Repeat Step 3 – 7 for state machine "LocalChangeColorOnEvent" referring to the nodes in "LocalGroup" instead and using different colors (for example #00FF00FF for value "0" and #FF0000FF for value "1").

9. Select the state machine "GlobalChangeColorOnEvent" and change its property "Is Global" to "true".

10. In Scene Tree select "Scene2D > Group" and drag&drop a StateMachine behavior onto its behavior tree. In the properties panel set "StateMachine" to "Solution > State Machines > LocalChangeColorOnEvent".

Result and Conclusion

Generate and play the solution to see the following result:

The following aspects have been considered in this example:

Set MVG Fill Colour

Set MVG Stroke Color

Action Behaviors

Animation Action Behaviors

Configure and Play Animation

Class Reference

Starts, stops, pauses, resumes animations and offers additional properties for configuration. Also sends AnimationEvents with the state of the animation. These Events can be received by an AnimationStateCondition.

Common Properties

Advanced Properties

Property Name	Type	Description
FinishTime	FeatStd::Optional<Candera::Animation::WorldTimeType>	Finish time in milliseconds. This property is only available if the property "Action" is checked and set to "Finish".
IncreaseSdpeed	FeatStd::Optional<FeatStd::Float>	Increased playback speed of the animation. If set and Play is executed again during playback, animation will speed up (can be used only once per animation!). Zero means immediate position seek. This property is only available in the following configuration: an "Animation" is configured "Action" is set to "Start" or "SpeedUp"  "RepeatMode" is not checked "RepeatCount" is not checked
IncreasedSpeedRevertMargin	FeatStd::Optional<Candera::Animation::WorldTimeType>	Defines trailing part of animation (in milliseconds) that will be played at normal speed again. If not set, speedup will last until the end of animation. This property is only available if property "IncreasedSpeed" is checked.
SequenceStartTime	FeatStd::Optional<Candera::Animation::SequenceTimeType>	The start point  of the animation. [ms] This property is only available if an animation is set in the property "Animation".
SequenceDurationTime	FeatStd::Optional<Candera::Animation::SequenceTimeType>	The duration of the animation. [ms] This property is only available if an animation is set in the property "Animation".

Control Action Behaviors

Breadcrumb Action

Class Reference

An Action Behavior that sends breadcrumb action events. It allows you to control a Breadcrumb or a node with a Breadcrumb Behavior attached. This behavior is available for 2D scenes only.

The operations that can be performed are:

Common Properties

Change Selection

Class Reference

Sends a ChangeSelectionEvent to the SelectionGroup. The SelectionGroup then sends a ChangeSelectionEvent to all of its receivers. The event is emitted via BubbleEventDispatchStrategy to a SelectionGroupBehavior.

Common Properties

This behavior does not have any configurable properties.

Conditional Action

Class Reference

A conditional action can be used to add further checking of conditions while actions are already performed. E.g. a click may trigger one action in a specific control state and another if this state is not set.

Common Properties

Change Drawer State

Class Reference

An Action that allows to hide/show the contents of a Drawer or a Node with a Drawer Behavior attached. This behavior is available for 2D scenes only.

The operation that can be performed are: Close, Open or Toggle.

Common Properties

Advanced Properties

Set Focus

Sets keyboard focus to the selected control when triggered. Can be used for example to change focus between List controls.

Common Properties

Interpolate Value Action

Changes the animation mode (for example, SpeedBased) of the InterpolateProcessValue behavior when the relevant action is triggered.

Common Properties

Interval Switch Action

This action changes the state of the interval switch behavior (by selecting a target Node). With this behavior we can set the state to the following values: on, off, blinking.

Common Properties

Keyboard Action

Manages keyboard control by executing configured actions such as open, close, toggle, and layout switch on the target keyboard node, using defined layout and auto-hide settings when triggered.

Common Properties

Advanced Properties

Property Name	Type	Description
Layout	String	Layout name. This property is only available if "Action" is set to "Open", "ShiftLayout" or "SwitchLayout".
Notifier	Candera::AbstractNodePointer	Event sender. If Notifier is invalid then default is node which has attached behavior. This property is only available if "Action" is set to "InvokeKey".
TextNode	Candera::AbstractNodePointer	Text node. This property is only available if "Action" is set to "InvokeKey".
ImageNode	Candera::AbstractNodePointer	ImageNode node. This property is only available if "Action" is set to "InvokeKey".
FocusNode	Candera::AbstractNodePointer	FocusNode node. This property is only available if "Action" is set to "InvokeKey".
Configuration	String	Keyboard configuration. This property is only available if "Action" is set to "SetConfiguration".

Map Action

Call a specified action on selected MapBehavior.

Common Properties

Map Location Action

Represents a location on the map which can be sent to MapBehavior.

Common Properties

Navigation Action

Invoke a specified navigation action on selected Map

Common Properties

MenuScreenAction

Class Reference

Description

Action Behavior which sends MenuScreen action event allows you control the menu screen. The operations it can do are: add, delete element and change screen page. This behavior is available for 2D scenes only.

Common Properties

Page Indicator Action

Class Reference

Sends an event to PageIndicator from external control (change number of pages, change active index)

It is also used by PageIndicatorElement (ActivateDot) to activate clicked element and to define visual properties of the PageIndicatorElement. This behavior is available for 2D scenes only.

Common Properties

Properties available when Action is set to ChangeActiveIndex or ChangeNumberOf Pages

Property Name	Type	Description
Value	FeatStd::Int32	Value to be sent to PageIndicator (for ChangeActiveIndex and ChangeNumberOfPages actions)
ChangeValue	ChangeValue::Enum	Type of value change to be sent to PageIndicator (for ChangeActiveIndex and ChangeNumberOfPages actions) Possible values: Absolute or Relative
PageIndicatorNode	Candera::AbstractNodePointer	PageIndicator node to communicate with.

Properties for usage within PageIndicatorElement (ActivateDot)

These properties are used only when the behavior is used within PageIndicatorElement and action is set to ActivateDot.

Set Control State

Class Reference

Sets the state of a control by sending an Event to a control considering the selected EventDispatchStrategy.

Supports: Any Node with a Handle Control State attached.

Used in: SpinBox

See also: Set Image, Set Text, Set Color

Example Usage

Common Properties

Advanced Properties

Start Timer

Class Reference

Start Timer Behavior starts a timer. If the delay time is passed the behavior's node or target node will receive a Timer Event. The Timer Event can then be handled by an Event Handler with a Check Timer Behavior to trigger an action.

Used in: ScrollBar

See also: Check Timer, OnTimer

Example Usage

Common Properties

---

Custom Action Behaviors

Click to Message

Sends a custom message on invoke action event.

Common Properties

Property Name	Type	Description
Identifier	String	The identifier of the click message.

Copy Textures

When triggered, the textures of an appearance are used on the appearance of the node. This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
TargetNode	Candera::AbstractNodePointer	The Node which is modified. If not set, then the node where the behavior is attached to, will be modified.
Appearance	SharedPointer<Candera::Appearance>	The appearance to set on the node.

Gesture Action Behaviors

Transform Gesture

Use the transform gesture action to apply the transformation of a transform gesture event (pan, pinch and rotate) to a node. You can use this behavior as an action or directly without an event handler. This behavior is available for 2D scenes only.

Pan

If you touch the Render Node with one finger, the content that you have touched will follow your finger. If you touch it with two fingers the point of the content that hits the center between your fingers will follow the center between your fingers.

Pinch

If you pinch/stretch the content with your fingers the content will be scaled down/up.

Rotate

If you touch the content with two fingers and drag them around the rotation change of the line between your fingers will be applied on the content.

Only if all transformations are allowed the content is able to follow your fingers. Otherwise there may be a displacement that matches the configuration but not the finger position (e.g. if the pan/scale is locked to an axis or Rotation is disabled but scale is still set to uniform scale). The default values are chosen to most fit the common use cases (e.g. it is more likely that uniform scale is required than a non-uniform scale).

Example Usage

Common Properties

Advanced Properties

Property Name	Type	Description
PanMinimumX	FeatStd::Optional<FeatStd::Float>	The minimum pan X value. This property is only available if panning in x direction is enabled.
PanMinimumY	FeatStd::Optional<FeatStd::Float>	The minimum pan Y value. This property is only available if panning in y direction is enabled.
PanMaximumY	FeatStd::Optional<FeatStd::Float>	The maximum pan X value. This property is only available if panning in x direction is enabled.
PanMaximumX	FeatStd::Optional<FeatStd::Float>	The maximum pan Y value. This property is only available if panning in y direction is enabled.
PinchMinimumX	FeatStd::Optional<FeatStd::Float>	The minimum pinch X value. This property is only available if pinching in x direction is enabled.
PinchMinimumY	FeatStd::Optional<FeatStd::Float>	The minimum pinch Y value. This property is only available if pinching in y direction is enabled.
PinchMaximumX	FeatStd::Optional<FeatStd::Float>	The maximum pinch X value. This property is only available if pinching in x direction is enabled.
PinchMaximumY	FeatStd::Optional<FeatStd::Float>	The maximum pinch Y value. This property is only available if pinching in y direction is enabled.
PinchMinimumUniform	FeatStd::Optional<FeatStd::Float>	The minimum pinch uniform value. This property is only available if pinching is enabled and configured for ScaleUniform.
PinchMaximumUniform	FeatStd::Optional<FeatStd::Float>	The maximum pinch uniform value. This property is only available if pinching is enabled and configured for ScaleUniform.
RotateMinimum	FeatStd::Optional<FeatStd::Float>	The minimum rotate value This property is only available if rotation is enabled.
RotateMaximum	FeatStd::Optional<FeatStd::Float>	The maximum rotate value This property is only available if rotation is enabled.

Property Action Behaviors

Set Appearance

Sets or changes the appearance of a 3D node. Adjusts its material, color, transparency, or texture to update how the node looks when triggered. This behavior is available for 3D scenes only.

Common Properties

Send Value as Event

Class Reference

Sends out a new value. Associated controls with a value property receive the new value.

Example Usage

Common Properties

Advanced Properties

Set Color

Class Reference

Sets the color of a node with a Color effect attached (e.g. BitmapBrushColorBlend or SolidColorBrush). In 3D, it sets the diffuse color of the material.

Supports

See also: Set Image, Set Text, Set Control State

Example Usage

Common Properties

Advanced Properties

Set Image

Class Reference

Sets or changes the image of a node (such as Bitmap) with an attached effect (BitmapBrush) when an action is triggered. Can be used to update the image property of a BitmapBrush effect when used with OnClick.

See also: Set Text, Set Color, Set Control State

Example Usage

• Set Image Example

Common Properties

Advanced Properties

Set MVG Fill Color

Sets the fill color of an MVG node using an MVG brush effect (for example, MVGRectBrush) when an action behavior is triggered.

Property Name	Type	Description
PropertyReference	CgiStudioControl::PropertyReference::Enum	Choose how the property gets set. Via own property or from another Behavior.
Color	Candera::Color	The fill color to be set.
PropertyProvider	CgiStudioControl::PropertyProviderBehavior	Property Behavior which contains the color which has to be set on the effect.

Set MVG Stroke Color

Render Child Nodes

Class Reference

Enables or disables child nodes of a group according to the operation mode. The same float input is used to select a single node or affect multiple nodes. When the action triggred.

Example Usage

Common Properties

Set Text

Class Reference

Sets/Changes the text of a TextNode.

See also: Set Image, Set Color, Set Control State

Example Usage

Common Properties

Advanced Properties

Set Text Style

Sets the configured text style to a text node when the action is triggered.

Common Properties

Enable Rendering

Class Reference

If invoked by a TriggerBehavior, changes the visibility of a node.

Example Usage

Common Properties

Send Value Changed As Event

Sends out a new value. Associated controls with a value property receive the new value.

Example Usage

Common Properties

Advanced Properties

---

Scroll Action Behaviors

Send Scrollable Event

Class Reference

Enables a scrollable behavior (for example, a List behavior) to scroll to a specific target position based on the selected scrolling type (horizontal or vertical) and value (item-wise or page-wise) when triggered. Can be used to manage the scroll direction of a list control.

Common Properties

Advanced Properties

Property Name	Type	Description
DedicatedBehavior	Behavior*	The dedicated process value behavior that will receive the change value event. This property can be set in the right side of the Scene Tree panel. It is only available if the EventDispatchStrategy is set to "DedicatedBehavior".

Streaming Action Behaviors

Configure and Play Stream

Class Reference

Starts, stops, pauses, resumes video streams by emitting an VideoControl Event. These Events can be received by Video Stream Behaviors.

Common Properties

Advanced Properties

Property Name	Type	Description
DedicatedBehavior	Candera::Behavior*	A dedicated behavior that will receive the event. This property can be set in the right side of the Scene Tree panel. It is only available if the EventDispatchStrategy is set to "DedicatedBehavior".

Transition Action Behaviors

Perform Transition Requests

Class Reference

Used to specify whether a node should be activated or deactivated by the transition framework when the associated TransitionActionBehavior is triggered.

Used to execute transitions via TransitionRequestBehaviors.

See also: Transition Request

Example Usage

Common Properties

Transition Request

Class Reference

Used to specify whether a node should be activated or deactivated by the transition framework when the associated TransitionActionBehavior is triggered.

Example Usage

Common Properties

Views

Jump to View

Use this action to request jump/switching to the configured view (via the configured node). Depending on the view state setup (e.g. with view trees or a state machine) the request will be accepted or denied. The action itself will emit a JumpToViewEvent on the configured node.

Common Properties

Property Name	Type	Description
TargetNode	Candera::AbstractNodePointer	The Node which is modified. If not set, then the node where the behavior is attached to, will be modified.
View	ViewIdentifier	Identifier of the view that is requested to be shown.

There is no documentation for behaviors of the Internal subcategory as they are used internally by Scene Composer and not intended for customer use.

---

Send Virtual Key

When triggered the action behavior sends a KeyEvent for down and one frame later a KeyEvent for up

Common Properties

---

Set Culture

Class Reference

Action Behavior which activates a culture based on its 'locale' value. Receives a locale as value. Invoking the action changes the application culture to a culture fitting to this locale.

Common Properties

Condition Behaviors

Control Condition Behaviors

Check Animation State

Checks the current state of an animation (for example, play, paused, or direction changed) from the Configure and Play Animation behavior and triggers an action behavior when the condition is met.

Common Properties

When this condition is used in a global state machine, the event dispatch strategy of 'Configure and Play Animation Behavior' must be set to bubble or tunnel.

Check Enter or Exit

Expects an EnterExit Event (generated by Edit Text Behavior) and returns either a positive or negative response.

Common Properties

Check Interval Switch

Checks if the visualization state from the IntervalSwitch behavior matches the configured state (On or Off). Triggers an action when the condition is met. Can be used to check the state of a IntervalSwitch behavior.

Common Properties

Check Selection ID

Compares the ID from the ChangeSelectionEvent with the ID from its own Control.

Common Properties

Check Control State

Checks a specific state event generated by the ControlState behavior (pressed, enabled, etc.) in conjunction with the configured state and condition (e.g. pressed and is true). If the condition is met, an action behavior is triggered.

Common Properties

Check Timer

See also: Start Timer, OnTimer

Checks the time (in milliseconds) received from the StartTimer behavior. If the timer reaches the configured delay, it invokes an Action behavior. Can be used as a transition condition in a state machine.

Common Properties

Check Changed Value

Evaluates the configured value condition. To be used within a trigger behavior to trigger a certain action if the value matches the condition.

Common Properties

Check Processed Value

Checks whether a Value meets certain condition.

The following values can take part in the comparison, depending on the Operation Mode selected:

Example Usage

Common Properties

Check Video State

Checks the state of an VideoStateEvent received from an 'Video Stream Behavior'.

Expects a VideoState event (generated by Video Stream Behavior) and evaluates the configured state condition. To be used within a trigger behavior.

Common Properties

Input Condition Behaviors

Check Click

Evaluates the configured click event condition. To be used within a trigger behavior to trigger a certain action.

Example Usage

Common Properties

Check Drag Drop

Evaluates the configured DragDrop event condition. To be used within a trigger behavior to trigger a certain action.

Common Properties

Check Hover

Evaluates the configured Hover event condition. To be used within a trigger behavior to trigger a certain action.

Common Properties

Check Key Input

Checks a received KeyEvent (Control or Node with ControlStateBehavior / 'Handle Control State' must have focus).

Common Properties

Advanced Properties

Check Pressed

Evaluates the configured Pressed event condition. To be used within a trigger behavior to trigger a certain action.

Common Properties

Swipe Gesture

The swipe condition checks if a swipe/flick has been performed according to the configured settings.

Configuration

The type of swipe event and the direction can be configured. By default, it is configured to the end of the swipe (removing the finger from the screen) in any direction. Other configurations are:

Begin

The finger has touched the control and moved over the threshold.

Swiping

The swipe is in progress and the finger is moving over the screen.

Flick

In addition to the Swipe End a Swipe Flick will be sent if the velocity at the Swipe End exceeds the flick velocity threshold.

Abort

An external actor has aborted the swipe. The finger is still on the screen. But the gesture detector will no longer process the swipe gesture. This can be caused for example when a behavior is taking exclusive control over the touch event handling. Like the list behavior does it when it enters touch based scrolling mode.

To limit the condition to a certain direction just enable the direction. The default will be set to left (e.g. a next gesture in a menu screen or delete gesture in a message list). You can change it to Right, Up or Down. The direction is always in the local coordinate system of your control (e.g. if you have to implement a UI for a rotated display you will still receive the swipe up event even if it is swipe right in the display coordinate system).

Common Properties

Transform Gesture

Use this condition to trigger actions in an event handler whenever a transform gesture has been detected (pan, pinch and rotate).

Common Properties

This behavior does not have any configurable properties.

---

Logic Condition Behaviors

Check Logic Condition

The logic condition combines multiple conditions with the configured logical operation.

Common Properties

Check Not Condition

Acts as a 'NOT' operand by inverting a value returned by a ConditionBehavior and returns it.

Common Properties

---

Scroll Condition Behaviors

Check Scroll Condition

Evaluates the configured ScrollableDirectionChanged event condition. The event gets sent from Scroll View Behavior. To be used within a trigger behavior to trigger a certain action.

Common Properties

---

Check Culture Change

Class Reference

Checks if the culture has changed. This condition is satisfied when the culture matches the culture ID specified in the Local property, and an action behavior is subsequently invoked. Can be used to change the text culture with a button press.

Common Properties

Control Behaviors

Construction Kit Control Behaviors

Map Control Behaviors

Map

Provides the map rendering and navigation functionality.

Common Properties

Map Bridge

Builds a bridge to MapBehavior forwarding touch events.

Common Properties

---

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

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

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

Snap List Item Configuration

Allows the user to define the snap position of a list or list item by setting its item alignment (for example, Center) and offset. This is then applied when navigating or scrolling to align the list item. Can be used with 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.

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

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

---

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

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

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

---

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

Handle Control State

Manages how a control responds to user actions like clicks, touches, or hover. Sends state events when the control is pressed, selected, or highlighted. State conditions behaviors react to these events to update the control accordingly.

Example Usage

Common Properties

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.

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

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

---

Public Property Control Behaviors

Provide Alignment

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

Common Properties

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

Provide Color

Sets the color of a 2D node with a Color effect (e.g. BitmapBrushColorBlend, SolidColorBrush, MVGRender) or the diffuse color of a material in 3D.

Common Properties

Advanced Properties

Provide Margin

Provides property to set the margin. Especially for Controls.

Common Properties

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

Render Node

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

Common Properties

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

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

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

---

Align Pivot

Aligns all child nodes according to their pivot point.

Example Usage

Common Properties

This behavior does not have any configurable properties.

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

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

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

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

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.

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.

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

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.

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.

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

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

IntervalSwitch

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

Common Properties

Keyboard

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

This behavior is available for 2D scenes only.

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.

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.

This behavior is available for 2D scenes only.

Common Properties

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.

This behavior is available for 2D scenes only.

Common Properties

Navigation Instruction View

Behavior for displaying the instructions during navigation.

Common Properties

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

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

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

Orbit Camera Transform

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

And the options to limit the movement of the camera to specific parts of the spherical orbit. Setting the flag IsOrbitLimited allows the user to set minimum and maximum angles between the camera and the axes of the coordinate system, preventing the camera from moving too close to an axis. In this way, the user can define unwanted areas that the camera cannot move to, e.g., below the ground.

Common Properties

Advanced Properties

Property Name	Type	Description
IsOrbitLimited	bool	Enables setting of boundaries for the camera within the orbit.
AngleMinX	FeatStd::Float	Min angle between camera and X-axis (from 0 to 180 degrees). Must be less than AngleMaxX.
AngleMaxX	FeatStd::Float	Max angle between camera and X-axis (from 0 to 180 degrees). Must be greater than AngleMinX.
AngleMinY	FeatStd::Float	Min angle between camera and Y-axis (from 0 to 180 degrees). Must be less than AngleMaxY.
AngleMaxY	FeatStd::Float	Max angle between camera and Y-axis (from 0 to 180 degrees). Must be greater than AngleMinY.
AngleMinZ	FeatStd::Float	Min angle between camera and Z-axis (from 0 to 180 degrees). Must be less than AngleMaxZ.
AngleMaxZ	FeatStd::Float	Max angle between camera and Z-axis (from 0 to 180 degrees). Must be greater than AngleMinZ.

Page Indicator

Class Reference

Send events to a PageIndicator behavior to update its state. Can change the number of pages, set the active page, or activate a specific dot via external controls or PageIndicatorElement. This behavior is available for 2D scenes only.

Common Properties

Rectangle Clipping Behavior

Clips the control to given rectangle.

Common Properties

Roll

Class Reference

Displays a list of float values within a specified range, and lets the user select a value by rolling with touch or scrolling via configured arrow keys. This behavior is available for 2D scenes only.

Common Properties

Advanced Properties

Touch Indication

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

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.

This behavior is available for 2D scenes only.

Common Properties

Event Handler

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

Example Usage

Common Properties

Virtual Key

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

Common Properties

---

Demonstration

Demo Mode Action

Action to start or end the demo mode.

Common Properties

Demo Mode Execution

Execution of user input simulation.

Common Properties

Demo Mode Changed

Condition which reacts on 'activated' or 'deactivated' demo mode.

Common Properties

Demo Mode Check Input type

Condition behavior which reacts on input in respect of whether it is simulated input or not.

Common Properties

Demo Mode Record Action

Action to start or end the demo mode recording.

Common Properties

Demo Mode Recording

Execution of user input recording.

Common Properties

External Resource

This page explains how to use the behaviors that operate on external resources (such as images) located outside the Scene Composer solution: External Bitmap Provider, Set External Bitmap and Check External Resource Change.

For how to reference external resource files, see Referencing external resource.

A new FileSystemResourceManager (identified as FileSystem) has been introduced, extending the functionality of the External Resource Behaviors (such as Set External Bitmap and External Bitmap Provider), removing execution device restrictions. These behaviors are now available across all platforms. This allows users to dynamically load image files, such as PNG and JPEG files, from the file system at runtime using relative paths, without embedding them in the asset binary file. This functionality is primarily used for setting images on 2D Bitmap Nodes. Since the ExternalResourceManager ID property defaults to AndroidSystem, users must manually enter "FileSystem" as the value to enable file system resource support.

For further details and limitations, please refer to the External Image Behavior page.

 

Use cases

• Render external images: Preview images residing under an Android Studio project in Scene Composer and verify the display in Player.

• Switch the displayed image from the UI: Attach External Bitmap Provider to a bitmap node, then use a button with Set External Bitmap to switch the image according to ExternalResourceId.

• Detect external-resource changes: Use Check External Resource Change to detect changes in the external resource setup and reload cached external objects as needed.

---

Action External Resource Behavior

Set External Bitmap

Sets ExternalResourceId and ExternalResourceManagerId properties of an associated ExternalBitmapProvider when its action is triggered.

Common Properties

Property Name	Type	Description
ExternalResourceId	String	Full path to resource. (A unique ID to be provided.) If the ExternalResourceManagerId is Android, provide the full path to the resource (a unique ID should be specified). If the ExternalResourceManagerId is FileSystemExternal, provide the file system path in .png or .jpg format.
ExternalResourceManagerId	String	External resource manager ID. (e.g., Android, FileSystem) used to retrieve the external resource.
ImageProvider	ExternalBitmapProviderBehavior*	External Bitmap Provider Behavior which sets an external image on a node and is the target receiving set resource on action.

Condition External Resource Behavior

Check External Resource Change

Checks is external resource setup changed if test pass need to reload extand whole cache for external objects needs reload.

Reacts on ExternalResourceEvent if and only if the ExternalResourceId and ExternalResourceManagerId of the event match the condition’s properties, triggering the associated action.

Common Properties

Property Name	Type	Description
ExternalResourceId	String	External resource name ID. (A unique ID to be provided.)
ExternalResourceManagerId	String	External resource manager ID. (A unique ID to retrieve the external resource from.)

Value Processing External Resource Behavior

External Bitmap Provider

Sets an image on a Render Node based on External resource Id. Retrieves an external bitmap with ExternalResourceId from an external resource provider with ExternalResourceManagerId and provides the bitmap to an associated bitmap node.

Common Properties

Property Name	Type	Description
TargetNode	Candera::AbstractNodePointer	The Node which is modified. If not set, then the node where the behavior is attached to, will be modified.
ExternalResourceId	String	Full path to resource. (A unique id of an external resource to be provided.) If the ExternalResourceManagerId is Android, provide the full path to the resource (a unique ID should be specified). If the ExternalResourceManagerId is FileSystemExternal, provide the file system path in *.*png or .jpg format.
ExternalResourceManagerId	String	External resource manager ID. (e.g., Android, FileSystem) used to retrieve the external resource.

---

Example Usage of External Resource Behaviors

Here is an example of the use of each External Resource behavior.

How to reference external resources

For information on referencing external resource files, see Referencing external resource. The following usage example uses an external resource that was loaded into the solution during this operation.

External Bitmap Provider

1. Drag and drop the [ Node 2D > Bitmap Node ] from the toolbox onto the scene editor, or the scene tree.
   
   
2. Attach [ Behavior > External Resource > Value Processing > External Bitmap Provider ] in the Toolbox to the Behavior in the Extra Scene Tree of the placed bitmap node by drag-and-drop operation.
   
   
   
   
3. Click External Bitmap Provider behavior and and specify the target image file to ExternalResourceId in the properties panel that appears. ExternalResourceId can be set in the following two ways.
   1. • Enter the resource ID directly into the ExternalResourceId text box.
      • Press the select item button on the right side of ExternalResourceId, select the target file from the displayed dialog box, and press the [ OK ] button.
        
        
        
        
        
4. The selected external resource will appear in the scene editor.
   • Save the solution and launch Player to confirm that this external resource is displayed.

Set External Bitmap

1. Drag and drop the [ Node 2D > Bitmap Node ] from the toolbox onto the scene editor, or the scene tree.
   
   
2. Attach [ Behavior > External Resource > Value Processing > External Bitmap Provider ] in the Toolbox to the Behavior in the Extra Scene Tree of the placed bitmap node by drag-and-drop operation.
   
   
   
   
3. Drag and drop the [ Controls > Touchable > Button ] from the toolbox onto the scene editor, or the scene tree. Take place this operation twice (add two button control nodes).
   
   
4. Attach [ Behavior > External Resource > Action > Set External Bitmap ] in the Toolbox to the Actions in the Extra Scene Tree of the placed Button control nodes by drag-and-drop operation.
   
   
   
   
   
5. Select the Button control, then select the Set External Bitmap behavior in the Extra Scene tree that appears.
   
   
6. Click the select item button on the ImageProvider in the properties panel that appears and select the External Bitmap Provider connected to the BitmapNode (this operation is performed for the two Button controls).
   
   
   
   
7. Select the Button control, then select the Set External Bitmap behavior in the Extra Scene tree that appears.
   
   
8. Click the select item button on the ExternalResourceId in the properties panel that appears and select the External Bitmap Provider connected to the BitmapNode (this operation is performed for the two Button controls).
   
   
   
   
   
9. Run the player and press the placed buttons. By pressing each button, the image specified in Set External Bitmap will be displayed. 
   
   
   
   

Check External Resource Change

1. Drag and drop the [ Node 2D > Bitmap Node ] from the toolbox onto the scene editor, or the scene tree.
   
   
2. Attach [ Behavior > External Resource > Value Processing > External Bitmap Provider ] in the Toolbox to the Behavior in the Extra Scene Tree of the placed bitmap node by drag-and-drop operation.
   
   
3. Select Scene2D in the scene tree and attach [ Behaviors > Control > Event Handler ] to the displayed extra scene tree by drag-and-drop operation.
   
   
   
   
   
4. Select the Scene2D in the scene tree, in the displayed extra scene tree, attach [ Behavior > External Resource > Condition > Check External Resource Change ] to the Condition of the Event Handler by drag-and-drop operation.
   
   
   
   
   
5. Select the Scene2D in the scene tree, in the displayed extra scene tree, attach [ Behavior > External Resource > Action > Set External Bitmap ] to the Actions of the Event Handler by drag-and-drop operation.
   
   

   
   

6. Select the Set External Bitmap behavior you added.
   
   
7. Click the select item button on the ImageProvider in the properties panel that appears and select the External Bitmap Provider connected to the BitmapNode.
   
   
   
   
8. Select the Set External Bitmap behavior you added.
   
   
9. Click External Bitmap Provider behavior and and specify the target image file to ExternalResourceId in the properties panel that appears. ExternalResourceId can be set in the following two ways.
   • Enter the resource ID directly into the ExternalResourceId text box.
   • Press the select item button on the right side of ExternalResourceId, select the target file from the displayed dialog box, and press the [ OK ] button.
     
     
10. Select Check External Resource Change in the Event Handler.
    
    
11. Click the Select Item button for ExternalResourceId in the Properties panel that appears and select any external resource specified in step 9.
    
    
12. Each time the image definition is changed, the displayed image should be updated.
    
    

Graph

Bar Graph

Creates a bar graph based on a provided list of numeric values, with configurable bar width, height, spacing between bars, and color for each value. This behavior is available for 2D scenes only.

Common Properties

Line Graph

Draws a 2D line using a list of values with a specified width and color. Displays the result in the scene. Can be attached to a group node. This behavior is available for 2D scenes only.

Common Properties

IdentifierValueMap

Behaviors that can be used to check for certain keys and values in IdentifierValueMapEvents and execute actions accordingly. Such events are sent from application code to the node or behavior.

Mapped Value Action

Extracts and sends the value from a key-value pair inside an incoming map as value changed event.

Common Properties

Advanced Properties

Property Name	Type	Description
Action	Candera::ActionBehaviorArrayProperty	The set of ActionBehaviors that receive the value changed event.

Mapped Key Condition

Checks the key from a key-value pair inside an incoming Identifier Value Map Event.

Common Properties

Layer

Switch Layer Image

Sets on an Image Layer. This special functionality is only available for Amber and Traveo2 platform due to hardware support.

This behavior is available for 2D scenes only.

Common Properties

Map

Geocoding

Provides forward and reverse geocoding functionality.

About implicit roles of ChildNodes

• For forward geocoding the text from a child node with name "Name" is used.
  
• For backward geocoding the text from a child node with name "Address" is used.
  
• The child nodes should be of type Node2D with one child TextNode2D.

Common Properties

Mixed Reality Behaviors

Internal

Poi Metadata Handler

Behavior that handles the meta data of a single poi.

This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
IconNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.
NameNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.
OpenNowNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.
RatingNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.
PriceLevelNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.
InfoTextNodes	ArrayProperty<Candera::AbstractNodePointer>	A process value event is sent to this nodes, if a respective poi update event arrives.

---

Distance Alpha Fading

Description

Distance Alpha Fading is a Behavior Building Block available in Construction Kit.

It receives a value representing the camera position and performs arithmetic operations on it to calculate target node alpha value.

The following operations are performed on input value:

Common Properties

Navigation Path

Registers to navigation points and displays them as mesh in world space.

This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
ColorMode	ColorMode::Enum	Select how color is displayed. Possible values: Color, RGBA
Color	Candera::Color	Determines the color of the mesh.
Width	FeatStd::Float	Determines the width of the mesh.
Length	FeatStd::Float	Determines the length of the mesh
YOffset	FeatStd::Float	Applies y-offset to the mesh.
InputPoints	ListPropertyType< CgiStudioControl::Internal::AR::ArPoint>	This property is used to bind input points.
InputPointHandling	InputPointHandling::Enum	Determines how new input points are used for the mesh. Possible values. Attach, Replace
InterpolationType	InterpolationType::Enum	Determines which interpolation method is used. Possible values: Linear, Bezier, Spline, None
MeshType	MeshType::Enum	Determines which primitive type is used. Possible values: Solid, Points
IsAdvanced	bool	Enables advanced settings of the behavior.

Advanced Properties

Property Name	Type	Description
Red	FeatStd::UInt32	Red color channel. This property is only available if 'ColorMode' is set to 'RGBA'.
Green	FeatStd::UInt32	Green color channel. This property is only available if 'ColorMode' is set to 'RGBA'.
Blue	FeatStd::UInt32	Blue color channel. This property is only available if 'ColorMode' is set to 'RGBA'.
Alpha	FeatStd::UInt32	Alpha color channel. This property is only available if 'ColorMode' is set to 'RGBA'.
InputPointMinDistance	FeatStd::Float	Minimum distance of two control points. Input points that are closer together will be rejected. This property is only available if 'IsAdvanced' is checked.
ReqFragmentSize	FeatStd::SizeType	Size of the fragment that is requested from the input point list. This property is only available if 'IsAdvanced' is checked.
ReqThresholdDistance	FeatStd::Float	If the distance between camera and the last point is below this threshold, request a new fragment of input points. This property is only available if 'IsAdvanced' is checked.
PointSize	FeatStd::Float	Determines the point size. This property is only available if 'MeshType' is set to 'Points'.
NumOfRowsPerInputPoint	FeatStd::UInt32	Determines how many vertex rows are used to interpolate between two input points. Increasing this value makes the mesh smoother, but will also shorten the distance of the overlay, as number of vertices per row remain constant. This property is only available if 'IsAdvanced' is checked and 'InterpolationType' is set to 'None'.
NumOfVertexRows	FeatStd::UInt32	Amount of vertical vertices in the mesh. This property is only available if 'IsAdvanced' is checked.
NumOfVertexColums	FeatStd::UInt32	Amount of horizontal vertices in the mesh. This property is only available if 'IsAdvanced' is checked.

Poi Configuration

Behavior that configures the mapping of a name to a assetId, such that it can be found by the PoiFactory.

This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
PoiName	FeatStd::UInt32	Name of this poi.
PoiControlAssetId	FeatStd::UInt32	ID of the control that is associated with PoiName.

Poi Manager

Manager of the poi control nodes.

This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
StreetPoints	ListPropertyType<CgiStudioControl::Internal::AR::ArPoint>	List of points of the street. Used to align the rotation of POIs.
StreetPointsMinDistance	FeatStd::Float	Minimum distance between two street points. Street points that are closer together will be rejected.
ReqDistance	FeatStd::Float	The distance in which POIs are requested from the model.
ReqThresholdDistance	FeatStd::Float	Once the camera has moved this specified distance a new request will be sent.
PoiMetaData	ArrayProperty<FeatStd::String>	Use databinding to receive metadata updates for the POIs

Pose Tracking

Behavior that sets the pose of a target node.

This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
Position	Candera::Vector3	Position on the target node.
Rotation	Candera::Vector3	Rotation on the target node.
EnableUserControl	bool	Enable to use WASD control to navigate the camera instead of databinding.
EventReceivers	ArrayProperty<Candera::AbstractNodePointer>	List of nodes that will receive position and rotation update events.

Particle

Particle Emitter

Emits Particles when attached to a Node with a Bounding Box. The Appearance of the Node will be used for the Particles and needs to be configured as specified in the Documentation.

This behavior is available for 3D scenes only.

Emitter Settings

Particle Settings

Property Name	Type	Description
Life Time	UInt32	Determines how long a particle will live in Milliseconds.
Random Life Time	UInt32	Determines how long a particle will live in Milliseconds.
Velocity	Candera::Vector3	Determines the initial velocity of an emitted particle.
Gravity	Candera::Vector3	Determines the gravity effects for all emitted particles.
Random Spread	Float	Determines how the randomness of the initial velocity angle.
Start Size	Float	Determines how big a particle will be when it is emitted.
End Size	Float	Determines how big a particle will be when it vanishes.
Start Color	Candera::Color	Determines what color a particle has be when it is emitted.
End Color	Candera::Color	Determines what color a particle has when it vanishes.
Fade In Time	Optional<FeatStd::UInt32>	Determines how long a new particle needs to be alive until it is fully visible.
Fade Out Time	Optional<FeatStd::UInt32>	Determines how long a particle will fade out before it vanishes.

Scripting Behaviors

Enable Scripting System

Enables or disables the scripting system. For example, dragging and dropping to the scene tree disables script system execution at runtime using a checkbox, and it can be enabled again using the same checkbox.

Property Name	Type	Description
Enabled	bool	Enables/disables the scripting system.

Set Script Parameters

This behavior allows users to set public variables of Lua scripts.

1. The value to set. Lua variables can have the following types:
   • bool
   • int64
   • double (if you have floats in the behavior, cast them to double)
   • char* (a null-terminated character string).

Property Name	Type	Description
ScriptParameterName	FeatStd::String	The name of the script parameter whose value will be set.
NodeWithScript	Candera::AbstractNodePointer	Node whose script parameter will be changed.

 

Set Script Property as Animation Property

Binds an Animation to a declared Animation property inside a script's table. The 'PropertyName' has to match the Animation property name in the script and 'Animation' sets the actual Animation value. This Behavior as well as the script need to be placed on the same node. Multiple instances of this Behavior on a node can handle the respective amount of script Animation properties.

Common Properties

State Machine Behaviors

State Machine

A state machine is able to implement the complex states of a node/scene/application (including sub state machines and history state machines). Transitions with conditions and actions are used to change between states.

Common Properties

Streaming Behaviors

Video Stream

Class Reference

Displays a video stream from a given source on a texture. Reacts on VideoControl events (see also Configure and Play Stream), and emits VideoState events (see also Check Video State).

Common Properties

Value Processing Behaviors

Animation Value Processing Behaviors

Jump to Animation Keyframe

Expects a Float value between 0 and 1 (inclusive) as an event. Sets a selected animation to a frame corresponding to the value that the AnimationProcessValueBehavior receives.

Common Properties

Diagnostics Value Processing Behaviors

Frame Measurement

Class Reference

Outputs Frame Measure information of the specified Render Target. These Measurements can be Frames Per Seconds, Current Frame and Frame Time. This Behavior acts as Source for Process Value Behaviors.

Common Properties

---

Effects Value Processing Behaviors

Set Alpha Value

Sets the Alpha value of a node (expects a Float value).

Common Properties

Switch Image

Sets an image on a Render Node based on a float index received as event.

Supports

Example Usage

Common Properties

Switch Text

Sets a text on a Render Node based on a float index received as event.

Common Properties

Zoom Effect

Expects a Float value between 0 and 1 (inclusive) as an event. Applies scale and alpha on children of a group.

Common Properties

---

Transformation Value Processing Behaviors

Resize Group Node

Expects a Float value as an event, and changes the layout size of a group node it is placed on. When mode is 'Relative' it scales the layout size (expected value is a normalized value). When mode is 'Absolute' the layout size is set in pixels.

Common Properties

Set Node Size

Expects a Float value as an event. Sets the layout size of a node on a given axis by the received value in pixels.

Common Properties

Set Position

Expects a Float value as an event. Translates Position Node along given axis by the received value in pixels.

Example Usage

Common Properties

Set Rotation

Expects a Float value as an event. Rotates Rotation Node clockwise by the received value in degrees.

Example Usage

Common Properties

Set Scale

Expects a Float value as an event. Scales Scaled Node by the received (scalar) value multiplied by Vector (X value for horizontal scaling, Y value for vertical scaling). Scaling along either axis can be enabled or disabled.

Example Usage

Common Properties

Move Node

Expects a Float value as an event. Translates Translated Node by the received (scalar) value multiplied by Vector X Y (Z).

Example Usage

Common Properties

---

AnimationMeter

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior. Controls an animation according to the passed value.

Property Name	Type	Description
Animation	Candera::Animation::AnimationPlayer	TThe animation controlled. AnimtionMeter sets the animation to the frame corresponding to a mapped value it receives.
Minimum	FeatStd::Variant	Minimum of the Variant value which will be mapped between 0 and 1.
Maximum	FeatStd::Variant	Maximum of the Variant value which will be mapped between 0 and 1.

Arithmetic Operation

Arithmetic operation behavior allows to perform addition, subtraction, multiplication and division operations on the passed value.

Common Properties

Clock

Converts a time integer into seconds, minutes and hours and passes those values to behavior-properties.

Common Properties

Dial

Receives an angle from a ProcessValueEvent or a value in a ChangeValueEvent. The knob changes its rotation according to that angle. The Behavior Transmits the changed value through events (ValueChangedEvent and ProcessValueEvent).

This behavior is available for 2D scenes only.

Common Properties

Filter

Filters the processed value via an attached Condition (e.g. Check processed Value).

Common Properties

Forward Value

Forwards a received value to the associated target (associated controls with a value property). Receives a ValueChanged-Event (change notification) and forwards it as a ChangeValue-Event(change request) to the target. The common usecase is to send the Value from a Value behavior to another Value behavior(or Control with a Value). 

Emits a ChangeValueEvent which will be received by a Value Behavior.

Note that the target Value - Behavior must have 'Accept Value Event' property enabled.

Example Usage

Common Properties

Interpolate Value

Expects a Float value as an event. This behavior holds an internal Float value. It changes this internal value with given speed (Units Per Second) until it reaches the received value. Unless received value matches internal value, it sends internal value to a Process Value Behavior every frame.

If the Animation Mode property is set to Instant, no interpolation will be taking place - the received value will be applied immediately.

Example Usage

Common Properties

Map Value

Expects a Float value as an event. Maps the received value from one interval to another.

Common Properties

Map Value Normalized

Maps the numeric value received via 'ProcessValueEvent' within an arbitrary range to the normalized range from 0.0 to 1.0 and dispatches the result locally to its receivers. Receivers of this Behavior must therefore be value processing behaviors operating on normalized values.

Common Properties

Process Value Changed Event

This behavior handles ValueChanged events and processes the new value within a set of ProcessValueBehaviors chains. By default ProcessValueChangedBehavior does consume the event, which will result in dispatching the event any further in the dispatching strategy. If further dispatching of the ValueChangedEvent is required set the ConsumeEvent flag to false.

Example Usage

• Process Value Changed Event - Slider Example
• Process Value Changed Event - State Machine Example

Common Properties

Render a Range

This behavior is a Behavior Block. It can be dragged&dropped on nodes just like any Behavior. Renders a range of nodes according to the passed value.

Property Name	Type	Description
OperationMode	OperationModeType Enum	When set to MultipleNodes, EnableNodesProcessValueBehavior will enable the first N children of Group Node. When Operation Mode is set to SingleNode, only Nth node is enabled. N is a number from 0 to number of all children nodes of Group Node. It corresponds linearly to the value EnableNodesProcessValueBehavior receives.
Minimum	Optional< FeatStd::Variant >	Minimum of the Variant value which gets mapped between 0 and 1.
Maximum	Optional< FeatStd::Variant >	Maximum of the Variant value which gets mapped between 0 and 1.

 

Send ChangeValue on receiving ProcessValue event

Sends out a new value. Associated controls with a value property receive the new values.

Common Properties

Set Selected State

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

Sets the state to selected or deselected according to the passed value.

Smooth Value

Class Reference

Expects a numeric value as an event and applies exponent smoothing to that value and the previous calculated one.

Common Properties

Render Child Nodes

Enables/Disables Child nodes corresponding to the received value and the behavior settings.

Common Properties

Format String

'Format String' modifies the Text of a TextNode Node and provides the Text as property for Controls. It supports formatted text that can display one variable.

Example Usage

Common Properties

Track Angle on Drag

Listens to the touch of the selected node, returns the angle between pressing, moving and releasing.

Common Properties

Drag on Track to Value

Determines the position of a touch move in relation to the associated node and provides it as value in range from 0.0 to 1.0 (normalized). The horizontal boundary of the associated node is the track. The Dragged Node is used to determine the hit area and to determine the position change relative to its center. This behavior can be used as a source to a Value Behavior. Add a Value Behavior as a receiver.

Common Properties

Action on Value

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

Example Usage

Common Properties

Value

ValueBehavior sends a value to any behavior derived from ProcessValueBehavior type. It supplies an input to process value behaviors via event.

Example Usage

Common Properties

---

Value Generator

The Value Generator is a demo behavior. It allows you to configure minimum and maximum values, period, and update interval, and is used for UI verification and simulation purposes. It appears in the tool when CONTROLS_DEMO_BEHAVIORS_ENABLED is enabled via CMake.

Related page: Control Behaviors Flags

Common Properties

Property Name	Type	Description
GeneratorFunction	Enum	The type of function used to generate values (linear, sin, etc.)
Minimum	Float	The minimum for the generated values.
Maximum	Float	The maximum for the generated values.
OffsetMs	Int	The time offset where the function is evaluated.
PeriodMs	Int	The time period after which the generated values repeat.
SamplerateMs	Int	The update rate of the generated value.
GenerateValues	bool	Set this flag to true to generates values at sample rate. If set to false, no values are generated.
Event Dispatch Strategy	EventDispatchStrategyType::Enum	The way the event gets sent. Possible values: Direct, Broadcast, Bubble, Tunnel, DedicatedBehavior
Dedicated Behavior	Candera::ProcessValueBehavior*	The dedicated process value behavior that will receive the change value event. This property can be set in the right side of the Scene Tree panel.
Target Node	Candera::AbstractNodePointer	The target node to which the events are routed. If this property is not set, the event will be routed to the node of the behavior.

Set Uniform

Set Uniform

Sets the value of a specified uniform using the received input on a shader associated with a given node (NodeWithShader). The input value can be received from a value behavior. This behavior is available for 3D scenes only.

Common Properties

Property Name	Type	Description
Uniform Name	FeatStd::String	The name of the uniform whose value will be set.
Node With Shader	Candera::Node*	Node whose uniform setter's property will be changed.

BehaviorGroup

BehaviorGroup (Fusion Group) is used to group multiple behaviors (Fusion nodes). This simplifies the organization of behaviors (Fusion nodes) in the extra scene tree and on the Fusion diagram, and makes overall management easier. Once created, BehaviorGroups can be renamed to anything you want and duplicated for other uses.

A similar function is the BehaviorBuildingBlock, which can be instantiated by creating a template. For this reason, BehaviorGroup is easier and faster to use.

 

How to use

1. Add a BehaviorGroup to the extra scene tree of the target node by dragging and dropping it from the Behaviors in the Toolbox panel.
   • A Fusion Group node will also be added on the target node's Fusion diagram (connected to the top node).
     
2. After selecting the behavior to be added, copy and paste it into the BehaviorGroup.
   • It will be added in the same way on the Fusion diagram.

 

Renaming

After selecting the target BehaviorGroup in the extrascene tree, rename it in one of the following ways

• Select [ Rename ] from the context menu.
  
• Change [ General > Name ] in the properties panel.

 

Copy

After selecting the target BehaviorGroup in the extrascene tree, select [ Copy ] from the context menu and execute [ Paste ] at the any location.