Kanzi  3.9.4
Kanzi Engine API
kanzi::TextBox3D Class Reference

TextBox3D provides the required overrides to handle 3D rendering and gesture handling for the 3D text input. More...

#include <kanzi/ui/node/text_box3d.hpp>

Inheritance diagram for kanzi::TextBox3D:
[legend]

Properties

using ConceptClass = TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
 
static PropertyType< ColorRGBASelectionBackgroundColorProperty
 Sets the color that highlights the text that is selected in a TextBox3D node. More...
 
static PropertyType< ColorRGBASelectionFontColorProperty
 Sets the color of the text that is selected in a TextBox3D node The default value is sRGB ColorRGBA((1, 1, 1, 1);. More...
 
static PropertyType< ColorRGBACompositionBackgroundColorProperty
 Sets the color that highlights the text that the user composes in a TextBox3D node using an input method editor (IME). More...
 
static PropertyType< ColorRGBACompositionFontColorProperty
 Sets the color of the text that the user composes in a TextBox3D node using an input method editor (IME). More...
 
float m_horizontalScrollPosition
 Tracks the current horizontal scroll position in Text Box 3D. More...
 
static TextBox3DSharedPtr create (Domain *domain, string_view name)
 Creates a TextBox3D node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
void onMultiClick (MultiClickManipulator::MultiClickMessageArguments &args)
 
void onPanMoved (PanManipulator::MovedMessageArguments &args)
 
void onPanStarted (PanManipulator::StartedMessageArguments &args)
 
void onPanFinished (PanManipulator::FinishedMessageArguments &args)
 
ColorRGBA getSelectionBackgroundColor () const
 Returns the value of the SelectionBackgroundColorProperty. More...
 
void setSelectionBackgroundColor (ColorRGBA value)
 Sets the value of the SelectionBackgroundColorProperty. More...
 
ColorRGBA getSelectionFontColor () const
 Returns the value of the SelectionFontColorProperty. More...
 
void setSelectionFontColor (ColorRGBA value)
 Sets the value of the SelectionFontColorProperty. More...
 
ColorRGBA getCompositionBackgroundColor () const
 Returns the value of the CompositionBackgroundColorProperty. More...
 
void setCompositionBackgroundColor (ColorRGBA value)
 Sets the value of the CompositionBackgroundColorProperty. More...
 
ColorRGBA getCompositionFontColor () const
 Returns the value of the CompositionFontColorProperty. More...
 
void setCompositionFontColor (ColorRGBA value)
 Sets the value of the CompositionFontColorProperty. More...
 
void restoreResources () override
 Node::restoreResources() implementation. More...
 
 TextBox3D (Domain *domain, string_view name)
 Constructor. More...
 
virtual ~TextBox3D ()=default
 
void initialize ()
 Initializes the node. More...
 
Vector3 measureOverride (Vector3 availableSize) override
 Layouting measurement override. More...
 
void arrangeOverride (Vector3 actualSize) override
 Layouting arrangement override. More...
 
void renderOverride (Renderer3D &renderer, RenderEntry3D &renderState) override
 Render override. More...
 
void onAttached () override
 Attachment override. More...
 
optional< BoxgetBoundingBox () const override
 Node3D::getBoundingBox() implementation. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Method executed on node property change. More...
 
void onDetached () override
 Node3D::onDetached() implementation. More...
 
const RenderEntryParameterContainergenerateRenderStatesOverride (DrawObjectsRenderPass &drawPass) override
 Node3D::generateRenderStatesOverride() implementation. More...
 
void registerDrawPassOverride (DrawObjectsRenderPassSharedPtr drawPass) override
 Node3D::registerDrawPassOverride() implementation. More...
 
Vector2 calculateAlignmentOffset (const Vector3 size) const
 
void renderCursor (Renderer3D &renderer, const Matrix4x4 &worldTransformation)
 
void renderSelection (Renderer3D &renderer, const Matrix4x4 &worldTransformation)
 
void renderComposition (Renderer3D &renderer, const Matrix4x4 &worldTransformation)
 
optional< Vector2calculatePosition (const InputManipulator::InputMessageArguments &arguments)
 
optional< Vector2calculatePosition (const Ray &ray) const
 
float clampScrollPosition (float originalScrollPosition, TextFormat::TextHorizontalAlignment alignment, TextLayout *textLayout, float editorWidth)
 Clamps a scroll position to the visible area. More...
 
void ensureCursorVisible ()
 Scrolls the text content so that the cursor is visible. More...
 
void ensureMovingSelectionPointVisible ()
 Scrolls the text content so that the selection handle at the end of the text selection is visible. More...
 
void ensureCompositionVisible ()
 Scrolls the text content so that the end position of the composition text is visible. More...
 
void scrollTimerTick ()
 Handles the scroll timer callback. More...
 
float calculateScrollingDistance ()
 Returns the distance of the last pointer event from either side of the editor. More...
 
float getTruncationOffsetWidth () const
 Returns the difference of the editor width and the truncated text width. More...
 
void resetScrollPosition ()
 Resets the scroll position according to the horizontal text alignment of the Text Box 3D node. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::Node3D
typedef ChildContainer::const_iterator ChildConstIterator
 
typedef ChildContainer::const_reverse_iterator ChildConstReverseIterator
 
typedef vector< Node3DSharedPtrChildContainer
 Iterators for children. More...
 
typedef Matrix4x4 LayoutMatrixType
 
typedef Vector3 LayoutVectorType
 
using RenderEntryParameterContainer = vector< RenderEntryParameters >
 Type used for returning render entries from nodes. More...
 
enum  RenderMode { RenderModeNone, RenderModeDefault, RenderModeCustom }
 Rendering mode for the node. More...
 
- Public Types inherited from kanzi::Node
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
typedef InputManipulatorContainer::const_iterator InputManipulatorConstIterator
 
typedef vector< InputManipulatorBaseSharedPtrInputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef InputManipulatorContainer::iterator InputManipulatorIterator
 
typedef kanzi::vector< Node::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
typedef vector< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator. More...
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
typedef function< VisitorResult(Node &)> Visitor
 Defines the type of the function that Kanzi executes for each node when visiting a node tree. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 Defines the order in which Kanzi visits the nodes in a node tree. More...
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 Defines the return type of the Node::Visitor function. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 
- Public Types inherited from kanzi::TextBoxConcept
enum  EditMode { EditMode::Automatic, EditMode::Triggered }
 The edit modes. More...
 
- Public Member Functions inherited from kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
void backspaceAtCursor ()
 Deletes a character using backspace. More...
 
void backspaceWordAtCursor ()
 Deletes the characters between the cursor position and the closest word boundary using backspace. More...
 
void cancelTextComposition ()
 Tells a Text Box node to cancel text composition. More...
 
void clearSelection ()
 Clears the current selection. More...
 
void commitCompositionText ()
 Tells a Text Box node to commit the composition text. More...
 
void deleteAtCursor ()
 Deletes a character using delete. More...
 
void deleteSelection ()
 Erases selected text. More...
 
void deleteText (size_t begin, size_t end)
 Moves the cursor to position begin and erases UTF-8 characters between positions a\ begin and end. More...
 
void deleteWordAtCursor ()
 Deletes the characters between the cursor position and the word boundary that follows the cursor. More...
 
void enterEditingState ()
 Tells a Text Box node to enter the editing state. More...
 
string getCompositionText () const
 Returns the composition text. More...
 
string getDisplayText () const
 Returns a displayable text that Kanzi constructs from the text buffer of the input manipulator owned by the Text Box node, using the kanzi::EchoMode of the Text Box. More...
 
float getLineHeight ()
 Returns the line height of the font that the Text Box node uses. More...
 
string getSelectedText ()
 Returns the text that is currently selected in the Text Box node. More...
 
size_t getSelectionEnd () const
 Returns the end index for the current selection. More...
 
optional< size_t > getSelectionStart () const
 Returns the start index for the current text selection, or nullopt if no text is selected. More...
 
bool hasSelection () const
 Returns whether any of the text in a Text Box node is selected. More...
 
void insertText (size_t position, string_view text)
 Moves the cursor to a given position and inserts text to that position. More...
 
void insertTextAtCursor (string_view text)
 Inserts text in a Text Box node at the cursor position and moves the cursor forward. More...
 
void leaveEditingState ()
 Tells a Text Box node to leave the editing state. More...
 
void moveCursorBackward (size_t distance)
 Moves the cursor backward in the text buffer of a Text Box node. More...
 
void moveCursorBackward ()
 Moves the cursor backward by one character. More...
 
void moveCursorForward (size_t distance)
 Moves the cursor forward in the text buffer of a Text Box node. More...
 
void moveCursorForward ()
 Moves the cursor forward by one character. More...
 
void moveCursorHome ()
 Moves the cursor to the beginning of the text buffer of a Text Box node. More...
 
void moveCursorToEnd ()
 Moves the cursor to the end of the text buffer of a Text Box node. More...
 
void moveCursorToNextWord ()
 Moves the cursor to the next word. More...
 
void moveCursorToPreviousWord ()
 Moves the cursor to the previous word. More...
 
void moveSelectionEndBackward (size_t distance)
 Moves the end of text selection backward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionEndBackward ()
 Moves the end of the text selection backward by one character. More...
 
void moveSelectionEndForward (size_t distance)
 Moves the end of text selection forward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionEndForward ()
 Moves the end of the text selection forward by one character. More...
 
void moveSelectionEndpointBackward (size_t steps)
 Moves the active selection end-point backward with steps passed as argument. More...
 
void moveSelectionEndpointForward (size_t steps)
 Moves the active selection end-point forward with steps passed as argument. More...
 
void moveSelectionEndpointToBack ()
 Moves the active selection end-point to the end of the text. More...
 
void moveSelectionEndpointToFront ()
 Moves the active selection end-point to the front. More...
 
void moveSelectionEndpointToNextWord ()
 Moves the active selection end-point forward to the previous word boundary. More...
 
void moveSelectionEndpointToPreviousWord ()
 Moves the active selection end-point backward to the previous word boundary. More...
 
void moveSelectionEndToNextWord ()
 Moves the end of the text selection forward to the next word. More...
 
void moveSelectionEndToPreviousWord ()
 Moves the end of the text selection backward to the previous word. More...
 
void moveSelectionStartBackward (size_t distance)
 Moves the start of text selection backward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionStartBackward ()
 Moves the beginning of the text selection backward by one character. More...
 
void moveSelectionStartForward (size_t distance)
 Moves the selection start forward in the text buffer of a Text Box node. More...
 
void moveSelectionStartForward ()
 Moves the beginning of the text selection forward by one character. More...
 
void moveSelectionStartToNextWord ()
 Moves the beginning of the text selection forward to the next word. More...
 
void moveSelectionStartToPreviousWord ()
 Moves the beginning of the text selection backward to the previous word. More...
 
void notifyPostPrepareTextFormat (bool completeRelayoutingExecuted)
 Kanzi calls this function every time it successfully completes the prepareTextFormat function. More...
 
void selectAll ()
 Selects all the content in a Text Box node. More...
 
void selectText (size_t from, size_t to)
 Selects the text between given indexes (cursor positions). More...
 
void selectWordAt (size_t characterPosition)
 Selects the word at the specified character position. More...
 
void selectWordAtCursor ()
 Selects the word at the current cursor position. More...
 
void setSelectionEnd (size_t index)
 Sets the end index for the current selection. More...
 
void setSelectionStart (size_t index)
 Sets the start index for the current selection. More...
 
BrushSharedPtr getSelectionBackgroundBrush () const
 Returns the value of the SelectionBackgroundBrushProperty. More...
 
void setSelectionBackgroundBrush (BrushSharedPtr value)
 Sets the value of the SelectionBackgroundBrushProperty. More...
 
BrushSharedPtr getSelectionForegroundBrush () const
 Returns the value of the SelectionForegroundBrushProperty. More...
 
void setSelectionForegroundBrush (BrushSharedPtr value)
 Sets the value of the SelectionForegroundBrushProperty. More...
 
BrushSharedPtr getCompositionBackgroundBrush () const
 Returns the value of the CompositionTextBackgroundBrushProperty. More...
 
void setCompositionBackgroundBrush (BrushSharedPtr value)
 Sets the value of the CompositionTextBackgroundBrushProperty. More...
 
BrushSharedPtr getCompositionForegroundBrush () const
 Returns the value of the CompositionTextForegroundBrushProperty. More...
 
void setCompositionForegroundBrush (BrushSharedPtr value)
 Sets the value of the CompositionTextForegroundBrushProperty. More...
 
size_t getCursorPosition ()
 Returns the value of the CursorPositionProperty. More...
 
void setCursorPosition (size_t value)
 Sets the value of the CursorPositionProperty. More...
 
bool isReadOnly () const
 Returns the value of the ReadOnlyProperty. More...
 
void setReadOnly (bool value)
 Sets the value of the ReadOnlyProperty. More...
 
size_t getMaximumTextLength () const
 Returns the value of the MaximumTextLengthProperty. More...
 
void setMaximumTextLength (size_t value)
 Sets the value of the MaximumTextLengthProperty. More...
 
PrefabTemplateSharedPtr getCursorPrefab () const
 Returns the value of the CursorPrefabProperty. More...
 
void setCursorPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the CursorPrefabProperty. More...
 
PrefabTemplateSharedPtr getSelectionStartPrefab () const
 Returns the value of the SelectionStartPrefabProperty. More...
 
void setSelectionStartPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the SelectionStartPrefabProperty. More...
 
PrefabTemplateSharedPtr getSelectionEndPrefab () const
 Returns the value of the SelectionEndPrefabProperty. More...
 
void setSelectionEndPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the SelectionEndPrefabProperty. More...
 
PrefabTemplateSharedPtr getTextHintPrefab () const
 Returns the value of the TextHintPrefabProperty. More...
 
void setTextHintPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the TextHintPrefabProperty. More...
 
bool isHideTextHintWhenFocused () const
 Returns the value of the HideTextHintWhenEditingProperty. More...
 
void setHideTextHintWhenFocused (bool value)
 Sets the value of the HideTextHintWhenEditingProperty. More...
 
EchoMode getEchoMode () const
 Returns the value of the EchoModeProperty. More...
 
void setEchoMode (const EchoMode &mode)
 Sets the value of the EchoModeProperty. More...
 
InputType getInputType () const
 Returns the value of the InputTypeProperty. More...
 
void setInputType (const InputType &inputType)
 Sets the value of the InputTypeProperty. More...
 
EditMode getEditMode () const
 Returns the value of the EditModeProperty. More...
 
void setEditMode (const EditMode &mode)
 Sets the value of the EditModeProperty. More...
 
bool isEditing () const
 Returns the value of the IsEditingProperty. More...
 
bool isComposingText () const
 Returns the value of the IsComposingTextProperty. More...
 
size_t getCharacterCount ()
 Returns the value of the CharacterCountProperty. More...
 
size_t getWordCount ()
 Returns the value of the WordCountProperty. More...
 
int getPasswordEchoTimeout () const
 Returns the value of the PasswordEchoTimeoutProperty. More...
 
void setPasswordEchoTimeout (int timeout)
 Sets the value of the PasswordEchoTimeoutProperty. More...
 
string getPasswordMaskingCharacter () const
 Returns the value of the PasswordMaskingCharacterProperty. More...
 
void setPasswordMaskingCharacter (string_view passwordMask)
 Sets the value of the PasswordMaskingCharacterProperty. More...
 
InputMethodAction getInputMethodAction () const
 Returns the value of the InputMethodActionProperty. More...
 
void setInputMethodAction (InputMethodAction label)
 Sets the value of the InputMethodActionProperty. More...
 
TextKeyNavigationDirection getTextKeyNavigationDirection () const
 Returns the value of the TextKeyNavigationDirectionProperty. More...
 
void setTextKeyNavigationDirection (TextKeyNavigationDirection direction)
 Sets the value of the TextKeyNavigationDirectionProperty. More...
 
- Public Member Functions inherited from kanzi::Node3D
bool addAbstractChildOverride (NodeSharedPtr child) override
 
void addChild (const Node3DSharedPtr &child)
 Adds a child node for object node. More...
 
void arrange ()
 Perform layout arrangement on a node. More...
 
void arrangeIterate ()
 Initial scene arrange. More...
 
void arrangeIterateLayout (bool propagateArrange)
 
void arrangeIterateLayoutChild (bool propagateArrange)
 
ChildConstIterator beginChildren () const
 
void centeredArrange (Vector3 actualSize) const
 Default implementation of arrange for a layout that accommodates all children at its center. More...
 
Vector3 centeredMeasure (Vector3 availableSize) const
 Default implementation of measure for a layout that accommodates all children at its center. More...
 
ChildConstIterator endChildren () const
 
const RenderEntryParameterContainergenerateRenderStates (DrawObjectsRenderPass &drawPass)
 Gets a listing of render entry parameters used for generating render states. More...
 
size_t getAbstractChildCountOverride () override
 
size_t getAbstractChildIndexOverride (const Node &node) override
 
NodeSharedPtr getAbstractChildOverride (size_t index) override
 
Vector3 getActualSize () const
 Get actual size of an object. More...
 
Vector3 getAllocatedOffset () const
 Get allocated offset of an object. More...
 
Vector3 getAllocatedSize () const
 Get allocated size of an object. More...
 
Matrix4x4 getArrangeTransformation () const
 Gets the layout transformation of the object. More...
 
Node3DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
size_t getChildCount () const
 Gets child count from object. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
Vector3 getCoreDesiredSize () const
 Get core desired size of an object. More...
 
Vector3 getDesiredSize () const
 Get desired size for of object. More...
 
Node3DSharedPtr getFaceToCameraTarget () const
 
void getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
 Get bounding box size for an object. More...
 
Node3DSharedPtr getLookAtTarget () const
 
Vector3 getMaximumBoundingBoxCoordinates () const
 Returns the minimum coordinates for object nodes bounding volume. More...
 
Vector3 getMinimumBoundingBoxCoordinates () const
 Returns the maximum coordinates for object nodes bounding volume. More...
 
Node3DSharedPtr getOrientationConstraintTarget () const
 
Vector3 getPivotOffset () const
 Get pivot offset of an object. More...
 
Node3DSharedPtr getPositionConstraintTarget () const
 
RenderMode getRenderMode () const
 Gets the render mode. More...
 
Vector3 getSize () const
 Returns the size of object node. More...
 
Vector3 getStretchScale () const
 Get stretch scale of an object. More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
void insertChild (size_t index, const Node3DSharedPtr &child)
 Adds a child node for object node to given index. More...
 
bool isPrimitiveLayout () const
 Indicates whether the node has primitive layout behavior. More...
 
void layout ()
 Recursively calculate the layouts in the scene. More...
 
void measure (const Vector3 &availableSize)
 Perform the default measure step. More...
 
void measureIterate ()
 Initial scene measure. More...
 
virtual bool measureRecursive ()
 Perform layout measurement on a node. More...
 
bool moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
 Node::moveAbstractChildToPosition() implementation. More...
 
void moveChildToPosition (Node3DSharedPtr child, size_t index)
 Moves a child node to a given position in the list of child nodes. More...
 
void moveToBack ()
 Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
 
void moveToFront ()
 Repositions the node to the end of its parent's children, so that it is drawn last. More...
 
virtual void onTransform ()
 Per-node step performed on transform (after final transformation has been calculated. More...
 
ChildConstReverseIterator rbeginChildren () const
 
void registerDrawPass (DrawObjectsRenderPassSharedPtr drawPass)
 Register a draw objects render pass as rendering this node. More...
 
bool removeAbstractChildOverride (Node &child) override
 
void removeAllChildren ()
 Removes all child nodes from parent object. More...
 
void removeChild (const Node &child)
 Removes child node from parent object. More...
 
void removeChild (size_t index)
 Removes child node from parent object node at specified index. More...
 
ChildConstReverseIterator rendChildren () const
 
void render (Renderer3D &renderer, RenderEntry3D &renderState)
 Render this node using given render state. More...
 
void setActualSize (const Vector3 &actualSize)
 Set actual size for an object. More...
 
void setAllocatedOffset (const Vector3 &allocatedOffset)
 Set allocated offset for an object. More...
 
void setAllocatedSize (const Vector3 &layoutSize)
 Set allocated size for an object. More...
 
void setArrangeTransformation (const Matrix4x4 &value)
 Sets the layout transformation of the object. More...
 
void setAutoDepth ()
 Sets node to automatically determine depth. More...
 
void setAutoHeight ()
 Sets node to automatically determine height. More...
 
void setAutoSize ()
 Sets node to automatically determine width, height and depth. More...
 
void setAutoWidth ()
 Sets node to automatically determine width. More...
 
void setCoreDesiredSize (const Vector3 &coreDesiredSize)
 Set core desired size for an object. More...
 
void setDesiredSize (const Vector3 &desiredSize)
 Set desired size for an object. More...
 
void setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
 Set bounding box size for an object. More...
 
void setPivotOffset (const Vector3 &pivotOffset)
 Set pivot offset for an object. More...
 
void setRenderMode (RenderMode mode)
 Sets the render mode. More...
 
void setSize (float width, float height, float depth)
 Sets size properties of the node. More...
 
void setSize (Vector3 size)
 Sets size properties of the node. More...
 
void setStretchScale (const Vector3 &stretchScale)
 Set stretch scale for an object. More...
 
 ~Node3D () override
 
Matrix4x4 getFinalTransformation () const
 Gets the value of FinalTransformationProperty. More...
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of FinalTransformationProperty. More...
 
float getFrustumCullMargin () const
 Gets the value of FrustumCullMarginProperty. More...
 
void setFrustumCullMargin (float value)
 Sets the value of FrustumCullMarginProperty. More...
 
SRTValue3D getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (SRTValue3D value)
 Sets the value of RenderTransformationProperty. More...
 
SRTValue3D getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (SRTValue3D value)
 Sets the value of LayoutTransformationProperty. More...
 
- Public Member Functions inherited from kanzi::Node
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< TacquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource. More...
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets the resource dictionary of the node. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where the handler is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where the handler is a function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
 
void addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node. More...
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Add a nested resource dictionary to the resource dictionary of the node. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
 
AppliedStyleEntrySharedPtr applyManualStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
AppliedStyleEntrySharedPtr applyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
NodeComponentConstIterator beginNodeComponents () const
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
 
BindingLookupContextPtr createLookupContext (NodeSharedPtr templateRoot)
 Creates a lookup context for the node. More...
 
void detachRecursive ()
 Detaches an object node and its children recursively. More...
 
void dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
 Dispatches a message from this node with specified arguments. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message from this node with specified arguments. More...
 
InputManipulatorConstIterator endInputManipulators () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename TNodeType >
shared_ptr< TNodeType > findAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 Tries to find Resource URL for Resource ID from this node. More...
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
FocusScopegetFocusScopeInfo () const
 Returns the information about the focus scope for a node. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
NodegetParent () const
 Returns the parent of the node. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 Gets the resource dictionary of the node, if the node has one. More...
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void invalidateDraw ()
 Invalidates draw flag for the node. More...
 
void invalidateFinalTransform ()
 Invalidates final transform for node. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void invalidateRender ()
 Invalidates render for node. More...
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags is set. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants. More...
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isDetaching () const
 Returns true if the node currently detaching. More...
 
bool isEffectivelyFocusable () const
 Returns whether a node and its ancestor focus scope nodes are focusable. More...
 
bool isEffectivelyVisible () const
 Returns whether a node and its ancestor nodes are visible. More...
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
bool isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
bool isInvalidFinalTransform () const
 Tells if final transform flag is invalid for node. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
bool isNamed (string_view name) const
 
 KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name. More...
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager. More...
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
void removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
 Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
void removeNodeReference (const AbstractNodeReference &reference)
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void setParent (Node *parent)
 Kanzi uses this method internally to set the parent of a node. More...
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of the node. More...
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node. More...
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< TtryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...
 
KZ_DEPRECATED NodeSharedPtr trySetActiveFocus ()
 Tries to move the focus on this node. More...
 
NodeSharedPtr trySetFocus ()
 Tries to move the focus to this node. More...
 
NodeSharedPtr trySetFocus (FocusFallback fallbackOption)
 Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. More...
 
void unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void validateArrange ()
 Validates arrange. More...
 
void validateDraw ()
 Validates draw flags for the node. More...
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
void validateRender ()
 Validates render for node. More...
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 Visits a node and its descendants. More...
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 Visits the descendants of a node. More...
 
 ~Node () override
 Destructor. More...
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string_view value)
 Sets the value of NameProperty. More...
 
string getPath () const
 Gets the value of PathProperty. More...
 
void setPath (string value)
 Sets the value of PathProperty. More...
 
string getLocale () const
 Gets the value of LocaleProperty. More...
 
void setLocale (string value)
 Sets the value of LocaleProperty. More...
 
bool isHitTestable () const
 Gets the value of HitTestableProperty. More...
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty. More...
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty. More...
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty. More...
 
bool isVisible () const
 Gets the value of VisibleProperty. More...
 
void setVisible (bool value)
 Sets the value of VisibleProperty. More...
 
bool isEnabled () const
 Returns the value of the EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
bool isEffectivelyEnabled () const
 Returns the value of EffectivelyEnabledProperty. More...
 
bool isFocusable () const
 Gets the value of the FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of the FocusableProperty. More...
 
bool isFocused () const
 Gets the value of the FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of the FocusedProperty. More...
 
FocusState getFocusState () const
 Gets the value of the FocusStateProperty. More...
 
void setFocusState (FocusState state)
 Sets the value of the FocusStateProperty. More...
 
FontFamilySharedPtr getFontFamily () const
 Gets the font family the node uses. More...
 
void setFontFamily (FontFamilySharedPtr value)
 Sets the font family the node uses. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty. More...
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty. More...
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty. More...
 
void setStateManager (ResourceSharedPtr value)
 Sets the value of StateManagerProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
float getDepth () const
 Gets the value of DepthProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
float getActualWidth () const
 Gets the value of ActualWidthProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
float getActualHeight () const
 Gets the value of ActualHeightProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
float getActualDepth () const
 Gets the value of ActualDepthProperty. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty. More...
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty. More...
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty. More...
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty. More...
 
float getOpacity () const
 Gets the value of OpacityProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
bool isHover () const
 Returns whether the node has HoverProperty set to true. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (AbstractBindingRuntime &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 
- Public Member Functions inherited from kanzi::TextBoxConcept
 KZ_METACLASS_PROPERTY_TYPE (CompositionTextProperty)
 
- Public Member Functions inherited from kanzi::TextConceptImpl< TextBox3D >
ColorRGBA getFontColor () const
 Gets the value of the FontColorProperty. More...
 
MaterialSharedPtr getFontMaterial () const
 Gets the value of the FontMaterialProperty. More...
 
bool getHorizontalFit () const
 Gets the value of the HorizontalFitProperty. More...
 
Vector2 getHorizontalFitScaleLimits () const
 Gets the value of the HorizontalFitScaleLimitsProperty. More...
 
Vector2 getHorizontalPadding () const
 Gets the value of HorizontalPaddingProperty. More...
 
string getOverflow () const
 Gets the value of the OverflowProperty. More...
 
bool getRemoveSideBearings () const
 Gets the value of the RemoveSideBearingsProperty. More...
 
string getText () const
 Gets the value of TextProperty. More...
 
TextFormat::TextHorizontalAlignment getTextHorizontalAlignment () const
 Gets the value of the TextHorizontalAlignmentProperty. More...
 
TextFormat::TextVerticalAlignment getTextVerticalAlignment () const
 Gets the value of the TextVerticalAlignmentProperty. More...
 
Vector2 getVerticalPadding () const
 Gets the value of VerticalPaddingProperty. More...
 
void setFontColor (ColorRGBA value)
 Sets the value of the FontColorProperty. More...
 
void setFontMaterial (MaterialSharedPtr value)
 Sets the value of the FontMaterialProperty. More...
 
void setHorizontalFit (bool value)
 Sets the value of the HorizontalFitProperty. More...
 
void setHorizontalFitScaleLimits (Vector2 value)
 Sets the value of the HorizontalFitScaleLimitsProperty. More...
 
void setHorizontalPadding (Vector2 value)
 Sets the value of HorizontalPaddingProperty. More...
 
void setOverflow (string_view value)
 Sets the value of the OverflowProperty. More...
 
void setRemoveSideBearings (bool value)
 Sets the value of the RemoveSideBearingsProperty. More...
 
void setText (string value)
 Sets the value of TextProperty. More...
 
void setTextHorizontalAlignment (TextFormat::TextHorizontalAlignment value)
 Sets the value of the TextHorizontalAlignmentProperty. More...
 
void setTextVerticalAlignment (TextFormat::TextVerticalAlignment value)
 Sets the value of the TextVerticalAlignmentProperty. More...
 
void setVerticalPadding (Vector2 value)
 Sets the value of VerticalPaddingProperty. More...
 
virtual ~TextConceptImpl ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::TextConcept
virtual ~TextConcept ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::FontStyleConceptImpl< TextBox3D >
float getCharacterSpacing () const
 Gets the value of the FontStyleConcept::CharacterSpacingProperty property. More...
 
float getFixedCharacterWidth () const
 Gets the value of the FontStyleConcept::FixedCharacterWidthProperty property. More...
 
float getFontSize () const
 Gets the value of the FontStyleConcept::SizeProperty property. More...
 
FontStyle getFontStyle () const
 Gets the value of the FontStyleConcept::StyleProperty property. More...
 
FontWeight getFontWeight () const
 Gets the value of the FontStyleConcept::WeightProperty property. More...
 
bool getFractionalCharacterWidth () const
 Gets the value of the FontStyleConcept::FractionalCharacterWidthProperty property. More...
 
FontHintingPreference getHintingPreference () const
 Gets the value of HintingPreferenceProperty. More...
 
float getLineSpacing () const
 Gets the value of the FontStyleConcept::LineSpacingProperty property. More...
 
FontRuntimeSharedPtr getRuntimeFont ()
 Gets the runtime font. More...
 
bool getSnapCharacterToPixel () const
 Gets the value of the FontStyleConcept::SnapCharacterToPixelProperty property. More...
 
void releaseRuntimeFont ()
 Releases the runtime font that is held by FontStyleConceptImpl. More...
 
void setCharacterSpacing (float value)
 Sets the value of the FontStyleConcept::CharacterSpacingProperty property. More...
 
void setFixedCharacterWidth (float value)
 Sets the value of the FontStyleConcept::FixedCharacterWidthProperty property. More...
 
void setFontSize (float value)
 Sets the value of the FontStyleConcept::SizeProperty property. More...
 
void setFontStyle (FontStyle style)
 Sets the value of the FontStyleConcept::StyleProperty property. More...
 
void setFontWeight (FontWeight weight)
 Sets the value of the FontStyleConcept::WeightProperty property. More...
 
void setFractionalCharacterWidth (bool enable)
 Sets the value of the FontStyleConcept::FractionalCharacterWidthProperty property. More...
 
void setHintingPreference (FontHintingPreference hintingPreference)
 Sets the value of HintingPreferenceProperty. More...
 
void setLineSpacing (float value)
 Sets the value of the FontStyleConcept::LineSpacingProperty property. More...
 
void setSnapCharacterToPixel (bool enable)
 Sets the value of the FontStyleConcept::SnapCharacterToPixelProperty property. More...
 
bool updateRuntimeFont ()
 Updates the runtime font. More...
 
- Public Member Functions inherited from kanzi::RenderEntryRegistry< TextBox3D >
void cleanRenderEntryRegistry ()
 Clean references to this node from all all render entries. More...
 
TextBox3DgetThisObject ()
 Gets the pointer to this object. More...
 
void insertReferringDrawPass (DrawObjectsRenderPassWeakPtr drawPass)
 Insert a referring draw pass. More...
 
 ~RenderEntryRegistry ()
 Destructor. More...
 
- Static Public Member Functions inherited from kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node3D
static bool isUnboundedLayoutSize (Vector3 layoutSize)
 Indicates whether a layout size is an unbound layout size. More...
 
static bool isValidLayoutSize (Vector3 size)
 Indicates whether a size is valid layout size. More...
 
static float layoutUp ()
 Returns the direction to which the Y-axis grows for this node type. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static Vector3 replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
 Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
 
static Vector3 replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
 Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
 
static Vector3 unboundedLayoutSize ()
 Returns an unbounded layout size. More...
 
- Static Public Member Functions inherited from kanzi::Node
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value. More...
 
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value. More...
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it. More...
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it. More...
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::TextBoxConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextConceptImpl< TextBox3D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::FontStyleConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4FinalTransformationProperty
 FinalTransformation property. More...
 
static PropertyType< float > FrustumCullMarginProperty
 FrustumCullMargin property. More...
 
static PropertyType< SRTValue3DRenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< SRTValue3DLayoutTransformationProperty
 LayoutTransformation property. More...
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property. More...
 
static PropertyType< string > PathProperty
 Path property. More...
 
static PropertyType< string > LocaleProperty
 Locale property. More...
 
static PropertyType< bool > CreatedFromKZBProperty
 CreatedFromKZB property. More...
 
static PropertyType< bool > HitTestableProperty
 HitTestable property. More...
 
static PropertyType< bool > HitTestableContainerProperty
 HitTestableContainer property. More...
 
static PropertyType< bool > VisibleProperty
 Visible property. More...
 
static PropertyType< bool > EnabledProperty
 Sets whether the node is enabled. More...
 
static PropertyType< bool > EffectivelyEnabledProperty
 Indicates whether the node and its ancestor nodes are enabled. More...
 
static PropertyType< bool > FocusableProperty
 Sets whether a node can get focus and can participate in the focus chain navigation. More...
 
static PropertyType< bool > FocusedProperty
 Sets whether a node is an focus node and can receive keyboard messages. More...
 
static PropertyType< FocusStateFocusStateProperty
 Reports the focus state of a focusable node or focus scope node. More...
 
static PropertyType< ResourceSharedPtrFontFamilyProperty
 Sets the font family the node uses. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property. More...
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 StateManager property. More...
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 
static PropertyType< float > WidthProperty
 Width property. More...
 
static PropertyType< float > HeightProperty
 Height property. More...
 
static PropertyType< float > DepthProperty
 Depth property. More...
 
static PropertyType< float > ActualWidthProperty
 ActualWidth property. More...
 
static PropertyType< float > ActualHeightProperty
 ActualHeight property. More...
 
static PropertyType< float > ActualDepthProperty
 ActualDepth property. More...
 
static PropertyType< Node::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2DepthMarginProperty
 Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< bool > HoverProperty
 Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property. More...
 
- Static Public Attributes inherited from kanzi::TextBoxConcept
static MessageType< TextCompositionStateMessageArgumentsCompositionTextChangedMessage
 Text Box dispatches this message when the composition text is updated by the input methods. More...
 
static MessageType< TextCompositionStateMessageArgumentsCompositionTextCommittedMessage
 Text Box dispatches this message when the composition text is committed to the cached text. More...
 
static MessageType< CursorPositionMessageArgumentsCursorMovedMessage
 Text Box node dispatches this message when the application user moves the cursor in that Text Box node. More...
 
static MessageType< TextChangedMessageArgumentsEditingFinishedMessage
 Text Box node dispatches this message when it leaves the editing state after the application user modifies the text content. More...
 
static MessageType< TextChangedMessageArgumentsEditingStartedMessage
 Text Box node dispatches this message when the application user makes the first modification to the text in that Text Box node. More...
 
static MessageType< EditingStateChangedMessageArgumentsEnteredEditingStateMessage
 Text Box node dispatches this message when it enters the editing state. More...
 
static MessageType< InputMethodActionMessageArgumentsInputMethodActionMessage
 Text Box node dispatches this message when an input method executes the input action assigned to the text box. More...
 
static MessageType< InputMethodAvailableMessageArgumentsInputMethodAvailableMessage
 Text Box node dispatches this message when an input method becomes available. More...
 
static MessageType< InputMethodAvailableMessageArgumentsInputMethodUnavailableMessage
 Text Box node dispatches this message when the composing input method becomes unavailable. More...
 
static MessageType< EditingStateChangedMessageArgumentsLeftEditingStateMessage
 Text Box node dispatches this message when it leaves the editing state. More...
 
static MessageType< SelectedTextMessageArgumentsSelectionChangedMessage
 Text Box node dispatches this message when the application user changes the text selection in that Text Box node. More...
 
static MessageType< CursorPositionMessageArgumentsSelectionClearedMessage
 Text Box node dispatches this message when the application user clears or resets the text selection in that Text Box node. More...
 
static MessageType< SelectedTextMessageArgumentsSelectionStartedMessage
 Text Box node dispatches this message when the application user starts selecting text in that Text Box node. More...
 
static MessageType< TextChangedMessageArgumentsTextChangedMessage
 Text Box node dispatches this message when the application user changes the text in that Text Box node. More...
 
static MessageType< TextCompositionStateMessageArgumentsTextCompositionCanceledMessage
 Text Box dispatches this message when the text composition is canceled. More...
 
static PropertyType< string > DisplayTextProperty
 Reports the text displayed in a Text Box. More...
 
static PropertyType< string > CompositionTextProperty
 Reports the text that the user composes in a Text Box using an input method editor (IME). More...
 
static PropertyType< ResourceSharedPtrSelectionBackgroundBrushProperty
 Sets the brush that highlights selected text. More...
 
static PropertyType< ResourceSharedPtrSelectionForegroundBrushProperty
 Sets the brush for rendering the selected text. More...
 
static PropertyType< ResourceSharedPtrCompositionTextBackgroundBrushProperty
 Sets the brush that highlights the text that the user composes using an input method editor (IME). More...
 
static PropertyType< ResourceSharedPtrCompositionTextForegroundBrushProperty
 Sets the brush that fills the text that the user composes using an input method editor (IME). More...
 
static PropertyType< int > CursorPositionProperty
 Sets the position of the cursor in the text buffer of a Text Box node. More...
 
static PropertyType< int > SelectionStartCursorPositionProperty
 Reports the position of the cursor that marks the beginning of text selection in the text buffer of a Text Box node. More...
 
static PropertyType< int > SelectionEndCursorPositionProperty
 Reports the position of the cursor that marks the end of text selection in the text buffer of a Text Box node. More...
 
static PropertyType< bool > HasSelectionProperty
 Reports whether any of the text in a Text Box node is selected. More...
 
static PropertyType< bool > ReadOnlyProperty
 Sets whether the Text Box node accepts user input. More...
 
static PropertyType< int > MaximumTextLengthProperty
 Sets the maximum allowed text length in a Text Box node. More...
 
static PropertyType< ResourceSharedPtrCursorPrefabProperty
 Sets the prefab template that defines the appearance of the cursor, instead of using the default cursor. More...
 
static PropertyType< ResourceSharedPtrSelectionStartPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection, instead of using the default handle. More...
 
static PropertyType< ResourceSharedPtrSelectionEndPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the end of text selection, instead of using the default handle. More...
 
static PropertyType< ResourceSharedPtrTextHintPrefabProperty
 Sets the prefab template that a Text Box node uses to show placeholder content when there is no text content in that Text Box node. More...
 
static PropertyType< bool > HideTextHintWhenEditingProperty
 Sets whether Kanzi hides the placeholder content, which you set using the TextHintPrefabProperty, either: More...
 
static PropertyType< EchoModeEchoModeProperty
 Sets how a Text Box node shows text. More...
 
static PropertyType< InputTypeInputTypeProperty
 Sets the input type of the input methods that provide the input for a Text Box. More...
 
static PropertyType< EditModeEditModeProperty
 Sets the edit mode of a Text Box node. The default value is EditMode::Automatic. More...
 
static PropertyType< bool > IsEditingProperty
 Reports the editing state of a Text Box node. More...
 
static PropertyType< bool > IsComposingTextProperty
 Reports the text composition state of a Text Box node. More...
 
static PropertyType< int > CharacterCountProperty
 Contains the number of characters in a Text Box node. More...
 
static PropertyType< int > WordCountProperty
 Contains the number of words in a Text Box node. More...
 
static PropertyType< int > PasswordEchoTimeoutProperty
 Sets the time in milliseconds that Kanzi shows an inserted character before masking it when using the EchoMode::Password echo mode. More...
 
static PropertyType< string > PasswordMaskingCharacterProperty
 Sets the UTF-8 character that masks each password character when using EchoMode::Password. More...
 
static PropertyType< InputMethodActionInputMethodActionProperty
 Sets the label of the user action button on the on-screen keyboard. More...
 
static PropertyType< TextKeyNavigationDirectionTextKeyNavigationDirectionProperty
 Sets the direction of key navigation for the Text Box node. More...
 
static MessageType< TextContentMessageArgumentsInsertTextAtCursorMessage
 Dispatch this message to insert given text at the cursor position. More...
 
static MessageType< EraseCharactersMessageArgumentsBackspaceAtCursorMessage
 Dispatch this message to erase at the cursor position the previous character in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsBackspaceWordAtCursorMessage
 Dispatch this message to erase the characters between the cursor position and the previous word boundary in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsDeleteAtCursorMessage
 Dispatch this message to erase at the cursor position the next character in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsDeleteWordAtCursorMessage
 Dispatch this message to erase the characters between the cursor position and the next word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorBackwardMessage
 Dispatch this message to move the cursor backward in a text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorForwardMessage
 Dispatch this message to move the cursor forward in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToPreviousWordMessage
 Dispatch this message to move the cursor to the previous word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToNextWordMessage
 Dispatch this message to move the cursor to the next word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorHomeMessage
 Dispatch this message to move the cursor to the beginning of the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToEndMessage
 Dispatch this message to move the cursor to the end of the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartForwardMessage
 Dispatch this message to move the handle at the start of text selection forward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartBackwardMessage
 Dispatch this message to move the handle at the start of text selection backward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartToNextWordMessage
 Dispatch this message to move the handle at the start of text selection forward to the start of the next word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartToPreviousWordMessage
 Dispatch this message to move the handle at the start of text selection backward to the start of the previous word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndForwardMessage
 Dispatch this message to move the handle at the end of text selection forward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndBackwardMessage
 Dispatch this message to move the handle at the end of text selection backward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndToNextWordMessage
 Dispatch this message to move the handle at the end of text selection forward to the start of the next word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndToPreviousWordMessage
 Dispatch this message to move the handle at the end of text selection backward to the start of the previous word in the text string. More...
 
static MessageType< TextRangeMessageArgumentsSelectTextMessage
 Dispatch this message to select the text between two character indexes in the current text string. More...
 
static MessageType< TextRangeMessageArgumentsDeleteTextMessage
 Dispatch this message to delete the text between two character indexes in the current text string. More...
 
static MessageType< DeleteSelectionMessageArgumentsDeleteSelectionMessage
 Dispatch this message to erase any currently selected text. More...
 
static MessageType< TextInsertionMessageArgumentsInsertTextMessage
 Dispatch this message to insert given text at a given position. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectToHomeMessage
 Dispatch this message to select the text from the beginning of the text string to the cursor position. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectToEndMessage
 Dispatch this message to select the text from the cursor position to the end of the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsClearSelectionMessage
 Dispatch this message to clear the current text selection. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectAllMessage
 Dispatch this message to select all text. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectWordAtCursorMessage
 Dispatch this message to select the word at the current cursor position. More...
 
static MessageType< ModifyEditingStateMessageArgumentsEnterEditingStateMessage
 Dispatch this message to make a Text Box node enter the editing state. More...
 
static MessageType< ModifyEditingStateMessageArgumentsLeaveEditingStateMessage
 Dispatch this message to make a Text Box node leave the editing state. More...
 
static MessageType< TextCompositionStateMessageArgumentsCommitCompositionTextMessage
 Dispatch this message to make a Text Box commit the composition text. More...
 
static MessageType< TextCompositionStateMessageArgumentsCancelTextCompositionMessage
 Dispatch this message to make a Text Box cancel the text composition. More...
 
- Static Public Attributes inherited from kanzi::TextConcept
static PropertyType< ColorRGBAFontColorProperty
 Sets the text color for the default font material and for the materials with a fragment shader that uses the FontColor uniform. More...
 
static PropertyType< ResourceSharedPtrFontMaterialProperty
 Sets the material whose shader is used to render the text in a text node. More...
 
static PropertyType< Vector2HorizontalPaddingProperty
 Sets the padding spaces between the content and the left and right boundaries of a text node. More...
 
static PropertyType< bool > RemoveSideBearingsProperty
 Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. More...
 
static PropertyType< string > TextProperty
 Sets the text content that a text node renders. More...
 
static PropertyType< TextFormat::TextHorizontalAlignmentTextHorizontalAlignmentProperty
 Sets the horizontal alignment of the text in a text node. More...
 
static PropertyType< TextFormat::TextVerticalAlignmentTextVerticalAlignmentProperty
 Sets the vertical alignment of the text in a text node. More...
 
static PropertyType< Vector2VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of a text node. More...
 
static PropertyType< string > OverflowProperty
 Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in a text node. More...
 
static PropertyType< bool > HorizontalFitProperty
 Allows a Text Block to scale glyphs horizontally when the text string is too long to fit in that Text Block. More...
 
static PropertyType< Vector2HorizontalFitScaleLimitsProperty
 Sets the scale range that the HorizontalFitProperty can use when it scales the text horizontally. More...
 
- Static Public Attributes inherited from kanzi::FontStyleConcept
static PropertyType< float > SizeProperty
 Sets the size for the font in pixels. More...
 
static PropertyType< FontStyleStyleProperty
 Sets the style for the font. More...
 
static PropertyType< FontWeightWeightProperty
 Sets the weight for the font. More...
 
static PropertyType< float > CharacterSpacingProperty
 Sets the character spacing in pixels. More...
 
static PropertyType< float > FixedCharacterWidthProperty
 Overrides the font advance widths and makes each character take a fixed amount of space specified in pixels. More...
 
static PropertyType< float > LineSpacingProperty
 Sets the line spacing in multiples of the normal line height of the selected font. More...
 
static PropertyType< bool > FractionalCharacterWidthProperty
 Sets whether Kanzi uses fractional or rounded character widths to lay out text. More...
 
static PropertyType< bool > SnapCharacterToPixelProperty
 Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: More...
 
static PropertyType< FontHintingPreferenceHintingPreferenceProperty
 Sets the hinting preference of the selected font. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Member Functions inherited from kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
vector< pair< float, float > > calculateCompositionHighlightCoordinates () const
 Calculates the individual composition text highlight coordinates of a given Text Box node state. More...
 
vector< pair< float, float > > calculateSelectionCoordinates () const
 Calculates the individual selection coordinates of a given Text Box node state. More...
 
void censorRevealedCharacter ()
 Censors the revealed character in password echo mode. More...
 
TextConcept::TextFormatParameters createTextFormatParameters (float width, float height) const
 Creates the parameters that are needed for initializing the TextFormat of a Text Box node. More...
 
void deteleCharactersAtCursor (int count)
 Deletes a given number of characters at cursor position. More...
 
pair< float, float > getSelectionEndPoints () const
 Returns the selection end point coordinates from the given Text Box node state. More...
 
string getTextForFormatting () const
 Returns the m_displayText with added explicit directionality marker if it is a password text. More...
 
void handleBackspaceAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::BackspaceAtCursorMessage. More...
 
void handleBackspaceWordAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::BackspaceWordAtCursorMessage. More...
 
void handleCancelTextComposition (TextBoxConcept::TextCompositionStateMessageArguments &args)
 Handler for TextBoxConcept::CancelTextCompositionMessage. More...
 
void handleClearSelection (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::ClearSelectionMessage. More...
 
void handleCommitCompositionText (TextBoxConcept::TextCompositionStateMessageArguments &args)
 Handler for TextBoxConcept::CommitCompositionTextMessage. More...
 
void handleDeleteAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::DeleteAtCursorMessage. More...
 
void handleDeleteSelectionMessage (TextBoxConcept::DeleteSelectionMessageArguments &args)
 Handler for TextBoxConcept::DeleteSelectionMessage. More...
 
void handleDeleteTextMessage (TextBoxConcept::TextRangeMessageArguments &args)
 Handler for TextBoxConcept::DeleteTextMessage. More...
 
void handleDeleteWordAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::DeleteWordAtCursorMessage. More...
 
void handleEnterEditing (TextBoxConcept::ModifyEditingStateMessageArguments &args)
 Handler for TextBoxConcept::EnterEditingStateMessage. More...
 
void handleInsertTextAtCursor (const TextBoxConcept::TextContentMessageArguments &args)
 Handler for TextBoxConcept::InsertTextAtCursorMessage. More...
 
void handleInsertTextMessage (TextBoxConcept::TextInsertionMessageArguments &args)
 Handler for TextBoxConcept::InsertTextMessage. More...
 
void handleLeaveEditing (TextBoxConcept::ModifyEditingStateMessageArguments &args)
 Handler for TextBoxConcept::LeaveEditingStateMessage. More...
 
void handleMoveCursorBackward (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorBackwardMessage. More...
 
void handleMoveCursorForward (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorForwardMessage. More...
 
void handleMoveCursorHome (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorHomeMessage. More...
 
void handleMoveCursorToEnd (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToEndMessage. More...
 
void handleMoveCursorToNextWord (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToNextWordMessage. More...
 
void handleMoveCursorToPreviousWord (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToPreviousWordMessage. More...
 
void handleMoveSelectionEndBackward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndBackwardMessage. More...
 
void handleMoveSelectionEndForward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndForwardMessage. More...
 
void handleMoveSelectionEndToNextWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndToNextWordMessage. More...
 
void handleMoveSelectionEndToPreviousWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndToPreviousWordMessage. More...
 
void handleMoveSelectionStartBackward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartBackwardMessage. More...
 
void handleMoveSelectionStartForward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartForwardMessage. More...
 
void handleMoveSelectionStartToNextWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartToNextWordMessage. More...
 
void handleMoveSelectionStartToPreviousWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartToPreviousWordMessage. More...
 
void handleSelectAll (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectAllMessage. More...
 
void handleSelectTextMessage (TextBoxConcept::TextRangeMessageArguments &args)
 Handler for TextBoxConcept::SelectTextMessage. More...
 
void handleSelectToEnd (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectToEndMessage. More...
 
void handleSelectToHome (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectToHomeMessage. More...
 
void handleSelectWordAtCursor (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectWordAtCursorMessage. More...
 
bool hitTestAfterSelectionEnd (Vector2 point) const
 Checks whether the point is positioned after the point where text selection ends. More...
 
bool hitTestAheadSelectionStart (Vector2 point) const
 Checks whether the point is positioned ahead of the point where text selection starts. More...
 
bool hitTestSelectionEnd (Vector2 point) const
 Checks whether the point is on the selection ending point surroundings. More...
 
bool hitTestSelectionStart (Vector2 point) const
 Checks whether the point is on the selection starting point surroundings. More...
 
void initialize ()
 TextBoxConceptImpl specific initialization. More...
 
void moveCursorToPoint (const Vector2 &point)
 Moves the cursor to a given point. More...
 
void onAboutToLoseFocus (FocusManager::PreFocusMessageArguments &args)
 Handler for FocusManager::AboutToLoseFocusMessage. More...
 
void onCompositionTextChanged (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::CompositionTextChangedMessage. More...
 
void onCompositionTextCommitted (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::CompositionTextCommittedMessage. More...
 
void onCursorMoved (TextInputManipulator::CursorMovedMessageArguments &args)
 Handles TextInputManipulator::CursorMovedMessage. More...
 
void onDetached () override
 Overrides Node::onDetached(). More...
 
void onEchoModeChanged ()
 Handles the change of the kanzi::EchoMode. More...
 
void onFocusGained (FocusManager::PostFocusMessageArguments &args)
 Handler for FocusManager::FocusGainedMessage. More...
 
void onFocusLost (FocusManager::PostFocusMessageArguments &args)
 Handler for FocusManager::FocusLostMessage. More...
 
void onInputAction (TextInputManipulator::InputMethodActionMessageArguments &)
 Handles TextInputManipulator::InputMethodActionMessage. More...
 
void onInputMethodAvailableChanged (TextInputManipulator::InputMethodAvailableChangedMessageArguments &)
 Handles TextInputManipulator::InputMethodAvailableChangedMessage. More...
 
void onInputMethodsDisconnected (TextInputManipulator::InputMethodsDisconnectedMessageArguments &)
 Handles TextInputManipulator::InputMethodDeactivatedMessage. More...
 
void onInputTypeChanged (TextInputManipulator::InputTypeChangedMessageArguments &)
 Handles TextInputManipulator::InputTypeChangedMessage. More...
 
void onInputTypePropertyChanged ()
 Handles the change of the kanzi::InputType. More...
 
void onMultiClick (const Vector2 &clickPoint)
 Handles the multi-click gesture on a node. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onPropertyChanged implementation. More...
 
void onPanFinished ()
 Handles pan finishing. More...
 
void onPanMoved (Vector2 point)
 Handles the pan gesture, to drag the cursors including the selection cursors. More...
 
void onPanStarted (Vector2 clickPoint)
 Handles the click begin. More...
 
void onReadOnlyStateChanged (TextInputManipulator::ReadOnlyStateChangedMessageArguments &)
 Handles TextInputManipulator::ReadOnlyStateChangedMessage. More...
 
void onSelectionChanged (TextInputManipulator::SelectionChangedMessageArguments &args)
 Handles TextInputManipulator::SelectionChangedMessage. More...
 
void onTextChanged (TextInputManipulator::TextChangedMessageArguments &)
 Handles TextInputManipulator::TextChangedMessage. More...
 
void onTextCompositionCanceled (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::TextCompositionCanceledMessage. More...
 
void onTextPropertyChanged ()
 Handles the update of the TextProperty. More...
 
void refreshTextHint ()
 Refresh text hint visibility. More...
 
void reloadCursor ()
 Reloads from the CursorPrefabProperty the prefab template that defines the appearance of the cursor. More...
 
void reloadSelectionEnd ()
 Reloads from the SelectionEndPrefabProperty the prefab template that defines the appearance of the selection handle at the end of text selection. More...
 
void reloadSelectionStart ()
 Reloads from the SelectionStartPrefabProperty the prefab template that defines the appearance of the selection handle at the beginning of text selection. More...
 
void reloadTextHint ()
 Reloads from the TextHintPrefabProperty the prefab template for showing placeholder content when the TextBox node is empty. More...
 
void setRevealLastInsertedCharacter (bool reveal)
 Sets whether to reveal the last inserted character in password echo mode. More...
 
void startEditing ()
 Tells a Text Box node to enter the editing state. More...
 
 TextBoxConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void updateCharacterCount ()
 Updates the value of the CharacterCountProperty. More...
 
void updateCompositionText ()
 Updates the value of the CompositionTextProperty. More...
 
void updateDisplayText ()
 Updates the value of the DisplayTextProperty. More...
 
void updateDraggingStatus ()
 Updates the dragging flags: More...
 
void updateWordCount ()
 Updates the value of the WordCountProperty. More...
 
- Protected Member Functions inherited from kanzi::Node3D
NodeSharedPtr findAbstractChildOverride (string_view name) override
 
void initialize ()
 
 Node3D (Domain *domain, string_view name)
 
void setPrimitiveLayout (bool primitive)
 
VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override
 
- Protected Member Functions inherited from kanzi::Node
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
void initialize ()
 Node-specific initialization. More...
 
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
 
virtual void updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo)
 Updates the overlay scope information that is attached to the root node of an overlay scope. More...
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during node tree connections. More...
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during node tree disconnections. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
BindingTargetRuntimePtr createModifierBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Creates a property modifier binding target for given combination of property type and field. More...
 
BindingTargetRuntimePtr createValueSourceBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
 Creates a value source binding target for given combination of property type and field. More...
 
NodegetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const NodegetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 
- Protected Member Functions inherited from kanzi::TextBoxConcept
void drawRectangle (Renderer3D &renderer, const Matrix4x4 &transform, const Vector2 &topLeft, const Vector2 &bottomRight, float z, const Material &material)
 Draws a filled rectangle with given corner coordinates and z-plane. More...
 
float getTextHeight (const TextFormat &textFormat) const
 Returns the height in pixels of the text from the given text format. More...
 
float getTextTop (const TextFormat &textFormat) const
 Returns the top of the text in a line. More...
 
- Protected Member Functions inherited from kanzi::TextConceptImpl< TextBox3D >
void prepareTextFormat (const TextFormatParameters &parameters, string text)
 Updates the parameters and text of the internal text format. More...
 
 TextConceptImpl ()=default
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::FontStyleConceptImpl< TextBox3D >
 FontStyleConceptImpl ()=default
 Constructor. More...
 
- Static Protected Member Functions inherited from kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
static Rectangle< float > transformRect (const Matrix3x3 &m, Rectangle< float > rect)
 Transforms a given rectangle with a given matrix. More...
 
static Rectangle< float > transformRect (const Matrix4x4 &m, Rectangle< float > rect)
 Transforms a given rectangle with a given matrix. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage. More...
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw. More...
 
- Protected Attributes inherited from kanzi::TextBoxConceptImpl< Node3D, TextBox3D, TextBox3DTraits >
ClassPropertyDefaultValue< bool > m_classValueFocusable
 Default value for the Focusable property. More...
 
ClassPropertyDefaultValue< bool > m_classValueHitTestable
 Default value for the Hit Testable property. More...
 
bool m_contentChanged
 Helper flag for editing started and finished messages. More...
 
shared_ptr< Node3Dm_cursorNode
 Stores the prefab template instantiated from the CursorPrefabProperty. More...
 
bool m_draggingBegin
 The drag state of the selection cursor for the start selection cursor. More...
 
bool m_draggingEnd
 The drag state of the selection cursor for the end selection cursor. More...
 
bool m_draggingInverted
 Indicates whether the selection start index is after the selection end index in x coordinates when either m_draggingBegin or m_draggingEnd is set to true. More...
 
TextInputManipulatorSharedPtr m_inputManipulator
 The TextInputManipulator attached to the TextBox. More...
 
TextInputLayout m_layoutInfo
 
vector< Node::MessageSubscriptionTokenm_messageTokens
 The following MessageSubscriptionTokens are used for controlling the message subscription while a TextBox is in editing state. More...
 
bool m_panOngoing
 Helper flag for selection change messages. More...
 
MainLoopTimerToken m_passwordEchoTimeoutToken
 Timer subscription token for password echo timeout. More...
 
bool m_revealLastInsertedCharacter
 Whether to show, instead of censoring, the last inserted character in password echo mode. More...
 
shared_ptr< Node3Dm_selectionEndNode
 Stores the prefab template instantiated from the SelectionEndPrefabProperty. More...
 
shared_ptr< Node3Dm_selectionStartNode
 Stores the prefab template instantiated from the SelectionStartPrefabProperty. More...
 
shared_ptr< Node3Dm_textHintNode
 Stores the prefab template instantiated from the TextHintPrefabProperty. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 
- Protected Attributes inherited from kanzi::TextConceptImpl< TextBox3D >
TextFormatPtr m_textFormat
 The text format for the text that this node displays. More...
 
- Protected Attributes inherited from kanzi::RenderEntryRegistry< TextBox3D >
flat_set< DrawObjectsRenderPassWeakPtr, owner_less< DrawObjectsRenderPassWeakPtr > > m_referringRenderPasses
 Render passes referring to the Node deriving this template class. More...
 
Node3D::RenderEntryParameterContainer m_renderEntryParameters
 Cached render entry parameters. More...
 

Detailed Description

TextBox3D provides the required overrides to handle 3D rendering and gesture handling for the 3D text input.

See also
For 2D text input, see TextBox2D.
Since
Kanzi 3.9.0

Examples

To create a TextBox3D node:

// Create a Text Box 3D node named Text Box.
TextBox3DSharedPtr textBoxNode = TextBox3D::create(this->getDomain(), "Text Box");

To set the initial text content in a TextBox3D node:

// Set the initial text content in the Text Box node.
textBoxNode->setText("Initial text that the Text Box contains before editing.");

To set the appearance of the text in a TextBox3D node:

// Set the style of the text in the Text Box node:
// Set the font family of the text.
textBoxNode->setFontFamily(fontFamily);
// Set line spacing to 1.5f.
textBoxNode->setLineSpacing(1.5f);
// Set font size to 36.0f.
textBoxNode->setFontSize(36.0f);
// Set the color of the text to blue.
textBoxNode->setFontColor(ThemeBlue);
// Align the text to the right.
textBoxNode->setTextHorizontalAlignment(TextFormat::TextHorizontalAlignmentRight);
// Set font hinting: Render the text in the Text Box node using the hinter of the font engine rasterizer.
textBoxNode->setHintingPreference(FontHintingPreference::AutoHinting);

To show placeholder content in a TextBox3D node:

// Set the prefab that shows the placeholder content in the Text Box node.
textBoxNode->setTextHintPrefab(textHintPrefab);

To set the cursor position in a TextBox3D node:

// Set the cursor position in the beginning of the text field.
textBoxNode->setCursorPosition(0u);

To set the appearance of the cursor in the TextBox3D node:

// Set the prefab that visualizes the cursor.
textBoxNode->setCursorPrefab(cursorPrefab);

To set the appearance of the text selection in a TextBox3D node:

// Set the color of the selected text to orange.
textBoxNode->setSelectionFontColor(ThemeOrange);
// Set the background color of the selected text to gray.
textBoxNode->setSelectionBackgroundColor(ThemeGray);
// Set the prefab that visualizes the selection handle at the beginning of the selection.
textBoxNode->setCursorPrefab(selectionStartPrefab);
// Set the prefab that visualizes the selection handle at the end of the selection.
textBoxNode->setCursorPrefab(selectionEndPrefab);

To set the appearance of the composition text in a TextBox3D node:

// Set the color of the composition text to red.
textBoxNode->setSelectionFontColor(ThemeRed);
// Set the background color of the composition text to gray.
textBoxNode->setSelectionBackgroundColor(ThemeGray);

To make a TextBox3D node behave as a password field:

// Set Kanzi to show each character for a certain amount of time, and then hide it with a masking character.
textBoxNode->setEchoMode(EchoMode::Password);
// Set the UTF-8 character with which you want to hide each password character.
textBoxNode->setPasswordMaskingCharacter("*");
// Set the time in milliseconds that you want to show each character before hiding it.
textBoxNode->setPasswordEchoTimeout(500);

Member Typedef Documentation

◆ ConceptClass

Constructor & Destructor Documentation

◆ TextBox3D()

kanzi::TextBox3D::TextBox3D ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

◆ ~TextBox3D()

virtual kanzi::TextBox3D::~TextBox3D ( )
protectedvirtualdefault

Member Function Documentation

◆ create()

static TextBox3DSharedPtr kanzi::TextBox3D::create ( Domain domain,
string_view  name 
)
static

Creates a TextBox3D node.

Parameters
domainThe UI domain to which the node belongs.
nameThe name of the node.
Returns
The created node.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TextBox3D::makeEditorInfo ( )
static

◆ onMultiClick()

void kanzi::TextBox3D::onMultiClick ( MultiClickManipulator::MultiClickMessageArguments args)

◆ onPanMoved()

void kanzi::TextBox3D::onPanMoved ( PanManipulator::MovedMessageArguments args)

◆ onPanStarted()

void kanzi::TextBox3D::onPanStarted ( PanManipulator::StartedMessageArguments args)

◆ onPanFinished()

void kanzi::TextBox3D::onPanFinished ( PanManipulator::FinishedMessageArguments args)

◆ getSelectionBackgroundColor()

ColorRGBA kanzi::TextBox3D::getSelectionBackgroundColor ( ) const
inline

Returns the value of the SelectionBackgroundColorProperty.

Returns
The ColorRGBA color that highlights selected text.
See also
setSelectionBackgroundColor()

◆ setSelectionBackgroundColor()

void kanzi::TextBox3D::setSelectionBackgroundColor ( ColorRGBA  value)
inline

Sets the value of the SelectionBackgroundColorProperty.

Parameters
valueThe ColorRGBA color to use to highlight selected text.
See also
getSelectionBackgroundColor()

◆ getSelectionFontColor()

ColorRGBA kanzi::TextBox3D::getSelectionFontColor ( ) const
inline

Returns the value of the SelectionFontColorProperty.

Returns
The ColorRGBA color of selected text.
See also
setSelectionFontColor()

◆ setSelectionFontColor()

void kanzi::TextBox3D::setSelectionFontColor ( ColorRGBA  value)
inline

Sets the value of the SelectionFontColorProperty.

Parameters
valueThe ColorRGBA color to use for selected text.
See also
getSelectionFontColor()

◆ getCompositionBackgroundColor()

ColorRGBA kanzi::TextBox3D::getCompositionBackgroundColor ( ) const
inline

Returns the value of the CompositionBackgroundColorProperty.

Returns
The ColorRGBA color that highlights the text that the user composes in a TextBox3D node using an input method editor (IME).
See also
setCompositionBackgroundColor()

◆ setCompositionBackgroundColor()

void kanzi::TextBox3D::setCompositionBackgroundColor ( ColorRGBA  value)
inline

Sets the value of the CompositionBackgroundColorProperty.

Parameters
valueThe ColorRGBA color to use to highlight the text that the user composes in a TextBox3D node using an input method editor (IME).
See also
getCompositionBackgroundColor()

◆ getCompositionFontColor()

ColorRGBA kanzi::TextBox3D::getCompositionFontColor ( ) const
inline

Returns the value of the CompositionFontColorProperty.

Returns
The ColorRGBA color of the text that the user composes in a TextBox3D node using an input method editor (IME).
See also
setCompositionFontColor()

◆ setCompositionFontColor()

void kanzi::TextBox3D::setCompositionFontColor ( ColorRGBA  value)
inline

Sets the value of the CompositionFontColorProperty.

Parameters
valueThe ColorRGBA color to use for the the text that the user composes in a TextBox3D node using an input method editor (IME).
See also
getCompositionFontColor()

◆ restoreResources()

void kanzi::TextBox3D::restoreResources ( )
overridevirtual

Node::restoreResources() implementation.

Reimplemented from kanzi::Node.

◆ initialize()

void kanzi::TextBox3D::initialize ( )
protected

Initializes the node.

◆ measureOverride()

Vector3 kanzi::TextBox3D::measureOverride ( Vector3  availableSize)
overrideprotectedvirtual

Layouting measurement override.

Reimplemented from kanzi::Node3D.

◆ arrangeOverride()

void kanzi::TextBox3D::arrangeOverride ( Vector3  actualSize)
overrideprotectedvirtual

Layouting arrangement override.

Reimplemented from kanzi::Node3D.

◆ renderOverride()

void kanzi::TextBox3D::renderOverride ( Renderer3D renderer,
RenderEntry3D renderState 
)
overrideprotectedvirtual

Render override.

Reimplemented from kanzi::Node3D.

◆ onAttached()

void kanzi::TextBox3D::onAttached ( )
overrideprotectedvirtual

Attachment override.

Reimplemented from kanzi::Node3D.

◆ getBoundingBox()

optional<Box> kanzi::TextBox3D::getBoundingBox ( ) const
overrideprotectedvirtual

Node3D::getBoundingBox() implementation.

Reimplemented from kanzi::Node3D.

◆ onNodePropertyChanged()

void kanzi::TextBox3D::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Method executed on node property change.

Parameters
propertyTypeProperty that was changed in node.
reasonChange reason.

Reimplemented from kanzi::Node3D.

◆ onDetached()

void kanzi::TextBox3D::onDetached ( )
overrideprotectedvirtual

Node3D::onDetached() implementation.

Reimplemented from kanzi::Node3D.

◆ generateRenderStatesOverride()

const RenderEntryParameterContainer* kanzi::TextBox3D::generateRenderStatesOverride ( DrawObjectsRenderPass drawPass)
overrideprotectedvirtual

Node3D::generateRenderStatesOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ registerDrawPassOverride()

void kanzi::TextBox3D::registerDrawPassOverride ( DrawObjectsRenderPassSharedPtr  drawPass)
overrideprotectedvirtual

Node3D::registerDrawPassOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ calculateAlignmentOffset()

Vector2 kanzi::TextBox3D::calculateAlignmentOffset ( const Vector3  size) const
protected

◆ renderCursor()

void kanzi::TextBox3D::renderCursor ( Renderer3D renderer,
const Matrix4x4 worldTransformation 
)
protected

◆ renderSelection()

void kanzi::TextBox3D::renderSelection ( Renderer3D renderer,
const Matrix4x4 worldTransformation 
)
protected

◆ renderComposition()

void kanzi::TextBox3D::renderComposition ( Renderer3D renderer,
const Matrix4x4 worldTransformation 
)
protected

◆ calculatePosition() [1/2]

optional<Vector2> kanzi::TextBox3D::calculatePosition ( const InputManipulator::InputMessageArguments arguments)
protected

◆ calculatePosition() [2/2]

optional<Vector2> kanzi::TextBox3D::calculatePosition ( const Ray ray) const
protected

◆ clampScrollPosition()

float kanzi::TextBox3D::clampScrollPosition ( float  originalScrollPosition,
TextFormat::TextHorizontalAlignment  alignment,
TextLayout textLayout,
float  editorWidth 
)
protected

Clamps a scroll position to the visible area.

Parameters
originalScrollPositionThe scroll position to clamp.
alignmentThe horizontal text alignment of the Text Box 3D node.
textLayoutThe text layout of the text content.
editorWidthThe width of the text editor.

◆ ensureCursorVisible()

void kanzi::TextBox3D::ensureCursorVisible ( )
protected

Scrolls the text content so that the cursor is visible.

◆ ensureMovingSelectionPointVisible()

void kanzi::TextBox3D::ensureMovingSelectionPointVisible ( )
protected

Scrolls the text content so that the selection handle at the end of the text selection is visible.

◆ ensureCompositionVisible()

void kanzi::TextBox3D::ensureCompositionVisible ( )
protected

Scrolls the text content so that the end position of the composition text is visible.

◆ scrollTimerTick()

void kanzi::TextBox3D::scrollTimerTick ( )
protected

Handles the scroll timer callback.

◆ calculateScrollingDistance()

float kanzi::TextBox3D::calculateScrollingDistance ( )
protected

Returns the distance of the last pointer event from either side of the editor.

Use the returned distance to scroll text with pan events.

Returns
The last pointer event distance from either sides of the editor.

◆ getTruncationOffsetWidth()

float kanzi::TextBox3D::getTruncationOffsetWidth ( ) const
protected

Returns the difference of the editor width and the truncated text width.

There is a slight offset for right and center aligned text. Kanzi uses this to calculate the correct hit point when refocusing the Text Box 3D node with a pointer event.

Returns
The difference of the editor width and the truncated text width.

◆ resetScrollPosition()

void kanzi::TextBox3D::resetScrollPosition ( )
protected

Resets the scroll position according to the horizontal text alignment of the Text Box 3D node.

Kanzi calls this method when refocusing Text Box 3D with pointer event.

Member Data Documentation

◆ SelectionBackgroundColorProperty

PropertyType<ColorRGBA> kanzi::TextBox3D::SelectionBackgroundColorProperty
static

Sets the color that highlights the text that is selected in a TextBox3D node.

The default value is sRGB ColorRGBA((0, 0, 1, 1);

See also
setSelectionBackgroundColor(), getSelectionBackgroundColor()

◆ SelectionFontColorProperty

PropertyType<ColorRGBA> kanzi::TextBox3D::SelectionFontColorProperty
static

Sets the color of the text that is selected in a TextBox3D node The default value is sRGB ColorRGBA((1, 1, 1, 1);.

See also
setSelectionFontColor(), getSelectionFontColor()

◆ CompositionBackgroundColorProperty

PropertyType<ColorRGBA> kanzi::TextBox3D::CompositionBackgroundColorProperty
static

Sets the color that highlights the text that the user composes in a TextBox3D node using an input method editor (IME).

The default value is sRGB ColorRGBA((0.71, 0.71, 0.71, 0.5);

See also
setCompositionBackgroundColor(), getCompositionBackgroundColor()

◆ CompositionFontColorProperty

PropertyType<ColorRGBA> kanzi::TextBox3D::CompositionFontColorProperty
static

Sets the color of the text that the user composes in a TextBox3D node using an input method editor (IME).

The default value is sRGB ColorRGBA((0, 0, 0, 1);

See also
setCompositionFontColor(), getCompositionFontColor()

◆ m_horizontalScrollPosition

float kanzi::TextBox3D::m_horizontalScrollPosition
protected

Tracks the current horizontal scroll position in Text Box 3D.


The documentation for this class was generated from the following file: