Kanzi 3.9.10
Node2DMetadata Interface Reference

Metadata definitions for Node2D. More...

Inheritance diagram for Node2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< FloatAspectRatioProperty
 Determines the proportion of width and height.
 
DynamicPropertyType< ResourceBackgroundBrushProperty
 The background brush to paint the background of 2D nodes.
 
DynamicPropertyType< BooleanCacheValidProperty
 Indicates whether the node is cached.
 
DynamicPropertyType< CachingModeCachingModeProperty
 Sets the caching mode of this node:
 
DynamicPropertyType< ResourceCompositionBrushProperty
 The brush to use to compose 2D nodes to screen.
 
DynamicPropertyType< BooleanDisableRenderTargetClearProperty
 Do not clear render target buffers before rendering into it even if necessary.
 
DynamicPropertyType< ResourceEffectPrefabProperty
 The 2D Effect to use for this node.
 
DynamicPropertyType< ResourceEffectProperty
 Reports the runtime effect instance that this node uses.
 
DynamicPropertyType< BooleanForceCompositionProperty
 Force rendering to composing target even if not otherwise necessary.
 
DynamicPropertyType< ResourceForegroundBrushProperty
 The foreground brush to paint the foreground of 2D nodes.
 
DynamicPropertyType< Node2DEnums.ForegroundHintForegroundHintProperty
 Give a hint of the type of the foreground of 2D nodes:
 
DynamicPropertyType< SRTValue2DLayoutTransformationProperty
 The 2D transformation to be applied before layouting.
 
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.
 
DynamicPropertyType< BooleanOffscreenRenderingProperty
 When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.
 
DynamicPropertyType< FloatPerspectiveTransformationFovProperty
 The 3D transformation field of view (degrees) to be applied after layouting.
 
DynamicPropertyType< Node2DEnums.PerspectiveTransformationModePerspectiveTransformationModeProperty
 Defines the mode of operation for the coordinate system and field of view.
 
DynamicPropertyType< Vector3PerspectiveTransformationOriginProperty
 The 3D transformation origin to be used for perspective transformation on this or child nodes.
 
DynamicPropertyType< Vector3PerspectiveTransformationPivotProperty
 The 3D pivot point in relative coordinates.
 
DynamicPropertyType< SRTValue3DPerspectiveTransformationProperty
 The 3D transformation to be applied after layouting.
 
DynamicPropertyType< Node2DEnums.PixelFormatPixelFormatProperty
 The pixel format of the node if rendering to a texture.
 
DynamicPropertyType< BooleanRenderSelfProperty
 Whether the node renders itself.
 
DynamicPropertyType< FloatRenderTargetMinimumHeightProperty
 Sets the minimum height of implicitly generated render targets.
 
DynamicPropertyType< FloatRenderTargetMinimumWidthProperty
 Sets the minimum width of implicitly generated render targets.
 
DynamicPropertyType< ResourceRenderTargetProperty
 Forces the node to be rendered into a given render target texture.
 
DynamicPropertyType< FloatRenderTargetReallocationLimitProperty
 The change in size that triggers reallocation of a render target.
 
DynamicPropertyType< Vector2RenderTransformationOriginProperty
 Sets the render transform origin in relative coordinates.
 
DynamicPropertyType< SRTValue2DRenderTransformationProperty
 The 2D transformation to be applied after layouting.
 
DynamicPropertyType< BooleanSnapToPixelProperty
 Snap the translation of the node and its size into pixel boundary.
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< FloatActualDepthProperty
 The calculated size of the node in depth direction when used in a layout.
 
DynamicPropertyType< FloatActualHeightProperty
 The calculated height of the node when used in a layout.
 
DynamicPropertyType< FloatActualWidthProperty
 The calculated width of the node when used in a layout.
 
DynamicPropertyType< BooleanClipChildrenProperty
 Sets whether to clip the child nodes of this node.
 
DynamicPropertyType< NodeEnums.ContentStretchContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
 
