Kanzi  3.9.7
Kanzi Engine API
kanzi::GridListBox3D Class Reference

Use the Grid List Box 3D node to create scrollable lists of 3D items arranged in a grid. More...

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

Inheritance diagram for kanzi::GridListBox3D:
[legend]

Public Member Functions

float getCellHeight () const
 Gets the value of CellHeightProperty. More...
 
float getCellWidth () const
 Gets the value of CellWidthProperty. More...
 
GridDirection getDirection () const
 Gets the value of DirectionProperty. More...
 
float getItemAreaBegin () const
 Gets the value of ItemAreaBeginProperty. More...
 
float getItemAreaEnd () const
 Gets the value of ItemAreaEndProperty. More...
 
Vector2 getScrollPosition () const
 Gets the value of ScrollPositionProperty. More...
 
Vector2 getScrollSpeed () const
 Gets the value of ScrollSpeedProperty. More...
 
Vector2 getScrollTargetPosition () const
 Gets the value of ScrollTargetPositionProperty. More...
 
ScrollView3DSharedPtr getScrollView () const
 Returns the ScrollView3D that scrolls the Grid List Box 3D. More...
 
bool isReversedScrolling () const
 Returns the value of ReversedScrollingProperty. More...
 
bool isScrolling () const
 Gets the value of ScrollingProperty. More...
 
void setCellHeight (float value)
 Sets the value of CellHeightProperty. More...
 
void setCellWidth (float value)
 Sets the value of CellWidthProperty. More...
 
void setDirection (GridDirection value)
 Sets the value of DirectionProperty. More...
 
void setItemAreaBegin (float value)
 Sets the value of ItemAreaBeginProperty. More...
 
void setItemAreaEnd (float value)
 Sets the value of ItemAreaEndProperty. More...
 
void setReversedScrolling (bool enable)
 Sets the value of the ReversedScrollingProperty. More...
 
- Public Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >
bool addContentItem (NodeSharedPtr abstractItem) override
 
void addItem (ItemSharedPtr item)
 Adds an item at the end of a List Box when using the default object generator. More...
 
void arrangeOverride (LayoutVectorType actualSize) override
 
void bringItemCenter (size_t itemIndex, bool smooth)
 Requests the List Box to bring the item in the passed itemIndex to the center of the list box area. More...
 
void enableKeyNavigation (bool enabled)
 Enables directional key navigation on the List Box. More...
 
optional< pair< size_t, size_t > > getAliveRange ()
 Returns the range of list items that are alive. More...
 
NodeSharedPtr getContentItem (size_t index) override
 
size_t getContentItemCount () override
 
ItemSharedPtr getItem (size_t index)
 Gets the item at the given index in a List Box. More...
 
string getItemContainerGeneratorTypeName () const
 Gets the value of ItemContainerGeneratorTypeNameProperty. More...
 
PrefabTemplateSharedPtr getItemContainerTemplate () const
 Gets the value of ItemContainerTemplateProperty. More...
 
size_t getItemCount () const
 Returns the value of the ItemCountProperty. More...
 
string getItemGeneratorTypeName () const
 Gets the value of ItemGeneratorTypeNameProperty. More...
 
optional< size_t > getItemIndex (ItemSharedPtr item)
 Returns the index of the given item. If the item does not exist, returns empty. More...
 
LayoutVectorType getItemSize (size_t index)
 Returns the size of the item at the given index. More...
 
PrefabTemplateSharedPtr getItemTemplate () const
 Gets the value of ItemTemplateProperty. More...
 
int getKeepAliveItemCount () const
 Gets the value of KeepAliveItemCountProperty. More...
 
PresenterSharedPtr getPresenter () const
 
int getSelectedItemIndex () const
 Gets the value of SelectedItemIndexProperty. More...
 
SelectionBehavior getSelectionBehavior () const
 Gets the value of SelectionBehavior. More...
 
void insertItem (size_t index, ItemSharedPtr item)
 Inserts an item at the given index in a List Box when using the default object generator. More...
 
