Add New Item

Animation

Adds a new animation to the solution.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Play direction Specifies the playback direction of the animation.
  • Forward: Plays the animation in the forward direction.
  • Reverse: Plays the animation in the reverse direction.
Speed Factor Sets the multiplier that increases or decreases the playback speed of the animation.
Repeat Times Sets the number of times the animation repeats. Repeat means that the animation plays again after it ends. The default value is 1, which means the animation does not repeat. When you set the value to 0, the animation plays infinitely. Note that this property has no effect in Scene Composer.
Repeat Mode Specifies the playback mode that applies when the animation repeats.
  • Replay: After playing to the end, the animation plays again from the beginning.
  • Bounce: After playing to the end, the animation reverses direction and plays back.

AnimationGroup

Adds a new animation group to the solution. Use an animation group to handle multiple animations together as a single group.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Speed Factor Sets the multiplier that increases or decreases the playback speed of the entire animation group.

AssetProfile

Adds a new asset profile to the solution. The system references this profile during asset generation and uses it in combination with the asset file path and the asset ID.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item. The system references this name through the `$AssetProfileName` macro variable during asset generation.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.

BehaviorBuildingBlock

This item adds a new Behavior Building Block to the solution. Use a Behavior Building Block to nest multiple behaviors into a single block and handle that block as a reusable component.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item in the Behaviors section.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

BitmapProfile

A bitmap profile defines how a Bitmap resource is converted. Add a new bitmap profile to the solution and configure its Converter, Format, and Origin properties. You can then reference the bitmap profile from the properties of a Bitmap resource, or when importing a Bitmap resource (from the FBX, image, solution, or PSD import panel).

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Converter The system converts the exported bitmap with the converter specified here.
  • (Empty): Not specified
  • DefaultBitmapConverter
  • ArtInChipBitmapConverter
  • AstcBitmapConverter
  • RZA1HBitmapConverter
  • Traveo2BitmapConverter
  • VGLiteBitmapConverter

Note: Depending on which platform plugins are enabled, converters other than those listed above, such as RT117XBitmapConverter, might appear.

Format The system converts the exported bitmap to the format (pixel format) specified here. The available values change according to the `Converter` selection.
Origin Configures the pixel layout in the asset. When you select PlatformDependent, the system uses the platform setting of the corresponding engine according to the intended use of the bitmap (2D or 3D). If neither use applies, the system exports the imported content without flipping it.
  • PlatformDependent: Uses the platform setting of the corresponding engine according to the intended use (2D or 3D).
  • OpenGL: Uses an OpenGL-compatible pixel layout.
  • ReversedOpenGL: Uses a vertically flipped OpenGL-compatible pixel layout.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.

Format

The Format options change according to the value selected for Converter. The following sections list the options for each converter.

When DefaultBitmapConverter is selected

When ArtInChipBitmapConverter is selected

When AstcBitmapConverter is selected

When RZA1HBitmapConverter is selected

When Traveo2BitmapConverter is selected

Because the number of options is very large, the following list shows representative options.

When VGLiteBitmapConverter is selected

CameraGroup

Adds a new camera group to the solution. By grouping multiple cameras, you can enable or disable rendering for the entire group at once.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

CanvasControl

Adds a new canvas control to the solution. The system creates the control with Is Canvas Control enabled.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Is Canvas Control Indicates whether the control is of type Canvas. The system creates a CanvasControl item with this property enabled.

ClearMode

Adds a new clear mode to the solution. A clear mode groups the clear-related properties of a render target into a single item, and you can reference it from the ClearMode property of a render target.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Enable Color Clear Specifies whether color clearing is enabled.
Enable Depth Clear Specifies whether depth clearing is enabled.
Enable Stencil Clear Specifies whether stencil clearing is enabled.

ConditionBlock

Adds a new Condition Block to the solution. In the Condition Editor, you build a logical expression for the created Condition Block by placing and connecting Check, AND, OR, and NOT nodes. You can then reference the Condition Block from the Action Chain Editor or from the Condition property of a behavior.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

Control2D

Adds a new 2D control to the solution.

For the procedure to create a control, refer to Create Controls.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

Control3D

Adds a new 3D control to the solution.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Is Canvas Control Indicates whether the control is of type Canvas.

EditorProfile

Adds a new editor profile to the solution. You associate the editor profile with a scene, and the scene references it through its Editor Profile property. By associating an EditorProfile you have created with a scene or a control, you can assign individual Editor Options to each EditorProfile.

For details on how to configure an EditorProfile, refer to SCML Editor.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.

RenderTarget

Adds a new render target to the solution. In Render Target Template, you select the type of render target to create.

For render targets, also refer to Add a new Render Target.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset. When enabled, the system always exports the item during asset generation.
Render Target Template Specifies the render target template, which is the type of the item as defined in Candera.
  • Hybrid 2D/3D Window Surface: Creates the render target as a window surface that appears on the screen.
  • Hybrid 2D/3D Off-Screen Surface: Creates the render target as an off-screen surface, which you can reuse as a texture.
  • Software Layer: Creates the render target as a software layer.
Display Specifies the display that the render target links to. You can set this property only when `Render Target Template` is `Hybrid 2D/3D Window Surface`.
  • Display: Links the render target to the standard display.
  • (Empty): Not specified

