Kanzi 3.9.10
NinePatchImage2DMetadata Interface Reference

Metadata definitions for NinePatchImage2D. More...

Inheritance diagram for NinePatchImage2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< ResourceImageBottomLeftProperty
 Image to use in the bottom-left corner.
 
DynamicPropertyType< ResourceImageBottomProperty
 The image to use in middle of the bottom row.
 
DynamicPropertyType< ResourceImageBottomRightProperty
 The image to use in the bottom-right corner.
 
DynamicPropertyType< ResourceImageCenterProperty
 The image to use in the center.
 
DynamicPropertyType< ResourceImageLeftProperty
 The image to use in the center-left.
 
DynamicPropertyType< ResourceImageRightProperty
 The image to use in the center-right.
 
DynamicPropertyType< ResourceImageTopLeftProperty
 The image to use in the top-left corner.
 
DynamicPropertyType< ResourceImageTopProperty
 The image to use in the middle of the top row.
 
DynamicPropertyType< ResourceImageTopRightProperty
 The image to use in the top-right corner.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NinePatchImage2D")
 Metaclass for NinePatchImage2D.
 
DynamicPropertyType< NodeEnums.ContentStretchStretchTypeBottomProperty
 Sets how to display the bottom image:
 
DynamicPropertyType< NodeEnums.ContentStretchStretchTypeCenterProperty
 Sets how to display the center image:
 
DynamicPropertyType< NodeEnums.ContentStretchStretchTypeLeftProperty
 Sets how to display the left image:
 
DynamicPropertyType< NodeEnums.ContentStretchStretchTypeRightProperty
 Sets how to display the right image:
 
DynamicPropertyType< NodeEnums.ContentStretchStretchTypeTopProperty
 Sets how to display the top image:
 
- Public Attributes inherited from Node2DMetadata
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 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.