bool isEmpty ()
 Indicates whether a List Box has no items. More...
 
LayoutVectorType measureOverride (LayoutVectorType availableSize) override
 
void notifyItemAdded (size_t index) override
 Virtual functions for notifying item changes to list. More...
 
void notifyItemContainerChanged ()
 
void notifyItemCountChanged () override
 
void notifyItemRemoved (size_t index) override
 
void notifyItemReplaced (size_t index) override
 
void removeAllContentItems () override
 
void removeAllItems ()
 Removes all items from a List Box when using the default object generator. More...
 
bool removeContentItem (NodeSharedPtr abstractItem) override
 
void removeItem (size_t index)
 Removes the item at the given index from a List Box when using the default object generator. More...
 
void removeLastItem ()
 Removes the last item from a List Box when using the default object generator. More...
 
void replaceItem (size_t index, ItemSharedPtr item)
 Replaces the item at the given index in a List Box when using the default object generator. More...
 
void selectItem (optional< size_t > itemIndex)
 Requests the List Box to select the item at the given index. More...
 
void setItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Sets the list box item container generator. More...
 
void setItemContainerGeneratorTypeName (string_view value)
 Sets the value of ItemContainerGeneratorTypeNameProperty. More...
 
void setItemContainerTemplate (PrefabTemplateSharedPtr value)
 Sets the value of ItemContainerTemplateProperty. More...
 
void setItemGenerator (ItemGeneratorSharedPtr itemGenerator)
 Sets the list box item generator. More...
 
void setItemGeneratorTypeName (string_view value)
 Sets the value of ItemGeneratorTypeNameProperty. More...
 
void setItemTemplate (PrefabTemplateSharedPtr value)
 Sets the value of ItemTemplateProperty. More...
 
void setKeepAliveItemCount (int value)
 Sets the value of KeepAliveItemCountProperty. More...
 
void setSelectedItemIndex (int value)
 Sets the value of SelectedItemIndexProperty. More...
 
void setSelectionBehavior (SelectionBehavior value)
 Sets the value of SelectionBehavior. More...
 
void updateVisibleRange (size_t beginIndex, size_t itemCount)
 Requests items from the item generator. More...
 
void updateVisibleRange (size_t beginIndex, size_t itemCount, bool sendMessages)
 
void updateVisibleRangeQuiet (size_t beginIndex, size_t itemCount)
 Requests items from the item generator. 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...
 
virtual optional< BoxgetBoundingBox () const
 Gets the bounding box from a node. 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...
 
virtual pair< NodeSharedPtr, float > hitTestContent (const Ray &ray)
 Default hit test implementation of Node3D content. 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 &renderEntry)
 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 a resource dictionary of a 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)
 Adds a nested resource dictionary to the resource dictionary of a 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 a node and its descendants. 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...
 
FocusManagergetFocusManager () const
 Returns the Focus Manager associated with the Screen node to which this node belongs. More...
 
FocusScopegetFocusScopeInfo () const
 Returns the information about the focus scope for a node. More...
 
InputManagergetInputManager () const
 Returns the Input Manager associated with the Screen node to which this node belongs. 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
 If a node has a resource dictionary, returns the resource dictionary of that node. More...
 
ScreengetScreen () const
 Returns the Screen node to which this node belongs. 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 is 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...
 
virtual void restoreResources ()
 Reattaches an object node after potential resource change. 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 a node. More...
 