SafetyScene

Adds a new safety scene to the solution. The system creates the scene as a scene that supports the functional safety of the solution. 

This panel is displayed only if the safety feature is enabled in the Using Licenses panel.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Is Locked Specifies whether the item is locked.
IsView Specifies whether the scene is also used as a View.

Scene2D

Adds a new 2D scene to the solution. You can choose whether to create an empty scene or to create the scene from an available scene template.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Is Locked Specifies whether the item is locked.
IsView Specifies whether the scene is also used as a View.
Is Template When you enable this option, the scene becomes a template for creating other scenes.
Add Camera Specifies whether to add a camera to the new scene.
Create empty scene / Use available scene template Provides radio buttons that switch the creation method of the new scene.
  • Select Create empty scene to create an empty scene.
  • Select Use available scene template to choose a template from the template tree at the bottom.
Search Provides a field that searches the template tree.
Template tree Displays a tree view that lets you select the source template when you select Use available scene template.

Scene3D

Adds a new 3D scene to the solution. You can choose whether to create an empty scene or to create the scene from an available scene template.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Is Locked Specifies whether the item is locked.
IsView Specifies whether the scene is also used as a View.
Is Template When you enable this option, the scene becomes a template for creating other scenes.
Add Camera Specifies whether to add a camera to the new scene.
Create empty scene / Use available scene template Provides radio buttons that switch the creation method of the new scene.
  • Select Create empty scene to create an empty scene.
  • Select Use available scene template to choose a template from the template tree at the bottom.
Search Provides a field that searches the template tree.
Template tree Displays a tree view that lets you select the source template when you select Use available scene template.

Script

Adds a new script to the solution. You select Empty, Basic, or Full as the code template. The system adds the created script to the solution as a file with the .lua extension.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Code Template Selects the type of code template that you use when you create the script.
  • Empty: An empty template that contains no code.
  • Basic: A code template that contains the commonly used callback functions.
  • Full: A code template that contains the complete set of callback functions that you implement.

Shader

Adds a new shader to the solution. Use the toggle icons in Type to select whether to create a fragment shader or a vertex shader. A shader program then references the created shader.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Type Specifies the type of shader to create. The two icons on the left and the right switch between a fragment shader and a vertex shader.
  • Fragment shader
  • Vertex shader

ShaderProgram

Adds a new shader program to the solution. The shader program pairs a fragment shader with a vertex shader, and you can apply it to the appearance of a node.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Category Specifies the category that the new item belongs to. The Toolbox uses this category to classify the item.
Order Index The Toolbox uses the Order Index to sort controls.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Fragment Shader A shader program that runs on the GPU (Graphics Processing Unit) to perform complex per-pixel effects. You select the fragment shader from the fragment shaders listed in the Shader panel, that is, the `Shader` items defined in the solution whose `Type` is fragment shader.
Vertex Shader A shader program that runs on the GPU (Graphics Processing Unit) to perform complex per-vertex effects. You select the vertex shader from the vertex shaders listed in the Shader panel, that is, the Shader items defined in the solution whose Type is vertex shader.

StateMachine

Adds a new state machine to the solution. In the State Machine Editor, you define the States and the Transitions of the created state machine.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

TextStyle

Adds a new text style to the solution. The Style property of a 2D Text Node and the TextStyle property of controls such as the text control and the text button control reference this text style.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Replacement Character Specifies the character that the system uses as a substitute when the requested character is not available in the font. The default value is U+FFFD.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.
Base Style Specifies the base Style. A GetFont method call for a code point in a range that is not defined in a StyleEntry is resolved by the base Style specified here. The following are typical styles included in the ConstructionKit (they may differ depending on your environment).
  • ConstructionKit.ArabicRegularStyle
  • ConstructionKit.EnglishRegularStyle
  • ConstructionKit.JapaneseRegularStyle
  • ConstructionKit.KoreanRegularStyle
  • ConstructionKit.OpenSans25 / OpenSans35 / OpenSans96
  • ConstructionKit.OpenSansRegular25 / OpenSansRegular35 / OpenSansRegular96
  • ConstructionKit.Roll Lens
  • ConstructionKit.SimplifiedChineseRegularStyle
  • ConstructionKit.ThaiRegularStyle
  • ConstructionKit.Vera25 / Vera32 / Vera96
Default Font Specifies the default font by path. When no base Style is defined, the GetFont method retrieves the default font specified here for code points that do not fall within any range defined in StyleEntry. Click the browse button on the right to select a font.

View

Adds a new View to the solution. In the View Definition Editor, you define the created View as a screen-level configuration by combining Scenes and existing Views.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.

ViewTree

Adds a new View Tree to the solution. On the created View Tree, you configure the screen transition logic by arranging multiple Views in a tree structure. During asset generation, the system outputs the configured tree structure as a Global State Machine.

Item Description
Destination path Specifies the folder in the solution where the system places the new item. Click Browse... to select an existing folder.
Name Sets the name of the new item.
Description Describes the new item in detail.
Annotations Serves as storage for notes and other project-related information. The system exports the entered text to the HMI report.
URI You can set any URI. If you enter a valid URI, clicking it launches the browser and displays the contents of the link.
Export Always Specifies whether the system always includes this item as part of the asset.