DynamicPropertyType< BooleanCreatedFromKZBProperty
 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.DepthAlignmentDepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout.
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
 
DynamicPropertyType< FloatDepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout.
 
DynamicPropertyType< BooleanEffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled.
 
DynamicPropertyType< BooleanEnabledProperty
 Whether this node is enabled.
 
DynamicPropertyType< BooleanFocusableProperty
 Indicates whether the node can receive focus.
 
DynamicPropertyType< BooleanFocusedProperty
 Indicates whether the node has the key focus.
 
DynamicPropertyType< FocusStateFocusStateProperty
 Reports the focus state of a node:
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text.
 
DynamicPropertyType< FloatHeightProperty
 The height of the node when used in a layout.
 
DynamicPropertyType< BooleanHitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing.
 
DynamicPropertyType< BooleanHitTestableProperty
 When enabled, the node can be hit tested.
 
DynamicPropertyType< NodeEnums.HorizontalAlignmentHorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout.
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
 
DynamicPropertyType< BooleanHoverProperty
 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< FloatOpacityProperty
 Opacity of the node.
 
DynamicPropertyType< String > PathProperty = new DynamicPropertyType<>("Node.Path", String.class)
 Full path to the node.
 
DynamicPropertyType< FloatProjection2DTo3DScaleProperty
 Sets the scale factor to project pixels to 3D size.
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node.
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node.
 
DynamicPropertyType< NodeEnums.VerticalAlignmentVerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout.
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
 
DynamicPropertyType< FloatVisibleAmountInParentProperty
 Sets the amount the node is inside its parent.
 
DynamicPropertyType< BooleanVisibleProperty
 When disabled, Kanzi does not render the node.
 
DynamicPropertyType< FloatWidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout.
 

Detailed Description

Metadata definitions for Node2D.

Member Data Documentation

◆ AspectRatioProperty

DynamicPropertyType<Float> AspectRatioProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.AspectRatio", Float.class)

Determines the proportion of width and height.

You cannot set both the Aspect Ratio and both, Width and Height.

◆ BackgroundBrushProperty

DynamicPropertyType<Resource> BackgroundBrushProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.BackgroundBrush", Resource.class)

The background brush to paint the background of 2D nodes.

◆ CacheValidProperty

DynamicPropertyType<Boolean> CacheValidProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.CacheValid", Boolean.class)

Indicates whether the node is cached.

To disable the cache for one frame, disable this property.

◆ CachingModeProperty

DynamicPropertyType<CachingMode> CachingModeProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.CachingMode", CachingMode.class)

Sets the caching mode of this node:

  • Disabled sets Kanzi to render the node and its descendants normally, without caching. This is the default.
  • Enabled sets Kanzi to cache the node and its descendants and render the node from the cache image until you invalidate the cache by disabling the Cache Valid property.
  • Automatic sets Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change.

◆ CompositionBrushProperty

DynamicPropertyType<Resource> CompositionBrushProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.CompositionBrush", Resource.class)

The brush to use to compose 2D nodes to screen.

◆ DisableRenderTargetClearProperty

DynamicPropertyType<Boolean> DisableRenderTargetClearProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.DisableRenderTargetClear", Boolean.class)

Do not clear render target buffers before rendering into it even if necessary.

◆ EffectPrefabProperty

DynamicPropertyType<Resource> EffectPrefabProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.EffectPrefab", Resource.class)

The 2D Effect to use for this node.

◆ EffectProperty

DynamicPropertyType<Resource> EffectProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.Effect", Resource.class)

Reports the runtime effect instance that this node uses.

Kanzi sets the value of this property internally when the value of the Effect Prefab property in this node changes.

◆ ForceCompositionProperty

DynamicPropertyType<Boolean> ForceCompositionProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.ForceComposition", Boolean.class)

Force rendering to composing target even if not otherwise necessary.

◆ ForegroundBrushProperty

DynamicPropertyType<Resource> ForegroundBrushProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.ForegroundBrush", Resource.class)