void setScreen (Screen *screen)
 Sets the Screen node to which this node belongs. 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 addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
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)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
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...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle 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...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle 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 (BindingRuntimeHandle &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::ContentItemCollectionModel
virtual ~ContentItemCollectionModel ()
 

Static Public Member Functions

static GridListBox3DSharedPtr create (Domain *domain, string_view name)
 Creates a Grid List Box 3D node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >
static Vector2 doMeasure (Node2D &node)
 
static Vector3 doMeasure (Node3D &node)
 
- 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::ListBoxConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::GridListBoxConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ListBoxScrollingConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

void arrangeOverride (Vector3 actualSize) override
 Node3D::arrangeOverride() implementation. More...
 
 GridListBox3D (Domain *domain, string_view name)
 
void initialize ()
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation. More...
 
void setInitialScrollPosition ()
 
- Protected Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >
void applySelectionBehavior (size_t itemIndex, bool smooth)
 Applies selection behavior to the selected item. More...
 
void assignItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Assigns list box item container generator to list box. More...
 
void assignItemGenerator (ItemGeneratorSharedPtr itemGenerator)
 Assigns list box item generator to list box. More...
 
void initialize (PresenterSharedPtr presenter)
 
 ListBoxConceptImpl (Domain *domain, string_view name)
 
bool listBoxContainsKeyFocus () const
 Returns whether the key focus is on the List Box node or on one of the list items. More...
 
void onAttached () override
 Node::onAttached() implementation. More...
 
void onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
 Handles ClickManipulator::ClickMessage. More...
 
void onDetached () override
 Node::onDetached() implementation. More...
 
void onFocusGained (FocusManager::PostFocusMessageArguments &messageArguments)
 Handles FocusManager::FocusGainedMessage. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation. More...
 
void setItemContainerGeneratorByProperty ()
 Creates and assigns item container generator by ItemGeneratorTypeName property value. More...
 
void setItemGeneratorByProperty ()
 Creates and assigns item generator by ItemGeneratorTypeName property value. More...
 
void synchronizeFocusAndSelection (Node &selectedItemContainer)
 ListBoxConcept uses this function to update the focus in the List Box to the selected item. More...
 
void synchronizeItemCountProperty ()
 Updates the ItemCountProperty. More...
 
void synchronizeSelectedItemIndexProperty ()
 Updates the SelectedItemIndexProperty after the List Box internally changes the selected item index. More...
 
void tryMoveFocusToListBox ()
 Tries to move focus to List Box node itself. More...
 
void updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo) override
 Overrides Node::updateFocusScopeInfo(). More...
 
void updateGenerators (ItemGeneratorSharedPtr itemGenerator, ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Replaces item and item container generators with new objects. Updates items and layout accordingly. More...
 
 ~ListBoxConceptImpl () override
 
- Protected Member Functions inherited from kanzi::Node3D
NodeSharedPtr findAbstractChildOverride (string_view name) override
 
virtual const RenderEntryParameterContainergenerateRenderStatesOverride (DrawObjectsRenderPass &drawPass)
 Node-specific render state generation. More...
 
void initialize ()
 
 Node3D (Domain *domain, string_view name)
 
virtual void registerDrawPassOverride (DrawObjectsRenderPassSharedPtr drawPass)
 Node-specific implementation of draw pass registration. More...
 
virtual void renderOverride (Renderer3D &renderer, RenderEntry3D &renderEntry)
 Node-specific rendering implementation. More...
 
void setPrimitiveLayout (bool primitive)
 Sets primitive layout flag. More...
 
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
 Notifies all property handlers on a property storage. 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)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
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 validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
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...
 

Additional Inherited Members

- Public Types inherited from kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >
typedef shared_ptr< DefaultListBoxItemGenerator< ItemGeneratorClass > > DefaultItemGeneratorSharedPtr
 
typedef GridListBox3DTraits::TItemClass ItemClass
 
typedef GridListBox3DTraits::TItemContainerClass ItemContainerClass
 
typedef GridListBox3DTraits::TItemContainerGeneratorClass ItemContainerGeneratorClass
 
typedef shared_ptr< ItemContainerGeneratorClassItemContainerGeneratorSharedPtr
 
typedef shared_ptr< ItemContainerClassItemContainerSharedPtr
 
typedef GridListBox3DTraits::TItemGeneratorClass ItemGeneratorClass
 
typedef shared_ptr< ItemGeneratorClassItemGeneratorSharedPtr
 
typedef shared_ptr< ItemClassItemSharedPtr
 
typedef Node3D::LayoutVectorType LayoutVectorType
 
