Kanzi  3.9.5
Java API
TextBlock3DMetadata Interface Reference

Metadata definitions for TextBlock3D. More...

Inheritance diagram for TextBlock3DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Float > BaselineProperty
 Font baseline in 3D space units. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextBlock3D")
 Metaclass for TextBlock3D.
 
DynamicPropertyType< Boolean > TwoPassRenderingProperty
 Defines whether the Text Block 3D is rendered in two passes. More...
 
- Public Attributes inherited from Node3DMetadata
DynamicPropertyType< Matrix4x4FinalTransformationProperty
 The combined location, orientation and scale of the node and its ancestor nodes. More...
 
DynamicPropertyType< Float > FrustumCullMarginProperty
 The margin of the frustum cull radius of the node. More...
 
DynamicPropertyType< SRTValue3DLayoutTransformationProperty
 The location, orientation and scale of the node relative to its parent node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node3D")
 Metaclass for Node3D.
 
DynamicPropertyType< SRTValue3DRenderTransformationProperty
 The location, orientation, and scale of the node relative to its parent node. More...
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< Float > ActualDepthProperty
 The calculated size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Float > ActualHeightProperty
 The calculated height of the node when used in a layout. More...
 
DynamicPropertyType< Float > ActualWidthProperty
 The calculated width of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > ClipChildrenProperty
 Sets whether to clip the child nodes of thos node. More...
 
DynamicPropertyType< Integer > ContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). More...
 
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. More...
 
DynamicPropertyType< Integer > DepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Boolean > EffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled. More...
 
DynamicPropertyType< Boolean > EnabledProperty
 Whether this node is enabled. More...
 
DynamicPropertyType< Boolean > FocusableProperty
 Indicates whether the node can receive focus. More...
 
DynamicPropertyType< Boolean > FocusedProperty
 Indicates whether the node has keyboard focus. More...
 
DynamicPropertyType< Integer > FocusStateProperty
 Reports the focus state of a node: More...
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text. More...
 
DynamicPropertyType< Float > HeightProperty
 The height of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > HitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing. More...
 
DynamicPropertyType< Boolean > HitTestableProperty
 When enabled, users can pick the node from the default Camera node of the active Scene node. More...
 
DynamicPropertyType< Integer > HorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Boolean > HoverProperty
 Indicates whether a node is the foremost hit testable node under the cursor. More...
 
DynamicPropertyType< String > LocaleProperty
 The locale of the node. More...
 
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. More...
 
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. More...
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node. More...
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node. More...
 
DynamicPropertyType< Integer > VerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > VisibleAmountInParentProperty
 Sets the amount the node is inside its parent. More...
 
DynamicPropertyType< Boolean > VisibleProperty
 When disabled, Kanzi does not render the node. More...
 
DynamicPropertyType< Float > WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout. More...
 
- Public Attributes inherited from TextConceptMetadata
DynamicPropertyType< ColorRGBAFontColorProperty
 Sets the color of the text. More...
 
DynamicPropertyType< ResourceFontMaterialProperty
 Sets the material whose shader is used to render the text. More...
 
DynamicPropertyType< Boolean > HorizontalFitProperty
 Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block. More...
 
DynamicPropertyType< Vector2HorizontalFitScaleLimitsProperty
 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. More...
 
DynamicPropertyType< Vector2HorizontalPaddingProperty
 Sets the padding spaces between the content and the left and right boundaries of the Text node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextConcept")
 Metaclass for TextConcept.
 
DynamicPropertyType< String > OverflowProperty
 Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in the node. More...
 
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. More...
 
DynamicPropertyType< Integer > TextHorizontalAlignmentProperty
 Sets the horizontal alignment of the text. More...
 
DynamicPropertyType< String > TextProperty
 Sets the text content that the text node renders. More...
 
DynamicPropertyType< Integer > TextVerticalAlignmentProperty
 Sets the vertical alignment of the text. More...
 
DynamicPropertyType< Vector2VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of the Text node. More...
 
- 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. More...
 
- Public Attributes inherited from FontStyleConceptMetadata
DynamicPropertyType< Float > CharacterSpacingProperty
 Sets the character spacing in pixels. More...
 
DynamicPropertyType< Float > FixedCharacterWidthProperty
 When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels. More...
 
DynamicPropertyType< Integer > FontHintingPreferenceProperty
 Sets the hinting preference of the font. More...
 
DynamicPropertyType< Boolean > FractionalCharacterWidthProperty
 Sets whether Kanzi uses fractional or rounded character widths to lay out text. More...
 
DynamicPropertyType< Float > LineSpacingProperty
 Sets the line spacing in multiples of the normal line height of the selected FontStyleConcept. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.FontStyleConcept")
 Metaclass for FontStyleConcept.
 
DynamicPropertyType< Float > SizeProperty
 Sets the size of the font in pixels. More...
 
DynamicPropertyType< Boolean > SnapCharacterToPixelPropertyProperty
 Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: More...
 
DynamicPropertyType< Integer > StyleProperty
 Sets the style of the FontStyleConcept. More...
 
DynamicPropertyType< Integer > WeightProperty
 Sets the weight of the FontStyleConcept. More...
 

Detailed Description

Metadata definitions for TextBlock3D.

Member Data Documentation

◆ BaselineProperty

DynamicPropertyType<Float> BaselineProperty
Initial value:
=
new DynamicPropertyType<>("TextBlock3D.Baseline", Float.class)

Font baseline in 3D space units.

◆ TwoPassRenderingProperty

DynamicPropertyType<Boolean> TwoPassRenderingProperty
Initial value:
=
new DynamicPropertyType<>("TextBlock3D.TwoPassRendering", Boolean.class)

Defines whether the Text Block 3D is rendered in two passes.

Disabling the two pass rendering improves performance, but can cause invalid rendering results when glyph bounds overlap.