The foreground brush to paint the foreground of 2D nodes.

◆ ForegroundHintProperty

Initial value:
=
new DynamicPropertyType<>("Node2D.ForegroundHint", Node2DEnums.ForegroundHint.class)

Give a hint of the type of the foreground of 2D nodes:

  • None renders the background brush after rendering the node.
  • Translucent renders the background brush before the content of the node.
  • Occluding renders the background brush.

◆ LayoutTransformationProperty

DynamicPropertyType<SRTValue2D> LayoutTransformationProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.LayoutTransformation", SRTValue2D.class)

The 2D transformation to be applied before layouting.

◆ MultisampleLevelProperty

DynamicPropertyType<MultisampleCount> MultisampleLevelProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.MultisampleLevel", MultisampleCount.class)

Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node.

◆ OffscreenRenderingProperty

DynamicPropertyType<Boolean> OffscreenRenderingProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.OffscreenRendering", Boolean.class)

When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.

◆ PerspectiveTransformationFovProperty

DynamicPropertyType<Float> PerspectiveTransformationFovProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformationFov", Float.class)

The 3D transformation field of view (degrees) to be applied after layouting.

◆ PerspectiveTransformationModeProperty

DynamicPropertyType<Node2DEnums.PerspectiveTransformationMode> PerspectiveTransformationModeProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformationMode",
Node2DEnums.PerspectiveTransformationMode.class)

Defines the mode of operation for the coordinate system and field of view.

◆ PerspectiveTransformationOriginProperty

DynamicPropertyType<Vector3> PerspectiveTransformationOriginProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformationOrigin", Vector3.class)

The 3D transformation origin to be used for perspective transformation on this or child nodes.

◆ PerspectiveTransformationPivotProperty

DynamicPropertyType<Vector3> PerspectiveTransformationPivotProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformationPivot", Vector3.class)

The 3D pivot point in relative coordinates.

◆ PerspectiveTransformationProperty

DynamicPropertyType<SRTValue3D> PerspectiveTransformationProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformation", SRTValue3D.class)

The 3D transformation to be applied after layouting.

◆ PixelFormatProperty

Initial value:
=
new DynamicPropertyType<>("Node2D.PixelFormat", Node2DEnums.PixelFormat.class)

The pixel format of the node if rendering to a texture.

◆ RenderSelfProperty

DynamicPropertyType<Boolean> RenderSelfProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderSelf", Boolean.class)

Whether the node renders itself.

Does not affect the rendering of child nodes.

◆ RenderTargetMinimumHeightProperty

DynamicPropertyType<Float> RenderTargetMinimumHeightProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTargetMinimumHeight", Float.class)

Sets the minimum height of implicitly generated render targets.

◆ RenderTargetMinimumWidthProperty

DynamicPropertyType<Float> RenderTargetMinimumWidthProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTargetMinimumWidth", Float.class)

Sets the minimum width of implicitly generated render targets.

◆ RenderTargetProperty

DynamicPropertyType<Resource> RenderTargetProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTarget", Resource.class)

Forces the node to be rendered into a given render target texture.

When set to "No Target", regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.

◆ RenderTargetReallocationLimitProperty

DynamicPropertyType<Float> RenderTargetReallocationLimitProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTargetReallocationLimit", Float.class)

The change in size that triggers reallocation of a render target.

◆ RenderTransformationOriginProperty

DynamicPropertyType<Vector2> RenderTransformationOriginProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTransformationOrigin", Vector2.class)

Sets the render transform origin in relative coordinates.

◆ RenderTransformationProperty

DynamicPropertyType<SRTValue2D> RenderTransformationProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.RenderTransformation", SRTValue2D.class)

The 2D transformation to be applied after layouting.

◆ SnapToPixelProperty

DynamicPropertyType<Boolean> SnapToPixelProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.SnapToPixel", Boolean.class)

Snap the translation of the node and its size into pixel boundary.