typedef GridListBox3DTraits::TPresenterClass PresenterClass
 
typedef shared_ptr< PresenterClassPresenterSharedPtr
 
- 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::ListBoxConcept
enum  SelectionBehavior { SelectionBehaviorNone, SelectionBehaviorBringToCenter }
 Behaviors for the List Box when an item in the List Box is selected. More...
 
- Public Types inherited from kanzi::GridListBoxConcept
enum  GridDirection { GridDirectionRight, GridDirectionDown }
 
- 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 key 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::ListBoxConcept
static MessageType< ItemHiddenMessageArgumentsItemHiddenMessage
 List Box node dispatches this message whenever the List Box hides one of its items. More...
 
static MessageType< ItemSelectedMessageArgumentsItemSelectedMessage
 List Box node dispatches this message whenever an item in the List Box is selected. More...
 
static MessageType< ItemVisibleMessageArgumentsItemVisibleMessage
 List Box node dispatches this message whenever the List Box brings one of its items visible. More...
 
static PropertyType< int > ItemCountProperty
 Reports the number of items in a List Box, including virtual items. More...
 
static PropertyType< int > KeepAliveItemCountProperty
 Sets the size of the buffer for invisible List Box items. More...
 
static PropertyType< ListBoxConcept::SelectionBehaviorSelectionBehaviorProperty
 Sets how a List Box node behaves when the user selects an item. More...
 
static PropertyType< string > ItemGeneratorTypeNameProperty
 Sets the name of the item generator type to use to provide items dynamically for a List Box node. More...
 
static PropertyType< string > ItemContainerGeneratorTypeNameProperty
 Sets the name of the item container generator type to use to provide item containers dynamically for a List Box node. More...
 
static PropertyType< ResourceSharedPtrItemTemplateProperty
 Sets the prefab template to use for the List Box items. More...
 
static PropertyType< ResourceSharedPtrItemContainerTemplateProperty
 Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the List Box items. More...
 
static PropertyType< int > SelectedItemIndexProperty
 Sets and reports the index of the item that is currently selected in a List Box node. More...
 
- Static Public Attributes inherited from kanzi::GridListBoxConcept
static PropertyType< GridListBoxConcept::GridDirectionDirectionProperty
 Sets the direction in which a Grid List Box node arranges its items. More...
 
static PropertyType< float > CellWidthProperty
 Sets the width of each cell in a Grid List Box node. More...
 
static PropertyType< float > CellHeightProperty
 Sets the height of each cell in a Grid List Box node. More...
 
static PropertyType< float > ItemAreaBeginProperty
 Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node starts. More...
 
static PropertyType< float > ItemAreaEndProperty
 Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node ends. More...
 
static PropertyType< float > RecognitionThresholdProperty
 Sets the distance in pixels that the pointer has to move for the scrolling to start in a Grid List Box node. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 Sets the minimum number of touch points required on the Grid List Box node area for scrolling. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed on the Grid List Box node area for scrolling. More...
 
static PropertyType< float > SensitivityProperty
 Sets the amount that the scroll position changes relative to the movement of the pointer. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 Sets the acceleration of a Grid List Box node after the user releases the pointer with which they scroll the Grid List Box. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Grid List Box node after the user releases the pointer with which they scroll the Grid List Box. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 Sets the acceleration of a Grid List Box node when the user scrolls the Grid List Box by dragging the pointer. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Grid List Box node when the user scrolls the Grid List Box by dragging the pointer. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 Sets the amount of impulse to generate from the pointer movement when the user scrolls a Grid List Box node by dragging the pointer. More...
 
static PropertyType< float > SwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value in a Grid List Box node, relative to the speed of the pointer. More...
 
static PropertyType< float > CalculatedOffsetProperty
 Reports the current relative offset of an item in a Grid List Box node in proportional range [0.0, 1.0]. More...
 
static PropertyType< Vector2ScrollPositionProperty
 Reports the scroll position of a Grid List Box node along the x and y axes as a relative position within the Grid List Box area. More...
 
