TextBlock2DMetadata Interface Reference
Metadata definitions for TextBlock2D. More...
Inheritance diagram for TextBlock2DMetadata:
Public Attributes | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextBlock2D") |
| Metaclass for TextBlock2D. | |
 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. | |
| Public Attributes inherited from TextConceptMetadata | |
| DynamicPropertyType< ColorRGBA > | FontColorProperty |
| Sets the color of the text in a 3D text node. | |
| DynamicPropertyType< Resource > | FontMaterialProperty |
| Sets the material whose shader is used to render the text. | |
| DynamicPropertyType< Boolean > | HorizontalFitProperty |
| Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block. | |
| DynamicPropertyType< Vector2 > | HorizontalFitScaleLimitsProperty |
| When the Horizontal Fit property is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width of that Text Block. | |
| DynamicPropertyType< Vector2 > | HorizontalPaddingProperty |
| Sets the padding spaces between the content and the left and right boundaries of the Text node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextConcept") |
| Metaclass for TextConcept. | |
| DynamicPropertyType< String > | OverflowProperty |
| Sets the characters that represent the truncated text when the text does not fit in this node. | |
| DynamicPropertyType< Boolean > | RemoveSideBearingsProperty |
| Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. | |
| DynamicPropertyType< TextFormatEnums.TextHorizontalAlignment > | TextHorizontalAlignmentProperty |
| Sets the horizontal alignment of the text. | |
| DynamicPropertyType< String > | TextProperty |
| Sets the text content that the text node renders. | |
| DynamicPropertyType< TextFormatEnums.TextVerticalAlignment > | TextVerticalAlignmentProperty |
| Sets the vertical alignment of the text. | |
| DynamicPropertyType< TextFormatEnums.TruncationDirection > | TruncationDirectionProperty |
| Sets which part Kanzi truncates when either the Truncation or Overflow property is set and the text does not fit in this node: | |
| DynamicPropertyType< TextFormatEnums.Truncation > | TruncationProperty |
| Sets how Kanzi truncates text when either Truncation or Overflow property is set and the text does not fit in this node: | |
| DynamicPropertyType< Vector2 > | VerticalPaddingProperty |
| Sets the padding spaces between the content and the top and bottom boundaries of the Text node. | |
| Public Attributes inherited from TextBlockConceptMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.TextBlockConcept") |
| Metaclass for TextBlockConcept. | |
| DynamicPropertyType< Boolean > | WordWrapProperty |
| Sets whether to break long lines into multiple lines to make the text fit within the boundaries of the Text Block node. | |
| Public Attributes inherited from FontStyleConceptMetadata | |
| DynamicPropertyType< Float > | CharacterSpacingProperty |
| Sets the character spacing in pixels. | |
| DynamicPropertyType< Float > | FixedCharacterWidthProperty |
| When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels. | |
| DynamicPropertyType< FontHintingPreference > | FontHintingPreferenceProperty |
| Sets the hinting preference of the font. | |
| DynamicPropertyType< Boolean > | FractionalCharacterWidthProperty |
| Sets whether Kanzi uses fractional or rounded character widths to lay out text. | |
| DynamicPropertyType< Float > | LineSpacingProperty |
| Sets the line spacing in multiples of the normal line height of the selected font. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.FontStyleConcept") |
| Metaclass for FontStyleConcept. | |
| DynamicPropertyType< Float > | SizeProperty |
| Sets the size of the font in pixels. | |
| DynamicPropertyType< Boolean > | SnapCharacterToPixelPropertyProperty |
| Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: | |
| DynamicPropertyType< FontStyle > | StyleProperty |
| Sets the style of the font. | |
| DynamicPropertyType< FontWeight > | WeightProperty |
| Sets the weight of the font. | |
Detailed Description
Metadata definitions for TextBlock2D.