Kanzi Framework  3.9.0
Java API
Public Attributes | List of all members
Node2DMetadata Interface Reference

Metadata definitions for Node2D. More...

Inheritance diagram for Node2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Float > AspectRatioProperty
 Determines the proportion of width and height. More...
 
DynamicPropertyType< Resource > BackgroundBrushProperty
 The background brush to paint the background of 2D nodes. More...
 
DynamicPropertyType< Boolean > CacheValidProperty
 Indicates whether the node is cached. More...
 
DynamicPropertyType< Integer > CachingModeProperty
 Sets the caching mode of this node: More...
 
DynamicPropertyType< Resource > CompositionBrushProperty
 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< Resource > EffectPrefabProperty
 The 2D Effect to use for this node. More...
 
DynamicPropertyType< Resource > EffectProperty
 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< Resource > ForegroundBrushProperty
 The foreground brush to paint the foreground of 2D nodes. More...
 
DynamicPropertyType< Integer > ForegroundHintProperty
 Give a hint of the type of the foreground of 2D nodes: More...
 
DynamicPropertyType< SRTValue2D > LayoutTransformationProperty
 The 2D transformation to be applied before layouting. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node2D")
 Metaclass for Node2D.
 
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< Integer > PerspectiveTransformationModeProperty
 Defines the mode of operation for the coordinate system and field of view. More...
 
DynamicPropertyType< Vector3 > PerspectiveTransformationOriginProperty
 The 3D transformation origin to be used for perspective transformation on this or child nodes. More...
 
DynamicPropertyType< Vector3 > PerspectiveTransformationPivotProperty
 The 3D pivot point in relative coordinates. More...
 
DynamicPropertyType< SRTValue3D > PerspectiveTransformationProperty
 The 3D transformation to be applied after layouting. More...
 
DynamicPropertyType< Integer > PixelFormatProperty
 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< Resource > RenderTargetProperty
 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< Vector2 > RenderTransformationOriginProperty
 Sets the render transform origin in relative coordinates. More...
 
DynamicPropertyType< SRTValue2D > RenderTransformationProperty
 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...
 

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<Integer> CachingModeProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.CachingMode", Integer.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

DynamicPropertyType<Integer> ForegroundHintProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.ForegroundHint", Integer.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.

◆ 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<Integer> PerspectiveTransformationModeProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PerspectiveTransformationMode", Integer.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

DynamicPropertyType<Integer> PixelFormatProperty
Initial value:
=
new DynamicPropertyType<>("Node2D.PixelFormat", Integer.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.