static PropertyType< Vector2ScrollTargetPositionProperty
 Reports the current target scroll value of a Grid List Box. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 Reports the current scroll speed of a Grid List Box. More...
 
static PropertyType< bool > ScrollingProperty
 Indicates whether a Grid List Box is currently scrolling. More...
 
static PropertyType< bool > ReversedScrollingProperty
 Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture. More...
 
- Static Public Attributes inherited from kanzi::ListBoxScrollingConcept
static MessageType< ScrolledMessageArgumentsScrolledMessage
 List Box node dispatches this message whenever the List Box node scrolls. More...
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 List Box node dispatches this message whenever the List Box stops scrolling. More...
 
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 List Box node dispatches this message whenever the List Box starts to scroll. More...
 
static MessageType< TargetChangedMessageArgumentsTargetChangedMessage
 List Box node dispatches this message whenever there is a change in scroll target item in List Box. More...
 
static MessageType< UserScrollFinishedMessageArgumentsUserScrollFinishedMessage
 List Box node dispatches this message when the user stops scrolling the List Box content. More...
 
static MessageType< UserScrollStartedMessageArgumentsUserScrollStartedMessage
 List Box node dispatches this message when the user starts to scroll the List Box content. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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::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...
 

Detailed Description

Use the Grid List Box 3D node to create scrollable lists of 3D items arranged in a grid.

To set the size of the grid cells, use the CellWidthProperty and CellHeightProperty properties in the Grid List Box 3D node. All cells in a Grid List Box 3D node are of the same size.

The size of a Grid List Box 3D node determines the number of rows and columns: a Grid List Box 3D node shows as many cells as fit within its area. Kanzi hides the list items that are in cells that do not fit in the list box area. The user can scroll the list box to see more items. The user can temporarily drag list items out of the grid, but when the user is not providing input, the list box scrolls the items back to the grid area.

To handle input, the Grid List Box 3D internally uses ScrollView3D. To make the input work:

  1. Position the Grid List Box 3D in front of the camera oriented so that the scroll plane is perpendicular to the camera view ray.
  2. Set the size of the Grid List Box 3D. The scroll view uses that area to collect input.

To configure the scroll view, Kanzi internally binds the properties that you set in the Grid List Box 3D to the corresponding properties in the scroll view. You can send to a Grid List Box 3D node ScrollViewConcept messages, such as ScrollViewConcept::ScrollDirectionMessage, ScrollViewConcept::ScrollPageMessage, and ScrollViewConcept::ScrollUpMessage.

See also
ListBoxConceptImpl

Examples

To create a Grid List Box 3D node:

// Create a Grid List Box 3D named MyListBox.
GridListBox3DSharedPtr gridListBox = GridListBox3D::create(domain, "MyListBox");

To configure the grid area:

// Make each grid cell be a 1x1x1 cube.
gridListBox->setCellWidth(1.0f);
gridListBox->setCellHeight(1.0f);
gridListBox->setDepth(1.0f);
// Make the grid contain three rows that are filled column by column.
gridListBox->setHeight(3.0f);
gridListBox->setDirection(GridListBoxConcept::GridDirectionDown);
// Make the grid contain 10 columns. Items that are dragged beyond these columns are made invisible.
gridListBox->setWidth(10.0f);
// Change the resting position when the list is scrolled to the beginning or end, so that items are not right at the grid edge.
gridListBox->setItemAreaBegin(0.2f);
gridListBox->setItemAreaEnd(0.8f);

To add items to the list box:

// Create cube meshes and add them as items of the list box.
// Items on the grid appear in the order you add them to the list.
Model3DSharedPtr item1 = Model3D::createCube(domain, "item1", 1.0f, ThemeRed);
Model3DSharedPtr item2 = Model3D::createCube(domain, "item2", 1.0f, ThemeGreen);
Model3DSharedPtr item3 = Model3D::createCube(domain, "item3", 1.0f, ThemeBlue);
Model3DSharedPtr item4 = Model3D::createCube(domain, "item4", 1.0f, ThemeOrange);
Model3DSharedPtr item5 = Model3D::createCube(domain, "item5", 1.0f, ThemeYellow);
gridListBox->addItem(item1);
gridListBox->addItem(item2);
gridListBox->addItem(item3);
gridListBox->addItem(item4);
gridListBox->addItem(item5);

