Kanzi  3.9.9
Kanzi Engine Java API
ScreenMetadata Interface Reference

Metadata definitions for Screen. More...

Inheritance diagram for ScreenMetadata:
[legend]

Classes

class  ActivateThemeMessageArguments
 Metadata definitions for ActivateThemeMessageArguments. More...
 

Public Attributes

DynamicMessageType< ScreenMetadata.ActivateThemeMessageArguments > ActivateThemeMessage
 Activates a specified theme from a theme group. More...
 
DynamicPropertyType< ColorRGBAClearColorProperty
 If screen has a clear color, screen will be cleared with the specified color before all other rendering. More...
 
DynamicPropertyType< Float > HeightProperty
 When Metrics Type is set to: More...
 
DynamicPropertyType< String > HostNameProperty
 Contains the name of the host the node originates from. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Screen")
 Metaclass for Screen.
 
DynamicPropertyType< ScreenEnums.WindowMetricsTypeMetricsTypeProperty
 Defines the type of the coordinate system for the window metrics. More...
 
DynamicPropertyType< WindowOrientationOrientationProperty
 Sets the orientation of the application window. More...
 
DynamicPropertyType< Float > WidthProperty
 When Metrics Type is set to: More...
 
- Public Attributes inherited from Node2DMetadata
DynamicPropertyType< Float > AspectRatioProperty
 Determines the proportion of width and height. More...
 
DynamicPropertyType< ResourceBackgroundBrushProperty
 The background brush to paint the background of 2D nodes. More...
 
DynamicPropertyType< Boolean > CacheValidProperty
 Indicates whether the node is cached. More...
 
DynamicPropertyType< CachingModeCachingModeProperty
 Sets the caching mode of this node: More...
 
DynamicPropertyType< ResourceCompositionBrushProperty
 The brush to use to compose 2D nodes to screen. More...
 
DynamicPropertyType< Boolean > DisableRenderTargetClearProperty
 Do not clear render target buffers before rendering into it even if necessary. More...
 
DynamicPropertyType< ResourceEffectPrefabProperty
 The 2D Effect to use for this node. More...
 
DynamicPropertyType< ResourceEffectProperty
 Reports the runtime effect instance that this node uses. More...
 
DynamicPropertyType< Boolean > ForceCompositionProperty
 Force rendering to composing target even if not otherwise necessary. More...
 
DynamicPropertyType< ResourceForegroundBrushProperty
 The foreground brush to paint the foreground of 2D nodes. More...
 
DynamicPropertyType< Node2DEnums.ForegroundHintForegroundHintProperty
 Give a hint of the type of the foreground of 2D nodes: More...
 
DynamicPropertyType< SRTValue2DLayoutTransformationProperty
 The 2D transformation to be applied before layouting. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node2D")
 Metaclass for Node2D.
 
DynamicPropertyType< MultisampleCountMultisampleLevelProperty
 Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node. More...
 
DynamicPropertyType< Boolean > OffscreenRenderingProperty
 When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen. More...
 
DynamicPropertyType< Float > PerspectiveTransformationFovProperty
 The 3D transformation field of view (degrees) to be applied after layouting. More...
 
DynamicPropertyType< Node2DEnums.PerspectiveTransformationModePerspectiveTransformationModeProperty
 Defines the mode of operation for the coordinate system and field of view. More...
 
DynamicPropertyType< Vector3PerspectiveTransformationOriginProperty
 The 3D transformation origin to be used for perspective transformation on this or child nodes. More...
 
DynamicPropertyType< Vector3PerspectiveTransformationPivotProperty
 The 3D pivot point in relative coordinates. More...
 
DynamicPropertyType< SRTValue3DPerspectiveTransformationProperty
 The 3D transformation to be applied after layouting. More...
 
DynamicPropertyType< Node2DEnums.PixelFormatPixelFormatProperty
 The pixel format of the node if rendering to a texture. More...
 
DynamicPropertyType< Boolean > RenderSelfProperty
 Whether the node renders itself. More...
 
DynamicPropertyType< Float > RenderTargetMinimumHeightProperty
 Sets the minimum height of implicitly generated render targets. More...
 
DynamicPropertyType< Float > RenderTargetMinimumWidthProperty
 Sets the minimum width of implicitly generated render targets. More...
 
DynamicPropertyType< ResourceRenderTargetProperty
 Forces the node to be rendered into a given render target texture. More...
 
DynamicPropertyType< Float > RenderTargetReallocationLimitProperty
 The change in size that triggers reallocation of a render target. More...
 
DynamicPropertyType< Vector2RenderTransformationOriginProperty
 Sets the render transform origin in relative coordinates. More...
 
DynamicPropertyType< SRTValue2DRenderTransformationProperty
 The 2D transformation to be applied after layouting. More...
 
DynamicPropertyType< Boolean > SnapToPixelProperty
 Snap the translation of the node and its size into pixel boundary. More...
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< Float > ActualDepthProperty
 The calculated size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Float > ActualHeightProperty
 The calculated height of the node when used in a layout. More...
 
DynamicPropertyType< Float > ActualWidthProperty
 The calculated width of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > ClipChildrenProperty
 Sets whether to clip the child nodes of this node. More...
 
DynamicPropertyType< NodeEnums.ContentStretchContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). More...
 
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. More...
 
DynamicPropertyType< NodeEnums.DepthAlignmentDepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Boolean > EffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled. More...
 
DynamicPropertyType< Boolean > EnabledProperty
 Whether this node is enabled. More...
 
DynamicPropertyType< Boolean > FocusableProperty
 Indicates whether the node can receive focus. More...
 
DynamicPropertyType< Boolean > FocusedProperty
 Indicates whether the node has the key focus. More...
 
DynamicPropertyType< FocusStateFocusStateProperty
 Reports the focus state of a node: More...
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text. More...
 
DynamicPropertyType< Float > HeightProperty
 The height of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > HitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing. More...
 
DynamicPropertyType< Boolean > HitTestableProperty
 When enabled, the node can be hit tested. More...
 
DynamicPropertyType< NodeEnums.HorizontalAlignmentHorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Boolean > HoverProperty
 Indicates whether a node is the foremost hit testable node under the cursor. More...
 
DynamicPropertyType< String > LocaleProperty
 The locale of the node. More...
 
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. More...
 
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. More...
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node. More...
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node. More...
 
DynamicPropertyType< NodeEnums.VerticalAlignmentVerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > VisibleAmountInParentProperty
 Sets the amount the node is inside its parent. More...
 
DynamicPropertyType< Boolean > VisibleProperty
 When disabled, Kanzi does not render the node. More...
 
DynamicPropertyType< Float > WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout. More...
 

Detailed Description

Metadata definitions for Screen.

Member Data Documentation

DynamicMessageType<ScreenMetadata.ActivateThemeMessageArguments> ActivateThemeMessage
Initial value:
=
new DynamicMessageType<>(
"Message.Screen.ActivateTheme", ScreenMetadata.ActivateThemeMessageArguments.class)

Activates a specified theme from a theme group.

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.

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.
DynamicPropertyType<String> HostNameProperty
Initial value:
=
new DynamicPropertyType<>("Screen.HostName", String.class)

Contains the name of the host the node originates from.

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.

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.

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.