Grid Layout 3D arranges 3D items in a grid. More...
#include <kanzi/node/grid_layout3d.hpp>
Static Public Member Functions | |
| static GridLayout3DSharedPtr | create (Domain *domain, string_view name) |
| Creates a grid layout node. More... | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
 Static Public Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static unsigned int | getColumn (const Node &item) |
| Gets the column of an item. More... | |
| static void | setColumn (Node &item, unsigned int column) |
| Sets the column of an item. More... | |
| static unsigned int | getColumnSpan (const Node &item) |
| Gets the column span of an item. More... | |
| static void | setColumnSpan (Node &item, unsigned int columnSpan) |
| Sets the column span of an item. More... | |
| static unsigned int | getRow (const Node &item) |
| Gets the row of an item. More... | |
| static void | setRow (Node &item, unsigned int row) |
| Sets the row of an item. More... | |
| static unsigned int | getRowSpan (const Node &item) |
| Gets the row span of an item. More... | |
| static void | setRowSpan (Node &item, unsigned int rowSpan) |
| Sets the row span of an item. More... | |
| Static Public Member Functions inherited from kanzi::Node3D | |
| static float | layoutUp () |
| static Vector3 | unboundedLayoutValue () |
| Returns unbounded layout value. More... | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Static Public Member Functions inherited from kanzi::Object | |
| static const Metaclass * | getStaticMetaclass () |
| 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::GridLayoutConcept | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static void | calculateWeightedSizes (RowColumnDefinitionContainer &definitions, float weightMultiplier) |
| Calculates grid row or column definition maximum sizes for weighted rows or columns. More... | |
| static void | calculateOffsets (RowColumnDefinitionContainer &definitions) |
| Calculates grid row or column definition offsets according to current maximum sizes. More... | |
| static float | accumulateMaximumSize (const RowColumnDefinitionContainer &definitions) |
| Calculates the sum of row or column definition's maximum sizes. More... | |
| static void | parseRowColumnDefinitions (const string &definitionCollection, RowColumnDefinitionContainer &definitions) |
| Parse grid row or column definitions from property string. More... | |
Protected Member Functions | |
| GridLayout3D (Domain *domain, string_view name) | |
| Constructor. More... | |
| virtual Vector3 | measureOverride (Vector3 availableSize) |
| Node3d::measureOverride() implementation. More... | |
| virtual void | arrangeOverride (Vector3 actualSize) |
| Node3d::arrangeOverride() implementation. More... | |
| Protected Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| GridLayoutConceptImpl (Domain *domain, string_view name) | |
| Constructor. More... | |
| virtual void | onNodePropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
| TBaseClass::arrangeOverride() implementation. More... | |
| Protected Member Functions inherited from kanzi::Node3D | |
| Node3D (Domain *domain, string_view name) | |
| virtual NodeSharedPtr | findAbstractChildOverride (string_view name) KZ_OVERRIDE |
| virtual VisitorResult | visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE |
| virtual void | renderDebugObjectsOverride (Renderer3D &renderer, const TransformedScene3D &transformedScene, const KzuTransformedObjectNode &transformedObjectNode) |
| void | setPrimitiveLayout (bool primitive) |
| Protected Member Functions inherited from kanzi::Node | |
| Node (Domain *domain, string_view name) | |
| Constructor. More... | |
| void | initialize () |
| virtual void | onAttached () |
| Called when an object node becomes attached. More... | |
| virtual void | onDetached () |
| Called when an object node becomes detached. More... | |
| void | updateResourceReferences () |
| void | updateResourceReferences (AbstractPropertyType propertyType) |
| void | updateResourceReferencesRecursive () |
| void | updateResourceReferencesRecursive (const ResourceID &resourceID) |
| void | attach () |
| Attaches the object node. More... | |
| void | detach () |
| Detaches the object node. More... | |
| Protected Member Functions inherited from kanzi::Object | |
| void | initialize () |
| void | onCopy (const Object &other) |
Additional Inherited Members | |
| Public Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| unsigned int | getRowCount () const |
| Gets the number of rows in the grid. More... | |
| unsigned int | getColumnCount () const |
| Gets the number of columns in the grid. More... | |
| void | addFixedRow (float size) |
| Adds a new fixed size row to the grid. More... | |
| void | addAutomaticRow () |
| Adds a new automatic size row to the grid. More... | |
| void | addWeightedRow (float weight) |
| Adds a new weighted size row to the grid. More... | |
| void | addFixedColumn (float size) |
| Adds a new fixed size column to the grid. More... | |
| void | addAutomaticColumn () |
| Adds a new automatic size column to the grid. More... | |
| void | addWeightedColumn (float weight) |
| Adds a new weighted size column to the grid. More... | |
| void | removeRow () |
| Removes the last row from the grid. More... | |
| void | removeColumn () |
| Removes the last column from the grid. More... | |
| void | setRowFixed (unsigned int index, float size) |
| Sets a grid row to a fixed size. More... | |
| void | setRowAutomatic (unsigned int index) |
| Sets a grid row to automatic size. More... | |
| void | setRowWeighted (unsigned int index, float weight) |
| Sets a grid row to a weighted size. More... | |
| void | setColumnFixed (unsigned int index, float size) |
| Sets a grid column to a fixed size. More... | |
| void | setColumnAutomatic (unsigned int index) |
| Sets a grid column to automatic size. More... | |
| void | setColumnWeighted (unsigned int index, float weight) |
| Sets a grid column to a weighted size. More... | |
| float | getActualRowSize (unsigned int index) const |
| Gets the last calculated value for a grid row size. More... | |
| float | getActualColumnSize (unsigned int index) const |
| Gets the last calculated value for a grid column size. More... | |
| GridDirection | getDirection () const |
| Gets the Direction property. More... | |
| void | setDirection (GridDirection value) |
| Sets the Direction property. More... | |
| string | getColumnDefinitions () const |
| Gets the ColumnDefinitions property. More... | |
| void | setColumnDefinitions (string_view value) |
| Sets the ColumnDefinitions property. More... | |
| string | getRowDefinitions () const |
| Gets the RowDefinitions property. More... | |
| void | setRowDefinitions (string_view value) |
| Sets the RowDefinitions property. More... | |
| Public Member Functions inherited from kanzi::Node3D | |
| bool | isUnboundedLayoutValue (Vector3 value) |
| Determines whether vector is unbounded layout value. More... | |
| Matrix4x4 | getRenderTransformation () const |
| Gets the value of RenderTransformationProperty. More... | |
| void | setRenderTransformation (Matrix4x4 value) |
| Sets the value of RenderTransformationProperty. More... | |
| Matrix4x4 | getLayoutTransformation () const |
| Gets the value of LayoutTransformationProperty. More... | |
| void | setLayoutTransformation (Matrix4x4 value) |
| Sets the value of LayoutTransformationProperty. More... | |
| Matrix4x4 | getFinalTransformation () const |
| Gets the value of FinalTransformationProperty. More... | |
| void | setFinalTransformation (Matrix4x4 value) |
| Sets the value of FinalTransformationProperty. More... | |
| bool | isObjectDepthTest () const |
| Gets the value of ObjectDepthTestProperty. More... | |
| void | setObjectDepthTest (bool value) |
| Sets the value of ObjectDepthTestProperty. More... | |
| bool | isObjectDepthWrite () const |
| Gets the value of ObjectDepthWriteProperty. More... | |
| void | setObjectDepthWrite (bool value) |
| Sets the value of ObjectDepthWriteProperty. More... | |
| bool | isObjectScissorEnabled () const |
| Gets the value of ObjectScissorEnabledProperty. More... | |
| void | setObjectScissorEnabled (bool value) |
| Sets the value of ObjectScissorEnabledProperty. More... | |
| Vector2 | getObjectScissorAreaXY () const |
| Gets the value of ObjectScissorAreaXYProperty. More... | |
| void | setObjectScissorAreaXY (Vector2 value) |
| Sets the value of ObjectScissorAreaXYProperty. More... | |
| Vector2 | getObjectScissorAreaWidthHeight () const |
| Gets the value of ObjectScissorAreaWidthHeightProperty. More... | |
| void | setObjectScissorAreaWidthHeight (Vector2 value) |
| Sets the value of ObjectScissorAreaWidthHeightProperty. More... | |
| float | getFrustumCullMargin () const |
| Gets the value of FrustumCullMarginProperty. More... | |
| void | setFrustumCullMargin (float value) |
| Sets the value of FrustumCullMarginProperty. More... | |
| virtual | ~Node3D () |
| size_t | getChildCount () const |
| Gets child count from object. More... | |
| Node3DSharedPtr | getChild (size_t index) const |
| Returns a child from given index from object node. More... | |
| size_t | getChildIndex (const Node &child) const |
| Returns the index of a child in an object node. More... | |
| bool | hasChild (const Node &child) const |
| Returns whether or not the child exists. More... | |
| void | addChild (const Node3DSharedPtr &child) |
| Adds a child node for object node. More... | |
| void | insertChild (size_t index, const Node3DSharedPtr &child) |
| Adds a child node for object node to given index. 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... | |
| void | removeAllChildren () |
| Removes all child nodes from parent object. More... | |
| ChildConstIterator | beginChildren () const |
| ChildConstIterator | endChildren () const |
| ChildConstReverseIterator | rbeginChildren () const |
| ChildConstReverseIterator | rendChildren () const |
| virtual bool | addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE |
| virtual size_t | getAbstractChildCountOverride () KZ_OVERRIDE |
| virtual NodeSharedPtr | getAbstractChildOverride (size_t index) KZ_OVERRIDE |
| virtual bool | removeAbstractChildOverride (Node &child) KZ_OVERRIDE |
| 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... | |
| void | setAutoWidth () |
| void | setAutoHeight () |
| void | setAutoDepth () |
| void | setAutoSize () |
| void | setSize (float width, float height, float depth) |
| void | setCoreDesiredSize (const Vector3 &coreDesiredSize) |
| Set core desired size for an object. More... | |
| Vector3 | getCoreDesiredSize () const |
| Get core desired size of an object. More... | |
| void | setDesiredSize (const Vector3 &desiredSize) |
| Set desired size for an object. More... | |
| Vector3 | getDesiredSize () const |
| Get desired size for of object. More... | |
| void | setAllocatedSize (const Vector3 &layoutSize) |
| Set allocated size for an object. More... | |
| Vector3 | getAllocatedSize () const |
| Get allocated size of an object. More... | |
| void | setActualSize (const Vector3 &actualSize) |
| Set actual size for an object. More... | |
| Vector3 | getActualSize () const |
| Get actual size of an object. More... | |
| void | setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax) |
| Set bounding box size for an object. More... | |
| void | getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const |
| Get bounding box size for an object. More... | |
| void | setAllocatedOffset (const Vector3 &allocatedOffset) |
| Set allocated offset for an object. More... | |
| Vector3 | getAllocatedOffset () const |
| Get allocated offset of an object. More... | |
| void | setStretchScale (const Vector3 &stretchScale) |
| Set stretch scale for an object. More... | |
| Vector3 | getStretchScale () const |
| Get stretch scale of an object. More... | |
| void | setPivotOffset (const Vector3 &pivotOffset) |
| Set pivot offset for an object. More... | |
| Vector3 | getPivotOffset () const |
| Get pivot offset of an object. More... | |
| kzsError | getSize (Vector3 &out_size) const |
| Returns the size of object node. More... | |
| kzsError | getMaximumBoundingBoxCoordinates (Vector3 &out_size) const |
| Returns the minimum coordinates for object nodes bounding volume. More... | |
| kzsError | getMinimumBoundingBoxCoordinates (Vector3 &out_size) const |
| Returns the maximum coordinates for object nodes bounding volume. More... | |
| void | setIdentityTransformation () |
| Sets an identity matrix for object node. More... | |
| void | setIdentity3x3Transformation () |
| Sets a top left 3x3 part of object node transformation as identity (clear rotation & scaling). More... | |
| void | setTranslation (float x, float y, float z) |
| Sets position for object node. More... | |
| Vector3 | getTranslation () const |
| Returns the translation of the object node as vector3. More... | |
| void | translate (float x, float y, float z) |
| Translates object node. More... | |
| void | rotate (float angleInDegrees, float x, float y, float z) |
| Rotates object node by specific axis, rotation angle in degrees. More... | |
| void | scale (float uniformScale) |
| Scales object node uniformly. More... | |
| void | scale (float scaleX, float scaleY, float scaleZ) |
| Scales object node non-uniformly. More... | |
| void | setArrangeTransformation (const Matrix4x4 &value) |
| Sets the layout transformation of the object. More... | |
| Matrix4x4 | getArrangeTransformation () const |
| Gets the layout transformation of the object. More... | |
| KzcMatrix4x4 | getBaseTransformationDefaultFromSRT () const |
| Calculates the node base transformation from scaling, rotation, and translation properties. More... | |
| void | layout () |
| Recursively calculate the layouts in the scene. More... | |
| void | measureIterate () |
| Initial scene measure. More... | |
| virtual bool | measureRecursive () |
| Perform layout measurement on a node. More... | |
| void | arrangeIterate () |
| Initial scene arrange. More... | |
| void | arrangeIterateLayout (bool propagateArrange) |
| void | arrangeIterateLayoutChild (bool propagateArrange) |
| void | measure (const Vector3 &availableSize) |
| Perform the default measure step. More... | |
| void | arrange () |
| Perform layout arrangement on a node. More... | |
| Vector3 | centeredMeasure (Vector3 availableSize) const |
| Default implementation of measure for a layout that accommodates all children at its center. More... | |
| void | centeredArrange (Vector3 actualSize) const |
| Default implementation of arrange for a layout that accommodates all children at its center. More... | |
| bool | isPrimitiveLayout () const |
| virtual void | render (Renderer3D &renderer, const KzuTransformedObjectNode &transformedObjectNode, KzcMatrix4x4 &worldTransformation) |
| Renders the object if the object type has specified a renderer function. More... | |
| void | renderDebugObjects (Renderer3D &renderer, const TransformedScene3D &transformedScene, const KzuTransformedObjectNode &transformedObjectNode) |
| Renders the debug visualizations for the object. More... | |
| Node3DSharedPtr | getLookAtTarget () const |
| Node3DSharedPtr | getPositionConstraintTarget () const |
| Node3DSharedPtr | getOrientationConstraintTarget () const |
| Node3DSharedPtr | getFaceToCameraTarget () const |
| Public Member Functions inherited from kanzi::Node | |
| virtual | ~Node () |
| Destructor. More... | |
| template<typename DataType > | |
| PropertyType< DataType >::DataType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. More... | |
| template<typename DataType > | |
| bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message handler where handler is a method to invoke on an object. More... | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where filter is a method to invoke on an object. More... | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message handler where handler is function. More... | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where filter is function. More... | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. More... | |
| template<typename TArgumentsType > | |
| void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
| Dispatches a message with specified arguments. More... | |
| 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 | 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... | |
| 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... | |
| optional< string > | findResourceURL (const ResourceID &resourceId) const |
| 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< T > | 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, and casts the resource to given type. 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< T > | tryAcquireResource (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... | |
| ResourceDictionarySharedPtr | getResourceDictionary () const |
| ResourceDictionarySharedPtr | acquireResourceDictionary () |
| void | setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| void | addAnonymousResource (ResourceSharedPtr resource) |
| Adds alias resource to an object node. More... | |
| void | removeAnonymousResource (const Resource &resource) |
| Removes anonymous resource from object node resources. More... | |
| bool | isNamed (string_view name) const |
| Node * | getParent () const |
| Returns the parent of the node. More... | |
| void | setParent (Node *parent) |
| VisitorResult | visit (const Visitor &visitor, VisitorOrder order) |
| VisitorResult | visitDescendants (const Visitor &visitor, VisitorOrder order) |
| 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... | |
| Node * | lookupNodeRaw (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 path) |
| ObjectSharedPtr | lookupResource (string_view resourceName) |
| Lookup for a resource from a node. More... | |
| 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... | |
| void | addInputManipulator (InputManipulatorSharedPtr inputManipulator) |
| Transfers the ownership and attaches an input manipulator to an object node. More... | |
| void | removeInputManipulator (InputManipulator &inputManipulator) |
| Removes the ownership and detaches an input manipulator from an object node. More... | |
| InputManipulatorConstIterator | beginInputManipulators () const |
| InputManipulatorConstIterator | endInputManipulators () const |
| void | addBinding (BindingSharedPtr binding) |
| Transfers the ownership of a binding rule to an object node. More... | |
| void | addBindingWithOwner (BindingSharedPtr binding, const void *owner) |
| Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More... | |
| void | removeBinding (Binding &binding) |
| Removes the ownership and detaches a binding rule from an object node. More... | |
| void | removeBindingsWithOwner (const void *owner) |
| Removes all bindings with the specified owner. More... | |
| BindingConstIterator | beginBindings () const |
| BindingConstIterator | endBindings () const |
| void | addTrigger (TriggerSharedPtr trigger) |
| Transfers the ownership of a trigger to an object node. More... | |
| void | addTriggerWithOwner (TriggerSharedPtr trigger, const void *owner) |
| Transfers the ownership of a trigger to an object node and sets the owner of the trigger. More... | |
| void | removeTrigger (Trigger &trigger) |
| Removes the ownership of a trigger from an object node. More... | |
| void | removeTriggersWithOwner (const void *owner) |
| Removes all bindings with the specified owner. More... | |
| TriggerConstIterator | beginTriggers () const |
| TriggerConstIterator | endTriggers () const |
| void | setRenderable (bool state) |
| Sets whether the object node is renderable. More... | |
| bool | isRenderable () const |
| Returns whether node is renderable. More... | |
| bool | isEffectivelyVisible () const |
| Checks if the node and all of its ancestors are visible. More... | |
| bool | isEffectivelyEnabled () const |
| Checks if the node and all of its ancestors are enabled. More... | |
| uint32_t | getChangeFlags () const |
| Get current change flags. More... | |
| uint32_t | getChildChangeFlags () const |
| Get current child change flags. More... | |
| void | setChangeFlag (uint32_t flag) |
| Sets a change flag. More... | |
| void | clearChangeFlag (uint32_t flag) |
| Clears a change flag. More... | |
| bool | isChangeFlagSet (uint32_t flag) const |
| Checks if a change flag is set. More... | |
| void | setChildChangeFlag (uint32_t flag) |
| Sets a child change flag. More... | |
| void | clearChildChangeFlag (uint32_t flag) |
| Clears a child change flag. More... | |
| bool | isChildChangeFlagSet (uint32_t flag) const |
| Checks if child change flags match. More... | |
| bool | isAnyChildChangeFlagSet (uint32_t flag) const |
| Checks if any child change flags (corresponding to given mask) are set. More... | |
| bool | isInvalidMeasure () const |
| Check if the node needs measure. More... | |
| void | invalidateMeasure () |
| Invalidates measure for the node. More... | |
| void | validateMeasure () |
| Validates measure for the node. More... | |
| bool | isInvalidArrange () const |
| Checks if the node needs arrange. More... | |
| void | invalidateArrange () |
| Invalidates arrange. More... | |
| void | validateArrange () |
| Validates arrange. More... | |
| bool | isInvalidRender () const |
| Returns if node render flag is invalid. More... | |
| void | validateRender () |
| Validates render for object node. More... | |
| void | invalidateRender () |
| Invalidates render for object node. 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 | isDetaching () const |
| Returns true if the node currently detaching. More... | |
| void | attachRecursive () |
| Attaches an object node and its children recursively. More... | |
| void | detachRecursive () |
| Detaches an object node and its children recursively. More... | |
| kzsError | addTimeLineEntry (struct KzuTimeLineEntry *timeLineEntry) |
| Adds timeline entry for object's animation player. More... | |
| TimeLineEntrySharedPtr | addAnimationItem (AnimationItemSharedPtr animationItemSharedPtr, bool reverse, int repeatCount) |
| Adds animation item for object's animation player. More... | |
| kzsError | createAnimationPlayerAttachToParentPlayer (struct KzuAnimationPlayer **out_animationPlayer) |
| Create an animation player that references this object node, attach to an animation player in parent node. More... | |
| kzsError | createAnimationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer **out_animationPlayer) |
| Create an animation player that references this object node, attach to the master animation player in task scheduler. More... | |
| kzsError | animationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer *animationPlayer) const |
| Attach given animation player to the task scheduler acquired via the object node. More... | |
| struct KzuAnimationPlayer * | getAnimationPlayer () const |
| Returns animation player from object node. More... | |
| virtual void | getBoundingVolume (KzuBoundingVolume **out_boundingVolume) const |
| Gets bounding volume from object node. More... | |
| AppliedStyleEntry * | applyStyle (StyleSharedPtr style) |
| Applies a style to an object node. More... | |
| void | unapplyStyle (AppliedStyleEntry *appliedStyleEntry) |
| Unapplies a style from an object node. More... | |
| void | applyStyles () |
| Apply all styles for an object node. More... | |
| void | unapplyStyles () |
| Unapplies and removes all applied styles. More... | |
| void | applyStylesRecursive () |
| Applies styles recursively. More... | |
| void | unapplyStylesRecursive () |
| Unapplies styles recursively. More... | |
| void | removeKZBData () |
| Destroys all object node data loaded from KZB, including properties, bindings, triggers, resources etc. More... | |
| void | addPropertyNotificationHandler (AbstractPropertyType propertyType, AbstractPropertyNotificationHandler *handler) |
| Add an abstract property notification handler. More... | |
| void | removePropertyNotificationHandler (const AbstractPropertyNotificationHandler &handler) |
| Remove an abstract property notification handler. More... | |
| size_t | getPropertyNotificationHandlerCount () const |
| Gets number of current notification handlers. More... | |
| void | addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference) |
| This is a helper for automatic resource tracking in ResourceReference. More... | |
| void | removeResourceReference (const AbstractResourceReference &reference) |
| This is a helper for automatic resource tracking in ResourceReference. More... | |
| void | addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference) |
| void | removeNodeReference (const AbstractNodeReference &reference) |
| virtual void | restoreResources () |
| Reattaches an object node after potential resource change. More... | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| string | getName () const |
| Gets the value of NameProperty. More... | |
| void | setName (string 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... | |
| 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... | |
| 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 |
| Gets the value of EnabledProperty. More... | |
| void | setEnabled (bool value) |
| Sets the value of EnabledProperty. More... | |
| bool | isFocusable () const |
| Gets the value of FocusableProperty. More... | |
| void | setFocusable (bool value) |
| Sets the value of FocusableProperty. More... | |
| bool | isFocused () const |
| Gets the value of FocusedProperty. More... | |
| void | setFocused (bool value) |
| Sets the value of FocusedProperty. More... | |
| ResourceID | getFontResourceID () const |
| Gets the value of FontProperty. More... | |
| void | setFontResourceID (ResourceID value) |
| Sets the value of FontProperty. More... | |
| float | getVisibleAmountInParent () const |
| Gets the value of VisibleAmountInParentProperty. More... | |
| void | setVisibleAmountInParent (float value) |
| Sets the value of VisibleAmountInParentProperty. More... | |
| bool | isClipChildren () const |
| Gets the value of ClipChildrenProperty. More... | |
| void | setClipChildren (bool value) |
| Sets the value of ClipChildrenProperty. More... | |
| float | getProjection2DTo3DScale () const |
| Gets the value of Projection2DTo3DScaleProperty. More... | |
| void | setProjection2DTo3DScale (float value) |
| Sets the value of Projection2DTo3DScaleProperty. More... | |
| string | getDataContext () const |
| Gets the value of DataContextProperty. More... | |
| void | setDataContext (string value) |
| Sets the value of DataContextProperty. More... | |
| bool | isEnableClick () const |
| Gets the value of EnableClickProperty. More... | |
| void | setEnableClick (bool value) |
| Sets the value of EnableClickProperty. More... | |
| bool | isEnableMultiClick () const |
| Gets the value of EnableMultiClickProperty. More... | |
| void | setEnableMultiClick (bool value) |
| Sets the value of EnableMultiClickProperty. 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... | |
| ResourceID | getStyleResourceID () const |
| Gets the value of StyleProperty. More... | |
| void | setStyleResourceID (ResourceID value) |
| Sets the value of StyleProperty. More... | |
| ResourceID | getStateManagerResourceID () const |
| Gets the value of StateManagerProperty. More... | |
| void | setStateManagerResourceID (ResourceID value) |
| Sets the value of StateManagerProperty. More... | |
| Public Member Functions inherited from kanzi::Object | |
| Object (Domain *domain) | |
| virtual | ~Object () |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. More... | |
| KzuPropertyManager * | getPropertyManager () const |
| Returns the property manager of the object. More... | |
| KzuTaskScheduler * | getTaskScheduler () const |
| Returns the task scheduler of the object. More... | |
| KzuMessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. More... | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. More... | |
| virtual const Metaclass * | getDynamicMetaclass () const |
| Returns the metaclass of the dynamic type of the object. More... | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. More... | |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value) |
| Sets the local value of a property. More... | |
| void | setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value) |
| Sets the local value of a resource id property with a resource pointer. More... | |
| template<typename DataType > | |
| DataType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. More... | |
| template<typename DataType > | |
| bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value) |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value) |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. More... | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. More... | |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. More... | |
| void | copyLocalValues (const Object &other) |
| Copies all local values from another object. More... | |
| AppliedStyleEntry * | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. More... | |
| void | unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry) |
| void | applyObjectStyles () |
| Apply all styles for an object node. More... | |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. More... | |
| Static Public Attributes inherited from kanzi::Node3D | |
| static PropertyType< Matrix4x4 > | RenderTransformationProperty |
| RenderTransformation property. More... | |
| static PropertyType< Matrix4x4 > | LayoutTransformationProperty |
| LayoutTransformation property. More... | |
| static PropertyType< Matrix4x4 > | FinalTransformationProperty |
| FinalTransformation property. More... | |
| static PropertyType< bool > | ObjectDepthTestProperty |
| ObjectDepthTest property. More... | |
| static PropertyType< bool > | ObjectDepthWriteProperty |
| ObjectDepthWrite property. More... | |
| static PropertyType< bool > | ObjectScissorEnabledProperty |
| ObjectScissorEnabled property. More... | |
| static PropertyType< Vector2 > | ObjectScissorAreaXYProperty |
| ObjectScissorAreaXY property. More... | |
| static PropertyType< Vector2 > | ObjectScissorAreaWidthHeightProperty |
| ObjectScissorAreaWidthHeight property. More... | |
| static PropertyType< float > | FrustumCullMarginProperty |
| FrustumCullMargin 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< 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::HorizontalAlignment > | HorizontalAlignmentProperty |
| HorizontalAlignment property. More... | |
| static PropertyType < Node::VerticalAlignment > | VerticalAlignmentProperty |
| VerticalAlignment property. More... | |
| static PropertyType < Node::DepthAlignment > | DepthAlignmentProperty |
| DepthAlignment property. More... | |
| static PropertyType< Vector2 > | HorizontalMarginProperty |
| HorizontalMargin property. More... | |
| static PropertyType< Vector2 > | VerticalMarginProperty |
| VerticalMargin property. More... | |
| static PropertyType< Vector2 > | DepthMarginProperty |
| DepthMargin 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 |
| Enabled property. More... | |
| static PropertyType< bool > | FocusableProperty |
| Focusable property. More... | |
| static PropertyType< bool > | FocusedProperty |
| Focused property. More... | |
| static PropertyType< ResourceID > | FontProperty |
| Font property. More... | |
| static PropertyType< float > | VisibleAmountInParentProperty |
| VisibleAmountInParent property. More... | |
| static PropertyType< bool > | ClipChildrenProperty |
| ClipChildren property. More... | |
| static PropertyType< float > | Projection2DTo3DScaleProperty |
| Projection2DTo3DScale property. More... | |
| static PropertyType< string > | DataContextProperty |
| DataContext property. More... | |
| static PropertyType< bool > | EnableClickProperty |
| EnableClick property. More... | |
| static PropertyType< bool > | EnableMultiClickProperty |
| EnableMultiClick property. More... | |
| static PropertyType < Node::ContentStretch > | ContentStretchProperty |
| ContentStretch property. More... | |
| static PropertyType< float > | OpacityProperty |
| Opacity property. More... | |
| static PropertyType< ResourceID > | StyleProperty |
| Style property. More... | |
| static PropertyType< ResourceID > | StateManagerProperty |
| StateManager 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 PropertyType< void * > | PrefabTemplateSourceProperty |
| PrefabTemplateSource property. More... | |
| Static Public Attributes inherited from kanzi::GridLayoutConcept | |
| static PropertyType < GridLayoutConcept::GridDirection > | DirectionProperty |
| Direction property. More... | |
| static PropertyType< string > | ColumnDefinitionsProperty |
| ColumnDefinitions property. More... | |
| static PropertyType< string > | RowDefinitionsProperty |
| RowDefinitions property. More... | |
| static PropertyType< int > | ColumnProperty |
| Column property. More... | |
| static PropertyType< int > | ColumnSpanProperty |
| ColumnSpan property. More... | |
| static PropertyType< int > | RowProperty |
| Row property. More... | |
| static PropertyType< int > | RowSpanProperty |
| RowSpan property. More... | |
| Protected Types inherited from kanzi::Object | |
| typedef vector < AppliedStyleEntry * > | AppliedStyleContainer |
| Applied style container. More... | |
| Static Protected Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| static void | getNextItemLocation (const Node &node, GridObjectLocationWorkspace &workspace, unsigned int &out_row, unsigned int &out_column) |
| Decides the row and column for the next item in the grid. More... | |
| static void | getSpan (const Node &item, unsigned int &rowSpan, unsigned int &columnSpan) |
| Gets the span of a grid item. More... | |
| Static Protected Member Functions inherited from kanzi::Node | |
| static VisitorResult | updateResourceVisitor (Node &node, const ResourceID &id) |
| static VisitorResult | updateAllResourcesVisitor (Node &node) |
| static VisitorResult | applyStylesVisitor (Node &node, bool apply) |
| static VisitorResult | attachVisitor (Node &node) |
| static VisitorResult | detachVisitor (Node &node) |
| static void | processPropertyChanged (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
| static VisitorResult | propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
| Protected Attributes inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| RowColumnDefinitionContainer | m_rows |
| Row definitions. More... | |
| RowColumnDefinitionContainer | m_columns |
| Column definitions. More... | |
| float | m_rowWeights |
| Total weights of weighted rows. More... | |
| float | m_columnWeights |
| Total weight of weighted columns. More... | |
| float | m_accumulatedRowSize |
| Total size of all rows. More... | |
| float | m_accumulatedColumnSize |
| Total size of all columns. More... | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. More... | |
Grid Layout 3D arranges 3D items in a grid.
You can let the grid layout arrange the items automatically from the top-left towards the bottom-right corner, or manually assign each item to a specific row and column in a grid.
Note that the depth of the grid is the maximum depth for all the items in a grid.
When you want to manually assign items to a specific row and cell in a grid layout, use setRow() and setColumn().
When you let a grid layout to arrange items automatically, you can set the direction in which the grid layout arranges its items. For example, when you set the DirectionProperty property to GridDirectionDown, grid layout first places the items in the rows of the first column. When all the rows in the first column are full, grid layout starts placing the items in the rows of the second column, and so on. See setDirection().
When you create columns and rows in a grid layout you can specify how the grid layout calculates their size:
For each cell in a grid layout you can set the number of columns and rows it spans. See setColumnSpan() and setRowSpan().
To create a Grid Layout 3D with two columns and two rows with automatic cell size, and set the grid to arrange the items in the grid columns from top to bottom:
To create a Grid Layout 3D with two columns and three rows whose sizes the grid calculates in proportion to the sizes of other columns and rows in the grid. For each item in the grid manually set which cells in the grid it occupies:
To create a Grid Layout 3D with two columns and two rows, using both fixed and automatic cell size. By default the grid automatically sets which cells the items occupy:
|
explicitprotected |
Constructor.
| domain | The UI domain the new node belongs to. |
| name | The name of the node. |
|
static |
Creates a grid layout node.
| domain | The UI domain the new node belongs to. |
| name | Name of the trajectory layout. |
|
static |
Node3d::measureOverride() implementation.
Reimplemented from kanzi::Node3D.
|
protectedvirtual |
Node3d::arrangeOverride() implementation.
Reimplemented from kanzi::Node3D.
