Kanzi 3.9.10
NinePatchImage2DMetadata Interface Reference

Metadata definitions for NinePatchImage2D. More...

Inheritance diagram for NinePatchImage2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Resource > ImageBottomLeftProperty
 Image to use in the bottom-left corner.
 
DynamicPropertyType< Resource > ImageBottomProperty
 The image to use in middle of the bottom row.
 
DynamicPropertyType< Resource > ImageBottomRightProperty
 The image to use in the bottom-right corner.
 
DynamicPropertyType< Resource > ImageCenterProperty
 The image to use in the center.
 
DynamicPropertyType< Resource > ImageLeftProperty
 The image to use in the center-left.
 
DynamicPropertyType< Resource > ImageRightProperty
 The image to use in the center-right.
 
DynamicPropertyType< Resource > ImageTopLeftProperty
 The image to use in the top-left corner.
 
DynamicPropertyType< Resource > ImageTopProperty
 The image to use in the middle of the top row.
 
DynamicPropertyType< Resource > ImageTopRightProperty
 The image to use in the top-right corner.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NinePatchImage2D")
 Metaclass for NinePatchImage2D.
 
DynamicPropertyType< NodeEnums.ContentStretch > StretchTypeBottomProperty
 Sets how to display the bottom image:
 
DynamicPropertyType< NodeEnums.ContentStretch > StretchTypeCenterProperty
 Sets how to display the center image:
 
DynamicPropertyType< NodeEnums.ContentStretch > StretchTypeLeftProperty
 Sets how to display the left image:
 
DynamicPropertyType< NodeEnums.ContentStretch > StretchTypeRightProperty
 Sets how to display the right image:
 
DynamicPropertyType< NodeEnums.ContentStretch > StretchTypeTopProperty
 Sets how to display the top image:
 
- 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< 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 NinePatchImage2D.

Member Data Documentation

◆ ImageBottomLeftProperty

DynamicPropertyType<Resource> ImageBottomLeftProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageBottomLeft", Resource.class)

Image to use in the bottom-left corner.

◆ ImageBottomProperty

DynamicPropertyType<Resource> ImageBottomProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageBottom", Resource.class)

The image to use in middle of the bottom row.

◆ ImageBottomRightProperty

DynamicPropertyType<Resource> ImageBottomRightProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageBottomRight", Resource.class)

The image to use in the bottom-right corner.

◆ ImageCenterProperty

DynamicPropertyType<Resource> ImageCenterProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageCenter", Resource.class)

The image to use in the center.

◆ ImageLeftProperty

DynamicPropertyType<Resource> ImageLeftProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageLeft", Resource.class)

The image to use in the center-left.

◆ ImageRightProperty

DynamicPropertyType<Resource> ImageRightProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageRight", Resource.class)

The image to use in the center-right.

◆ ImageTopLeftProperty

DynamicPropertyType<Resource> ImageTopLeftProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageTopLeft", Resource.class)

The image to use in the top-left corner.

◆ ImageTopProperty

DynamicPropertyType<Resource> ImageTopProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageTop", Resource.class)

The image to use in the middle of the top row.

◆ ImageTopRightProperty

DynamicPropertyType<Resource> ImageTopRightProperty
Initial value:
=
new DynamicPropertyType<>("NinePatchImage2D.ImageTopRight", Resource.class)

The image to use in the top-right corner.

◆ StretchTypeBottomProperty

DynamicPropertyType<NodeEnums.ContentStretch> StretchTypeBottomProperty
Initial value:
=
new DynamicPropertyType<>(
"NinePatchImage2D.StretchTypeBottom", NodeEnums.ContentStretch.class)

Sets how to display the bottom image:

  • Stretch: Scales the image to fill the space between the bottom-left and bottom-right images.
  • Wrap: When the width of the space between the bottom-left and bottom-right images exceeds the width of the image, either extends the last column of pixels in the image or tiles the image. Depends on the value of the Wrap Mode property of the texture.

◆ StretchTypeCenterProperty

DynamicPropertyType<NodeEnums.ContentStretch> StretchTypeCenterProperty
Initial value:
=
new DynamicPropertyType<>(
"NinePatchImage2D.StretchTypeCenter", NodeEnums.ContentStretch.class)

Sets how to display the center image:

  • Stretch: Scales the image to fill the width and height of the center of the nine patch image.
  • Wrap: When the height and width of the center exceed the size of the image, either extends the last row or column of pixels in the image or tiles the image. Depends on the value of the Wrap Mode property of the texture.

◆ StretchTypeLeftProperty

Initial value:
=
new DynamicPropertyType<>(
"NinePatchImage2D.StretchTypeLeft", NodeEnums.ContentStretch.class)

Sets how to display the left image:

  • Stretch: Scales the image to fill the space between the top-left and bottom-left images.
  • Wrap: When the height of the space between the top-left and bottom-left images exceeds the height of the image, either extends the last row of pixels in the image or tiles the image. Depends on the value of the Wrap Mode property of the texture.

◆ StretchTypeRightProperty

DynamicPropertyType<NodeEnums.ContentStretch> StretchTypeRightProperty
Initial value:
=
new DynamicPropertyType<>(
"NinePatchImage2D.StretchTypeRight", NodeEnums.ContentStretch.class)

Sets how to display the right image:

  • Stretch: Scales the image to fill the space between the top-right and bottom-right images.
  • Wrap: When the height of the space between the top-right and bottom-right images exceeds the height of the image, either extends the last row of pixels in the image or tiles the image. Depends on the value of the Wrap Mode property of the texture.

◆ StretchTypeTopProperty

Initial value:
=
new DynamicPropertyType<>(
"NinePatchImage2D.StretchTypeTop", NodeEnums.ContentStretch.class)

Sets how to display the top image:

  • Stretch: Scales the image to fill the space between the top-left and top-right images.
  • Wrap: When the width of the space between the top-left and top-right images exceeds the width of the image, either extends the last column of pixels in the image or tiles the image. Depends on the value of the Wrap Mode property of the texture.