Constructor & Destructor Documentation

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

Member Function Documentation

static GridListBox3DSharedPtr kanzi::GridListBox3D::create ( Domain domain,
string_view  name 
)
static

Creates a Grid List Box 3D node.

Parameters
domainThe UI domain to which the node belongs.
nameThe name of the node.
static PropertyTypeEditorInfoSharedPtr kanzi::GridListBox3D::makeEditorInfo ( )
static
GridDirection kanzi::GridListBox3D::getDirection ( ) const
inline

Gets the value of DirectionProperty.

See also
setDirection()
void kanzi::GridListBox3D::setDirection ( GridDirection  value)
inline

Sets the value of DirectionProperty.

See also
getDirection()
float kanzi::GridListBox3D::getCellWidth ( ) const
inline

Gets the value of CellWidthProperty.

See also
setCellWidth()
void kanzi::GridListBox3D::setCellWidth ( float  value)
inline

Sets the value of CellWidthProperty.

See also
getCellWidth()
float kanzi::GridListBox3D::getCellHeight ( ) const
inline

Gets the value of CellHeightProperty.

See also
setCellHeight()
void kanzi::GridListBox3D::setCellHeight ( float  value)
inline

Sets the value of CellHeightProperty.

See also
getCellHeight()
float kanzi::GridListBox3D::getItemAreaBegin ( ) const
inline

Gets the value of ItemAreaBeginProperty.

See also
setItemAreaBegin()
void kanzi::GridListBox3D::setItemAreaBegin ( float  value)
inline

Sets the value of ItemAreaBeginProperty.

See also
getItemAreaBegin()
float kanzi::GridListBox3D::getItemAreaEnd ( ) const
inline

Gets the value of ItemAreaEndProperty.

See also
setItemAreaEnd()
void kanzi::GridListBox3D::setItemAreaEnd ( float  value)
inline

Sets the value of ItemAreaEndProperty.

See also
getItemAreaEnd()
Vector2 kanzi::GridListBox3D::getScrollPosition ( ) const
inline

Gets the value of ScrollPositionProperty.

Vector2 kanzi::GridListBox3D::getScrollTargetPosition ( ) const
inline

Gets the value of ScrollTargetPositionProperty.

Vector2 kanzi::GridListBox3D::getScrollSpeed ( ) const
inline

Gets the value of ScrollSpeedProperty.

bool kanzi::GridListBox3D::isScrolling ( ) const
inline

Gets the value of ScrollingProperty.

bool kanzi::GridListBox3D::isReversedScrolling ( ) const
inline

Returns the value of ReversedScrollingProperty.

See also
setReversedScrolling()
Since
Kanzi 3.9.7
void kanzi::GridListBox3D::setReversedScrolling ( bool  enable)
inline

Sets the value of the ReversedScrollingProperty.

Parameters
enableTo reverse the direction of scrolling, pass true, otherwise false.
See also
isReversedScrolling()
Since
Kanzi 3.9.7
ScrollView3DSharedPtr kanzi::GridListBox3D::getScrollView ( ) const
inline

Returns the ScrollView3D that scrolls the Grid List Box 3D.

Use this function to access the properties of the Scroll View or to modify the scrolling behavior.

Returns
The Scroll View that scrolls the Grid List Box 3D.
void kanzi::GridListBox3D::initialize ( )
protected
void kanzi::GridListBox3D::setInitialScrollPosition ( )
protected
void kanzi::GridListBox3D::arrangeOverride ( Vector3  actualSize)
overrideprotectedvirtual

Node3D::arrangeOverride() implementation.

Reimplemented from kanzi::Node3D.

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

Node::onNodePropertyChanged() implementation.

Reimplemented from kanzi::Node3D.


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