ScreenMetadata Interface Reference
Metadata definitions for Screen. More...
Inheritance diagram for ScreenMetadata:
Classes | |
| class | ActivateThemeMessageArguments |
| Metadata definitions for ActivateThemeMessageArguments. More... | |
Public Attributes | |
| DynamicMessageType< ScreenMetadata.ActivateThemeMessageArguments > | ActivateThemeMessage |
| Activates a specified theme from a theme group. | |
| DynamicPropertyType< ColorRGBA > | ClearColorProperty |
| If screen has a clear color, screen will be cleared with the specified color before all other rendering. | |
| DynamicPropertyType< Float > | HeightProperty |
| When Metrics Type is set to: | |
| DynamicPropertyType< String > | HostNameProperty |
| Contains the name of the host the node originates from. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Screen") |
| Metaclass for Screen. | |
| DynamicPropertyType< ScreenEnums.WindowMetricsType > | MetricsTypeProperty |
| Defines the type of the coordinate system for the window metrics. | |
| DynamicPropertyType< WindowOrientation > | OrientationProperty |
| Sets the orientation of the application window. | |
| DynamicPropertyType< Float > | WidthProperty |
| When Metrics Type is set to: | |
 Public Attributes inherited from Node2DMetadata | |
| DynamicPropertyType< Float > | AspectRatioProperty |
| Determines the proportion of width and height. | |
| DynamicPropertyType< Resource > | BackgroundBrushProperty |
| The background brush to paint the background of 2D nodes. | |
| DynamicPropertyType< Boolean > | CacheValidProperty |
| Indicates whether the node is cached. | |
| DynamicPropertyType< CachingMode > | CachingModeProperty |
| Sets the caching mode of this node: | |
| DynamicPropertyType< Resource > | CompositionBrushProperty |
| The brush to use to compose 2D nodes to screen. | |
| DynamicPropertyType< Boolean > | DisableRenderTargetClearProperty |
| Do not clear render target buffers before rendering into it even if necessary. | |
| DynamicPropertyType< Resource > | EffectPrefabProperty |
| The 2D Effect to use for this node. | |
| DynamicPropertyType< Resource > | EffectProperty |
| Reports the runtime effect instance that this node uses. | |
| DynamicPropertyType< Boolean > | ForceCompositionProperty |
| Force rendering to composing target even if not otherwise necessary. | |
| DynamicPropertyType< Resource > | ForegroundBrushProperty |
| The foreground brush to paint the foreground of 2D nodes. | |
| DynamicPropertyType< Node2DEnums.ForegroundHint > | ForegroundHintProperty |
| Give a hint of the type of the foreground of 2D nodes: | |
| DynamicPropertyType< SRTValue2D > | LayoutTransformationProperty |
| The 2D transformation to be applied before layouting. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node2D") |
| Metaclass for Node2D. | |
| DynamicPropertyType< SamplerMipmapMode > | MipmapModeProperty |
| Sets the mipmap mode to use with the temporary composition targets to which Kanzi renders this node. | |
| DynamicPropertyType< MultisampleCount > | MultisampleLevelProperty |
| Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node. | |
| DynamicPropertyType< Boolean > | OffscreenRenderingProperty |
| When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen. | |
| DynamicPropertyType< Float > | PerspectiveTransformationFovProperty |
| The 3D transformation field of view (degrees) to be applied after layouting. | |
| DynamicPropertyType< Node2DEnums.PerspectiveTransformationMode > | PerspectiveTransformationModeProperty |
| Defines the mode of operation for the coordinate system and field of view. | |
| DynamicPropertyType< Vector3 > | PerspectiveTransformationOriginProperty |
| The 3D transformation origin to be used for perspective transformation on this or child nodes. | |
| DynamicPropertyType< Vector3 > | PerspectiveTransformationPivotProperty |
| The 3D pivot point in relative coordinates. | |
| DynamicPropertyType< SRTValue3D > | PerspectiveTransformationProperty |
| The 3D transformation to be applied after layouting. | |
| DynamicPropertyType< Node2DEnums.PixelFormat > | PixelFormatProperty |
| The pixel format of the node if rendering to a texture. | |
| DynamicPropertyType< Boolean > | RenderSelfProperty |
| Whether the node renders itself. | |
| DynamicPropertyType< Float > | RenderTargetMinimumHeightProperty |
| Sets the minimum height of implicitly generated render targets. | |
| DynamicPropertyType< Float > | RenderTargetMinimumWidthProperty |
| Sets the minimum width of implicitly generated render targets. | |
| DynamicPropertyType< Resource > | RenderTargetProperty |
| Forces the node to be rendered into a given render target texture. | |
| DynamicPropertyType< Float > | RenderTargetReallocationLimitProperty |
| The change in size that triggers reallocation of a render target. | |
| DynamicPropertyType< Vector2 > | RenderTransformationOriginProperty |
| Sets the render transform origin in relative coordinates. | |
| DynamicPropertyType< SRTValue2D > | RenderTransformationProperty |
| The 2D transformation to be applied after layouting. | |
| DynamicPropertyType< Boolean > | SnapToPixelProperty |
| Snap the translation of the node and its size into pixel boundary. | |
| Public Attributes inherited from NodeMetadata | |
| DynamicPropertyType< Float > | ActualDepthProperty |
| The calculated size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Float > | ActualHeightProperty |
| The calculated height of the node when used in a layout. | |
| DynamicPropertyType< Float > | ActualWidthProperty |
| The calculated width of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | ClipChildrenProperty |
| Sets whether to clip the child nodes of this node. | |
| DynamicPropertyType< NodeEnums.ContentStretch > | ContentStretchProperty |
| Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). | |
| DynamicPropertyType< Boolean > | CreatedFromKZBProperty |
| Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file. | |
| DynamicPropertyType< NodeEnums.DepthAlignment > | DepthAlignmentProperty |
| The alignment in depth direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | DepthMarginProperty |
| Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class) |
| The size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Boolean > | EffectivelyEnabledProperty |
| Indicates whether this node and its ancestor nodes are enabled. | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether this node is enabled. | |
| DynamicPropertyType< Boolean > | FocusableProperty |
| Indicates whether the node can receive focus. | |
| DynamicPropertyType< Boolean > | FocusedProperty |
| Indicates whether the node has the key focus. | |
| DynamicPropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a node: | |
| DynamicPropertyType< Resource > | FontFamilyProperty |
| The font family used to render the text. | |
| DynamicPropertyType< Float > | HeightProperty |
| The height of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | HitTestableContainerProperty |
| When enabled, Kanzi uses the layout bounds as geometry for hit testing. | |
| DynamicPropertyType< Boolean > | HitTestableProperty |
| When enabled, the node can be hit tested. | |
| DynamicPropertyType< NodeEnums.HorizontalAlignment > | HorizontalAlignmentProperty |
| The alignment in horizontal direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Boolean > | HoverProperty |
| Indicates whether a node is the foremost hit testable node under the cursor. | |
| DynamicPropertyType< String > | LocaleProperty |
| The locale of the node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node") |
| Metaclass for Node. | |
| DynamicPropertyType< String > | NameProperty = new DynamicPropertyType<>("Node.Name", String.class) |
| Node name. | |
| DynamicPropertyType< Float > | OpacityProperty |
| Opacity of the node. | |
| DynamicPropertyType< String > | PathProperty = new DynamicPropertyType<>("Node.Path", String.class) |
| Full path to the node. | |
| DynamicPropertyType< Float > | Projection2DTo3DScaleProperty |
| Sets the scale factor to project pixels to 3D size. | |
| DynamicPropertyType< Resource > | StateManagerProperty |
| Sets the State Manager to the node. | |
| DynamicPropertyType< Resource > | StyleProperty |
| Sets a style to the node. | |
| DynamicPropertyType< NodeEnums.VerticalAlignment > | VerticalAlignmentProperty |
| The alignment in vertical direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | VisibleAmountInParentProperty |
| Sets the amount the node is inside its parent. | |
| DynamicPropertyType< Boolean > | VisibleProperty |
| When disabled, Kanzi does not render the node. | |
| DynamicPropertyType< Float > | WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class) |
| The width of the node when used in a layout. | |
Detailed Description
Metadata definitions for Screen.
Member Data Documentation
◆ ActivateThemeMessage
| DynamicMessageType<ScreenMetadata.ActivateThemeMessageArguments> ActivateThemeMessage |
Initial value:
=
new DynamicMessageType<>(
"Message.Screen.ActivateTheme", ScreenMetadata.ActivateThemeMessageArguments.class)
Activates a specified theme from a theme group.
◆ ClearColorProperty
| DynamicPropertyType<ColorRGBA> ClearColorProperty |
Initial value:
=
new DynamicPropertyType<>("Screen.ClearColor", ColorRGBA.class)
If screen has a clear color, screen will be cleared with the specified color before all other rendering.
Depth will be cleared to 1.0f and stencil will be cleared to 0.
◆ HeightProperty
| DynamicPropertyType<Float> HeightProperty |
Initial value:
=
new DynamicPropertyType<>("Window.Height", Float.class)
When Metrics Type is set to:
- Relative, a relative height of the window in the range [0,1]
- Absolute, the height of the window in pixels.
◆ HostNameProperty
| DynamicPropertyType<String> HostNameProperty |
Initial value:
=
new DynamicPropertyType<>("Screen.HostName", String.class)
Contains the name of the host the node originates from.
◆ MetricsTypeProperty
| DynamicPropertyType<ScreenEnums.WindowMetricsType> MetricsTypeProperty |
Initial value:
=
new DynamicPropertyType<>("Window.MetricsType", ScreenEnums.WindowMetricsType.class)
Defines the type of the coordinate system for the window metrics.
Defined in core.ui/node/screen.cpp as WindowMetricsTypeProperty.
◆ OrientationProperty
| DynamicPropertyType<WindowOrientation> OrientationProperty |
Initial value:
=
new DynamicPropertyType<>("Window.Orientation", WindowOrientation.class)
Sets the orientation of the application window.
Defined in core.ui/node/screen.cpp as WindowOrientationProperty.
◆ WidthProperty
| DynamicPropertyType<Float> WidthProperty |
Initial value:
=
new DynamicPropertyType<>("Window.Width", Float.class)
When Metrics Type is set to:
- Relative, a relative width of the window in the range [0,1]
- Absolute, the width of the window in pixels.