SCML Tags > 2D Scene Tags
2D Scene Tags
| Tag name | Property | Property type | Supported Values/Types |
Description |
|---|---|---|---|---|
| Anchor2D | AnchorDef | String |
Full name of the anchor definition from the composite which is used by this anchor node. |
|
| Position | Vector2 |
Position of the object in local coordinate space. |
||
| Rotation | Float | Null |
Rotation of the object in local coordinate space. |
|
| Scale | Vector2 |
Scale factor of the object in local coordinate space. |
||
| Pivot | Vector2 |
Pivot offset is the distance between the pivot point - defined by the "Position" property - and the origin of the element's bounding rectangle (upper left corner). The pivot point is used as center point for rotation and scaling. |
||
| BoundingRectangle | Rectangle |
The axis-aligned bounding rectangle in local coordinate space. |
||
| RenderOrderRank | SByte | Null |
By using the render order rank we can set the order of two or many nodes (with values on a range from -128 - the farthest render node - to 127 - the nearest node). |
|
| LayoutProperties | LayoutProperties |
Layout properties |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| AnchorDefinition | Node | String |
When expanding the composite node the content of the anchor will be put in this node. |
|
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Camera2D | RenderTargetName | String |
Name of the render target the camera renders to |
|
| Viewport | Rectangle |
The viewport describes an rectangular area that is updated within the associated render target. The viewport position and size are given in pixels. |
||
| IsColorClearEnabled | Boolean | Null, True, False |
Defines if camera shall clear the color buffer with the clear color before it renders. |
|
| ClearColor | Color |
If color clear is enabled, the clear color is applied to color buffer before camera is rendered (background color). The area cleared is defined by the viewport. |
||
| IsScissoringEnabled | Boolean | Null, True, False |
|
|
| ScissorRectangle | Rectangle |
The scissor rectangle specifies a rectangular region within the Camera's RenderTarget. The scissor rectangles position and size are given in pixels. A scissor rectangle that intersects the RenderTarget is allowed. If scissoring is enabled (see IsScissoringIsEnabled) pixels outside of the intersection area of viewport and scissor rectangle are clipped. |
||
| SequenceNumber | Int16 | Null |
Defines the position of the camera in the sequence of concurrently rendered cameras. A camera with lower sequence number is rendered before a camera with higher sequence number. |
|
| IsSwapEnabled | Boolean | Null, True, False |
Enables or disables a swap of Camera's render target after rendering has been processed. |
|
| IsRenderingInDisplayDesignEnabled | Boolean | Null, True, False |
Indicates if the rendering is enabled in the Display design |
|
| PreviewScissoringScope | PropertyValueScope | Null, None, Global, Local |
|
|
| PreviewScissoringColor | Color |
|
||
| Position | Vector2 |
Position of the object in local coordinate space. |
||
| Rotation | Float | Null |
Rotation of the object in local coordinate space. |
|
| Scale | Vector2 |
Scale factor of the object in local coordinate space. |
||
| Pivot | Vector2 |
Pivot offset is the distance between the pivot point - defined by the "Position" property - and the origin of the element's bounding rectangle (upper left corner). The pivot point is used as center point for rotation and scaling. |
||
| BoundingRectangle | Rectangle |
The axis-aligned bounding rectangle in local coordinate space. |
||
| RenderOrderRank | SByte | Null |
By using the render order rank we can set the order of two or many nodes (with values on a range from -128 - the farthest render node - to 127 - the nearest node). |
|
| LayoutProperties | LayoutProperties |
Layout properties |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Composite | IsCanvasComposite | Boolean | Null, True, False |
Indicates is the Composit is of type Canvas. |
| RenderOrderBins | Collection |
Collection of the render order bins |
||
| EditorClearColorScope | EditorClearColorScope | Null, None, Global, Local |
Scene editor clear color scope |
|
| EditorClearColor | Color |
Indicates the background color used with the scene editor camera. |
||
| Widgets | Collection |
Collection of widgets |
||
| EditorProfile | String |
The Editor Profile associated to the scene |
||
| Theme | String |
The theme. |
||
| Anchors | Collection |
Uniform setter. |
||
| CompositeProperties | Collection |
Collection of composite properties |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Composite2D | HorizontalGuidelines | FloatArray |
The horizontal guidelines displayed in the render panel. Drag a new one from the ruler. Drag an existing one outside the panel to remove it. |
|
| VerticalGuidelines | FloatArray |
The vertical guidelines displayed in the render panel. Drag a new one from the ruler. Drag an existing one outside the panel to remove it. |
||
| DesignMasterScope | PropertyValueScope | Null, None, Global, Local |
Configures the design master image for this scene. It can be used from the global preferences or any other bitmap from the solution. |
|
| DesignMasterName | String |
Bitmap used as background during scene editing. |
||
| DesignMasterPosition | DesignMasterPosition | Null, Background, Foreground |
The position of the design master image. |
|
| DesignMasterTransparency | Float | Null |
The transparency of the design master image. |
|
| EditorClearColorScope | EditorClearColorScope | Null, None, Global, Local |
Scene editor clear color scope |
|
| EditorClearColor | Color |
Indicates the background color used with the scene editor camera. |
||
| Widgets | Collection |
Collection of widgets |
||
| EditorProfile | String |
The Editor Profile associated to the scene |
||
| Theme | String |
The theme. |
||
| Anchors | Collection |
Uniform setter. |
||
| CompositeProperties | Collection |
Collection of composite properties |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| CompositeNode | CompositeName | String |
The name of the composite |
|
| CompositeProperties | CompositeProperties |
The dinamic properties of the node |
||
| Transform | Matrix4 |
Local generic transformation matrix multiplied with local position, scale and rotation. It can be used for transformations that can not be expressed using the component form. |
||
| Position | Vector3 |
Position of the object in local coordinate space. |
||
| Rotation | Vector3 |
Rotation of the object in local coordinate space. |
||
| Scale | Vector3 |
Scale factor of the object in local coordinate space. |
||
| Center | Vector3 |
The geometric center of the node. The center and the radius of an object describe a bounding sphere. |
||
| Radius | Float | Null |
The radius of the bounding sphere, whereas the center defines the geometric center of the node. |
|
| BoxLowerLeftBackVertex | Vector3 |
The minimum bounds vector of axis-aligned bounding box (lower left corner). |
||
| BoxUpperRightFrontVertex | Vector3 |
The maximum bounds vector of axis-aligned bounding box (upper right corner). |
||
| IsIntersectionTestEnabled | Boolean | Null, True, False |
Defines if intersection test is enabled in SceneComposer for picking and as well as at run-time. If disabled, the effective intersection test is disabled for all descendants as well. |
|
| RenderOrderBinName | String |
Name of the render order bin the node is assigned to. If no name is specified, the node is assigned automatically either to opaque or transparent render order bin, depending if node has blending enabled or not. |
||
| RenderOrderRank | Int32 | Null |
Defines the render order rank. The node is sorted by rank if assigned to a dedicated render order bin with a RankOrderCriterion applied. |
|
| RenderBenchmark | Float | Null |
Set the render measure value of this Node, which is a benchmark related to rendering time, typically calculated by external tool and utilized by a camera render strategy. |
|
| NodePreviewType | NodePreviewType | Null, Normal, Wireframe |
Node preview type allows the user to change the representation of the solid objects in the SceneEditor. There are two modes available: normal (solid) and wireframe (line representation). Wireframe mode applies for meshes, morphing meshes, planar shadows and billboards. |
|
| AppearanceCollection | ISCItem |
The collection of appearances. |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
NodeObject_ScripComponentCollectionPropertyTooltip |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| CompositeNode2D | CompositeName | String |
The name of the composite with the path |
|
| CompositeProperties | CompositeProperties |
Collection of composite properties |
||
| Position | Vector2 |
Position of the object in local coordinate space. |
||
| Rotation | Float | Null |
Rotation of the object in local coordinate space. |
|
| Scale | Vector2 |
Scale factor of the object in local coordinate space. |
||
| Pivot | Vector2 |
Pivot offset is the distance between the pivot point - defined by the "Position" property - and the origin of the element's bounding rectangle (upper left corner). The pivot point is used as center point for rotation and scaling. |
||
| BoundingRectangle | Rectangle |
The axis-aligned bounding rectangle in local coordinate space. |
||
| RenderOrderRank | SByte | Null |
By using the render order rank we can set the order of two or many nodes (with values on a range from -128 - the farthest render node - to 127 - the nearest node). |
|
| LayoutProperties | LayoutProperties |
Layout properties |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| CompositeProperties | Definition | String |
|
|
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| CompositePropertyDefinition | Widget | String |
Full name of the widget in the composite. |
|
| WidgetProperty | String |
The name of the widget property |
||
| SourceItem | String |
|
||
| SourceProperty | String |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| DynamicProperty | Name | String |
Name |
|
| Value | String |
The value of the dynamic property |
||
| Type | String |
The type of the dynamic property |
||
| CompositePropertyDefinition | String |
Name of the composite property definition. |
||
| Effect | Definition | String |
|
|
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Gizmo | IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Group | Transform | Matrix4 |
Local generic transformation matrix multiplied with local position, scale and rotation. It can be used for transformations that can not be expressed using the component form. |
|
| Position | Vector3 |
Position of the object in local coordinate space. |
||
| Rotation | Vector3 |
Rotation of the object in local coordinate space. |
||
| Scale | Vector3 |
Scale factor of the object in local coordinate space. |
||
| Center | Vector3 |
The geometric center of the node. The center and the radius of an object describe a bounding sphere. |
||
| Radius | Float | Null |
The radius of the bounding sphere, whereas the center defines the geometric center of the node. |
|
| BoxLowerLeftBackVertex | Vector3 |
The minimum bounds vector of axis-aligned bounding box (lower left corner). |
||
| BoxUpperRightFrontVertex | Vector3 |
The maximum bounds vector of axis-aligned bounding box (upper right corner). |
||
| IsIntersectionTestEnabled | Boolean | Null, True, False |
Defines if intersection test is enabled in SceneComposer for picking and as well as at run-time. If disabled, the effective intersection test is disabled for all descendants as well. |
|
| RenderOrderBinName | String |
Name of the render order bin the node is assigned to. If no name is specified, the node is assigned automatically either to opaque or transparent render order bin, depending if node has blending enabled or not. |
||
| RenderOrderRank | Int32 | Null |
Defines the render order rank. The node is sorted by rank if assigned to a dedicated render order bin with a RankOrderCriterion applied. |
|
| RenderBenchmark | Float | Null |
Set the render measure value of this Node, which is a benchmark related to rendering time, typically calculated by external tool and utilized by a camera render strategy. |
|
| NodePreviewType | NodePreviewType | Null, Normal, Wireframe |
Node preview type allows the user to change the representation of the solid objects in the SceneEditor. There are two modes available: normal (solid) and wireframe (line representation). Wireframe mode applies for meshes, morphing meshes, planar shadows and billboards. |
|
| AppearanceCollection | ISCItem |
The collection of appearances. |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
NodeObject_ScripComponentCollectionPropertyTooltip |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Group2D | Layout | ILayout |
The layout. |
|
| Position | Vector2 |
Position of the object in local coordinate space. |
||
| Rotation | Float | Null |
Rotation of the object in local coordinate space. |
|
| Scale | Vector2 |
Scale factor of the object in local coordinate space. |
||
| Pivot | Vector2 |
Pivot offset is the distance between the pivot point - defined by the "Position" property - and the origin of the element's bounding rectangle (upper left corner). The pivot point is used as center point for rotation and scaling. |
||
| BoundingRectangle | Rectangle |
The axis-aligned bounding rectangle in local coordinate space. |
||
| RenderOrderRank | SByte | Null |
By using the render order rank we can set the order of two or many nodes (with values on a range from -128 - the farthest render node - to 127 - the nearest node). |
|
| LayoutProperties | LayoutProperties |
Layout properties |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| RenderNode2D | Effects | Collection |
Collection of effects |
|
| IsSnapToDevicePixelEnabled | Boolean | Null, True, False |
Enable or disable snapping of translation to device pixels. |
|
| Position | Vector2 |
Position of the object in local coordinate space. |
||
| Rotation | Float | Null |
Rotation of the object in local coordinate space. |
|
| Scale | Vector2 |
Scale factor of the object in local coordinate space. |
||
| Pivot | Vector2 |
Pivot offset is the distance between the pivot point - defined by the "Position" property - and the origin of the element's bounding rectangle (upper left corner). The pivot point is used as center point for rotation and scaling. |
||
| BoundingRectangle | Rectangle |
The axis-aligned bounding rectangle in local coordinate space. |
||
| RenderOrderRank | SByte | Null |
By using the render order rank we can set the order of two or many nodes (with values on a range from -128 - the farthest render node - to 127 - the nearest node). |
|
| LayoutProperties | LayoutProperties |
Layout properties |
||
| AlphaValue | Float | Null |
Defines the local alpha transparency value between 0 and 1 for the node. The effective alpha value is combined with the materials alpha value of the node. |
|
| IsRenderingEnabled | Boolean | Null, True, False |
Defines if node is rendered or not at both, design-time and run-time. If disabled, also descendants are not rendered. |
|
| ScopeBits | UInt32 | Null |
Assigns node to scope(s) specified. If specified recursively, this setting is applied to all descendants as well. A scope forms conceptual groups independent of the scene graph hierarchy used e.g. for visibility and light culling. Visibility Culling: Node is rendered only if in same scope of camera. Light culling: Node is illuminated only if in same scope as light. |
|
| ScriptComponentCollection | ISCItem |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| RenderOrderBin | IsPredefined | Boolean | Null, True, False |
Protected render order bin are maintained by Candera and cannot be deleted or removed. |
| IsSortingEnabled | Boolean | Null, True, False |
Enables or disables the sorting of this bin according to the order criterion set. |
|
| Criterion | RenderOrderCriterion | Null, DistanceToCamera, ReverseDistanceToCamera, RenderOrderRank, ReverseRenderOrderRank, BatchOrder |
The order criterion specifies according to which sorting criteria the nodes in a render order bin are sorted. |
|
| BatchOrder | BatchOrderCriterion | Null, SortByShaderAndRenderMode, SortByAppearance |
The batch order criterion specifies according to which sorting criteria the nodes in a render order bin are sorted. |
|
| DistanceFunction | RenderOrderDistanceFunction | Null, CameraPositionToBoundingSphere, CameraPositionToBoundingBox, ViewPlaneToBoundingSphere, ViewPlaneToBoundingBox |
Determines how the distance from camera to any node is calculated. |
|
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| RenderTarget | Display | String |
The display of the render target |
|
| IsRenderingInDisplayDesignEnabled | Boolean | Null, True, False |
|
|
| PreviewBorderScope | PropertyValueScope | Null, None, Global, Local |
Configures the preview border for this object. It can be used from the global preferences. |
|
| PreviewBorderColor | Color |
Configures the preview border color for this object.It can be used from the global preferences. |
||
| Definition | String |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Scene | RenderOrderBins | Collection |
Collection of the render order bins |
|
| EditorClearColorScope | EditorClearColorScope | Null, None, Global, Local |
Scene editor clear color scope |
|
| EditorClearColor | Color |
Indicates the background color used with the scene editor camera. |
||
| Widgets | Collection |
Collection of widgets |
||
| EditorProfile | String |
The Editor Profile associated to the scene |
||
| Theme | String |
The theme. |
||
| Anchors | Collection |
Collection of anchors |
||
| CompositeProperties | Collection |
Collection of composite properties |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Scene2D | HorizontalGuidelines | FloatArray |
The horizontal guidelines displayed in the render panel. Drag a new one from the ruler. Drag an existing one outside the panel to remove it. |
|
| VerticalGuidelines | FloatArray |
The vertical guidelines displayed in the render panel. Drag a new one from the ruler. Drag an existing one outside the panel to remove it. |
||
| DesignMasterScope | PropertyValueScope | Null, None, Global, Local |
Configures the design master image for this scene. It can be used from the global preferences or any other bitmap from the solution. |
|
| DesignMasterName | String |
Bitmap used as background during scene editing. |
||
| DesignMasterPosition | DesignMasterPosition | Null, Background, Foreground |
The position of the design master image. |
|
| DesignMasterTransparency | Float | Null |
The transparency of the design master image. |
|
| EditorClearColorScope | EditorClearColorScope | Null, None, Global, Local |
Scene editor clear color scope |
|
| EditorClearColor | Color |
Indicates the background color used with the scene editor camera. |
||
| Widgets | Collection |
Collection of widgets |
||
| EditorProfile | String |
The Editor Profile associated to the scene |
||
| Theme | String |
The theme. |
||
| Anchors | Collection |
Collection of anchors |
||
| CompositeProperties | Collection |
Collection of composite properties |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Theme | IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| ThemeEntry | Interface | String |
Full name of the theme entry interface implemented by this this entry. |
|
| EntryItem | String |
The item in the solution which will be used by all clients of this entry. If entry item is null, the master theme will be used. The master theme can not contain any empty entries. |
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |
|
| Widget | WidgetNodeName | String |
The name of the node associated to the widget |
|
| Definition | String |
|
||
| IsTemplate | Boolean | Null, True, False |
If set then the object can be a template for the creation of other objects. |
|
| Id | UInt32 | Null |
|
|
| SymbolicName | String |
Symbolic names are translated to Ids in Candera, so they must be valid C++ identifiers. C++ identifiers can contain letters, numbers, and underscores. They must start with either a letter or an underscore. |
||
| TemplateName | String |
The path to the imported artifacts that serve as source. |
||
| Name | String |
The name of the object. |
||
| KnownTemplateNodes | Collection |
Collection of templates nodes that are known to the instance. This property is used when comparing the insatnce with its template to decide which nodes are new and which were deleted explicitly. |
||
| dyn | Collection |
|
||
| Description | String |
Description of this item. |
||
| PreserveSCMLDocumentFormattingScope | PreserveSCMLDocumentFormattingScope | Null, Global, Local |
Indicated the scope for the Preserve SCML Document Formatting property |
|
| PreserveSCMLDocumentFormatting | Boolean | Null, True, False |
The formatting of the SCML documents will be preserved only if it is set to true, otherwise the formatting will be reset when the solution is saved |
|
| IsLocked | Boolean | Null, True, False |
Indicates if this item is locked. |