Node Effect 2D

Node Effect 2D available properties

Name	Description	Inherited	Exported to Kanzi Engine
Blur Quality	Sets the visual quality of the blur. Lower quality uses less computing and memory resources.	No	Yes
Blur Radius	Sets the amount of blur by defining the radius of the circular area of pixels that blend into each other. The blur radius also determines the distance in pixels that the blur expands the render area by extending outward from an edge, unless you enable the Masked Blur property. To disable the blur effect, set this property to 0. The default value is 8.	No	Yes
Content Gradient	Sets the gradient along which the content fades out: - Start sets the minimum intensity at which the content starts to fade out. - Softness sets the difference in intensity it takes for the content to disappear. For a perfectly smooth gradient, set Start to 0 and Softness to 1. The default value [ 0.0, 0.19 ] makes the content fade out quickly before the outline fade-out starts.	No	Yes
Content Mask	Sets the color that masks color components relevant to the outline calculation. The comparison value is the result of a dot product between the mask and the content RGBA color value. By default Kanzi calculates the outline only from the alpha value.	No	Yes
Content Threshold	Sets the threshold at which the value Kanzi calculates using the content mask is considered valid. When the value calculated from masking the content exceeds this value, that pixel is part of the outlined area.	No	Yes
Description	Add a description of the purpose of this item. To export descriptions to a plain text file, select File > Export > Export Descriptions. When you export the kzb file, this description is not included in the exported file.	No	No
Effect Factory Name	The factory name for the effect. Use this name to instantiate an effect from a plugin.	No	No
Invert Content Mask	Whether to invert the value that Kanzi calculates using content masking.	No	Yes
Invert Mask	Whether to invert the mask so that transparent areas become opaque and opaque areas become transparent.	No	Yes
Mask Channel	Sets the texture channel to use as the input for the mask: - Alpha uses the alpha channel from the texture. This is the default. - Red uses the red color channel from the texture. - Green uses the green color channel from the texture. - Blue uses the blue color channel from the texture. - Luminance uses the luminance calculated from the red, green, and blue channels.	No	Yes
Mask Height	Sets the height of the mask to use in a layout. This value overrides the height of the texture that you use as the mask.	No	Yes
Mask Horizontal Alignment	Sets the horizontal alignment of the mask effect: - Left aligns the left edge of the mask with the left edge of the node. This is the default. - Right aligns the right edge of the mask with the right edge of the node. - Center aligns the mask horizontally to the center of the node. - Stretch stretches the mask horizontally to fit the node from the left edge to the right edge.	No	Yes
Mask Offset	Sets the mask offset along the X and Y axes in pixels. Kanzi applies the mask offset after stretch, alignment, and scale.	No	Yes
Mask Scale	Sets the factor by which to scale the mask. Kanzi applies the scale after stretch and alignment.	No	Yes
Mask Strength	Sets the strength of the mask effect in the range from 0 to 1: - 0 disables the mask effect. - 1 applies the mask at full strength. This is the default. - Any value between 0 and 1 partially applies the mask as if the non-masked result was blended with the fully masked version.	No	Yes
Mask Stretch	Sets the stretch mode of the mask effect: - None disables stretching. This is the default. - Fill stretches the mask to fill the node. - Uniform stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale. - Uniform To Fill stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale. - Repeat does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.	No	Yes
Mask Texture	Sets the mask texture. The default is no texture.	No	Yes
Mask Vertical Alignment	Sets the vertical alignment of the mask effect: - Bottom aligns the bottom edge of the mask with the bottom edge of the node. - Top aligns the top edge of the mask with the top edge of the node. This is the default. - Center aligns the mask vertically to the center of the node. - Stretch stretches the mask vertically to fit the node from the top edge to the bottom edge.	No	Yes
Mask Width	Sets the width of the mask to use in a layout. This value overrides the width of the texture that you use as the mask.	No	Yes
Masked Blur	Sets whether to blur only the pixels whose alpha channel value is not zero. When you enable this property, the blur does not spread to fully transparent pixels and the edges of the content stay sharp. The default value is false.	No	Yes
Outline Color	Sets the color of the outline.	No	Yes
Outline Inner Softness	Sets the softness of the outline relative to its width inside the content area. For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. By default, this property uses the value of the Outline Softness property.	No	Yes
Outline Inner Width	Sets the width of the outline in pixels inside the content area. By default, this property uses the value of the Outline Width property.	No	Yes
Outline Method	Sets the method for outline calculation: - Box search. Potentially consumes less memory, slower. - Two-pass search. Potentially consumes more memory, faster. This the default.	No	Yes
Outline Softness	Sets the softness of the outline. For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. The default value is 0.27.	No	Yes
Outline Texture	Sets the texture to apply to the outline. Kanzi applies to the outline only the top row of pixels from this texture. Set Outline Color to the color with which you want to modulate the colors in this texture.	No	Yes
Outline Texture Offset	Sets the relative starting offset for sampling the outline texture. The default value is 0.0.	No	Yes
Outline Texture Tiling	Sets the number of times the texture wraps around within the outline area. To repeat a texture, set its Wrap Mode to Repeat. The default value is 1.0	No	Yes
Outline Width	Sets the width of the outline in pixels outside the content area. The default value is 4 pixels.	No	Yes
Override Shadow Offset	Sets the offset of the shadow from the object along the x and y axes in pixels. When you set this property, the Shadow Angle and Shadow Distance properties have no effect. To disable the offset override, remove this property.	No	Yes
Shadow Angle	Sets the direction of the shadow as an angle relative to the positive x axis. The default is 45 degrees. When you set the Override Shadow Offset property, this property has no effect.	No	Yes
Shadow Blur Radius	Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge. For a shadow with sharp edges, set to 0. The default is 8 pixels.	No	Yes
Shadow Color	Sets the color and alpha of the shadow.	No	Yes
Shadow Distance	Sets how far to move the shadow from the object in the direction set by the Shadow Angle property. The default is 10 pixels. When you set the Override Shadow Offset property, this property has no effect.	No	Yes
Shadow Only	Whether to render only the shadow without the node contents.	No	Yes
Shadow Quality	Sets the visual quality of the shadow. Lower quality uses less computing and memory resources.	No	Yes
Shadow Type	Sets the type of the shadow: - Drop Shadow appears behind or below objects. - Inner Shadow appears inside objects.	No	Yes
Use Screen Space	Whether to layout the mask relative to the screen instead of the node.	No	Yes

Node Effect 2D messages

Name	Description	Inherited	Exported to Kanzi Engine
Activity Host: Activity Prefab Attached	An Activity Host sends this message when it attaches the prefab of the Activity that is activated.	No	Yes
Activity Host: Activity Prefab Detached	An Activity Host sends this message when it detaches the prefab of the Activity that is deactivated.	No	Yes
Activity: Activated	An Activity sends this message when it is activated.	No	Yes
Activity: Activating	An Activity sends this message when it is in the activating state.	No	Yes
Activity: Deactivated	An Activity sends this message when it is deactivated.	No	Yes
Activity: Deactivating	An Activity sends this message when it is in the deactivating state.	No	Yes
Activity: Status Changed	An Activity sends this message when the value of its Activity Status property changes.	No	Yes
Animation Player: Completed	Occurs when animation player completes animation playback.	No	Yes
Animation Player: Started	Occurs when animation player starts animation playback.	No	Yes
Animation Player: Stopped	Occurs when animation player stops animation playback.	No	Yes
Button: Cancel	Occurs when a user lifts their finger outside of a Button that they previously pressed.	No	Yes
Button: Click	Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires.	No	Yes
Button: Down	Occurs when the user presses down the Button.	No	Yes
Button: Enter	Button: Enter trigger is set off: - When the user presses down the button. - When the user presses down the button, moves the pointer outside of the button area, and then moves the pointer back to the button area while still holding down the pointer.	No	Yes
Button: Leave	Button: Leave trigger is set off: - When the user presses down the button and then lifts the pointer. - When the user presses down the button and then moves the pointer outside of the button area. - When the user sets off a Button : Long Press trigger.	No	Yes
Button: Long Press	Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button.	No	Yes
Click: Begin	Occurs when the user presses a hit-testable node with a Click Manipulator. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Click: Cancel	Occurs when the user first presses a hit-testable node with a Click Manipulator, then moves the pointer outside of the node area, and lifts the pointer. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Click: Click	Occurs when the user presses and releases a hit-testable node with a Click Manipulator, while the pointer is still within the node area and Kanzi does not recognize another gesture. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Click: Enter	Occurs when the user presses a hit-testable node with a Click Manipulator and then every time the user moves the pointer on top of that node while still holding down the pointer. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Click: Leave	Occurs when the user presses a hit-testable node with a Click Manipulator and then every time the user moves the pointer outside of that node. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Command: Command	Command message arguments	No	Yes
Data Trigger	Monitors changes in properties and data source values. Use a Data Trigger to apply an action to either set a property value of a target node or activate an Activity node.	No	Yes
Drag and Drop Manipulator: Drag and Drop Canceled	Occurs when focus moves away from the node during the drag-and-drop gesture.	No	Yes
Drag and Drop Manipulator: Drag and Drop Finished	Occurs when the user lifts their finger after starting the drag-and-drop gesture.	No	Yes
Drag and Drop Manipulator: Drag and Drop Moved	Occurs when the user moves their finger after starting the drag-and-drop gesture.	No	Yes
Drag and Drop Manipulator: Drag and Drop Started	Occurs when the user holds their finger for 500ms on the node.	No	Yes
Focus: About To Gain Focus	Kanzi sends this message before a focusable node receives focus.	No	Yes
Focus: About To Lose Focus	Kanzi sends this message before the focused node loses focus.	No	Yes
Focus: Focus Entered Focus Scope	When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus.	No	Yes
Focus: Focus Gained	Kanzi sends this message to the node that received focus.	No	Yes
Focus: Focus Left Focus Scope	When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus.	No	Yes
Focus: Focus Lost	Kanzi sends this message to the node that lost focus.	No	Yes
Focus: Input Outside Overlay	Kanzi sends this message to an overlay focus scope when the application area outside the boundaries of that overlay receives input.	No	Yes
Focus: Overlay Brought To Front	Occurs when an overlay focus scope becomes the foremost overlay scope in the overlay focus scope stack.	No	Yes
Focus: Overlay Gained Focus	When an overlay scope gains focus, Kanzi sends this message to the overlay scope node that contains the node that gains focus.	No	Yes
Focus: Overlay Lost Focus	When an overlay scope loses focus, Kanzi sends this message to the overlay scope node that contains the node that loses focus.	No	Yes
Focus: Overlay Sent To Back	Occurs when an overlay focus scope is no longer the foremost overlay scope in the overlay focus scope stack.	No	Yes
Focus: Scope Brought To Front (deprecated)	Occurs when an overlay focus scope is brought to front. Deprecated. Use Overlay Brought To Front instead.	No	Yes
Focus: Scope Sent To Back (deprecated)	Occurs when a foremost overlay focus scope is sent to back. Deprecated. Use Overlay Sent to Back instead.	No	Yes
Key Input: Key Canceled	Occurs when Kanzi recognizes a key-canceled gesture. A key-canceled gesture occurs when Kanzi recognizes that the user canceled a gesture.	No	Yes
Key Input: Key Navigation Canceled	Occurs when the key-pressed gesture is canceled for the navigation direction.	No	Yes
Key Input: Key Navigation Finished	Occurs when Kanzi recognizes the key-released gesture for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.	No	Yes
Key Input: Key Navigation Started	Occurs when Kanzi recognizes the key-pressed and key repeat gestures for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.	No	Yes
Key Input: Key Pressed	Occurs when Kanzi recognizes a key-pressed gesture. A key-pressed gesture occurs when Kanzi recognizes a key event that contains all the elements that compose that gesture.	No	Yes
Key Input: Key Released	Occurs when Kanzi recognizes a key-released gesture. A key-released gesture occurs when Kanzi recognizes the release of one of the elements that compose that gesture.	No	Yes
List Box: Item Hidden	Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.	No	Yes
List Box: Item Selected	Occurs when an item is selected.	No	Yes
List Box: Item Visible	Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.	No	Yes
List Box: Scroll Finished	Occurs when the List Box stops scrolling.	No	Yes
List Box: Scroll Started	Occurs when the List Box starts to scroll.	No	Yes
List Box: Scrolled	Occurs when the List Box scrolls.	No	Yes
List Box: Target Changed	Occurs when List Box gets a new target item.	No	Yes
List Box: User Scroll Finished	Occurs when the application user stops scrolling the List Box.	No	Yes
List Box: User Scroll Started	Occurs when the application user starts to scroll the List Box.	No	Yes
Long Press: Long Press	Occurs when the user presses a hit-testable node with a Long-Press Manipulator and holds the press for the time that you set in the Long-Press Manipulator. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Long Press: Long Press Cancel	Occurs during the long-press gesture when the user moves the focus away from a hit-testable node with a Long-Press Manipulator. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Message Trigger		No	Yes
Multi-Click: Intermediate Click	Occurs when the user presses and releases a hit-testable node with a Multi-Click Manipulator that is set to send messages for intermediate clicks. To set a Multi-Click Manipulator to send messages for intermediate clicks, in the Multi-Click Manipulator enable the Send Intermediate Click Messages property. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Multi-Click: Multi-Click	Occurs when the user presses and releases a hit-testable node with a Multi-Click Manipulator a specified number of times (default 2) within a set amount of time (default 250 ms) between presses. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
Multi-Click: Multi-Click Canceled	Occurs during the multi-click gesture when the user moves the focus away from a hit-testable node with a Multi-Click Manipulator. You cannot use this trigger with nodes that handle input by default, such as Button and Toggle Button nodes.	No	Yes
On Attached	This trigger is set off when the item is initialized. For example, when you add a node to the node tree, or enter a state that contains this trigger.	No	Yes
On Property Change	Occurs when a property is changed	No	Yes
On Timer	Occurs when timer interval is elapsed	No	Yes
Page Host: Page Navigation Finished	Page host has finished navigation process.	No	Yes
Page Host: Page Navigation Started	Page host has started navigation process.	No	Yes
Page: Activated	Page has been activated.	No	Yes
Page: Deactivated	Page has been deactivated.	No	Yes
Pan Manipulator: Pan Canceled	Occurs when focus moves away from the node during the pan gesture.	No	Yes
Pan Manipulator: Pan Entered	Occurs when the pan gesture enters the node the manipulator is attached to.	No	Yes
Pan Manipulator: Pan Finished	Occurs when the user lifts their finger after Kanzi recognizes a pan gesture.	No	Yes
Pan Manipulator: Pan Left	Occurs when the pan gesture leaves the node the manipulator is attached to.	No	Yes
Pan Manipulator: Pan Moved	Occurs when the user changes the position of their finger and that change exceeds the recognition thresholds.	No	Yes
Pan Manipulator: Pan Started	Occurs when the user presses down their finger on the node. If the user lifts their finger before exceeding the position change threshold, Kanzi cancels the pan gesture.	No	Yes
Pinch Manipulator: Pinch Canceled	Occurs when focus moves away from the node during the pinch gesture.	No	Yes
Pinch Manipulator: Pinch Finished	Occurs when the user lifts their finger after Kanzi recognizes a pinch gesture.	No	Yes
Pinch Manipulator: Pinch Moved	Occurs when the user changes the position of their finger and that change exceed the scale or rotation threshold.	No	Yes
Pinch Manipulator: Pinch Started	Occurs when the user presses down their finger. If the user lifts their finger before it exceeds the scale or rotate threshold, Kanzi cancels the pinch.	No	Yes
Prefab View: Asynchronous Load Completed	Occurs when asynchronous loading of resources from a prefab has been finished.	No	Yes
Property Target Easing Interpolator: Easing Interpolation Completed	Occurs when Property Target Easing Interpolator completes its interpolation.	No	Yes
Property Target Interpolator: Interpolation Completed	Occurs when property target interpolator completes interpolation.	No	Yes
Range: Value Change Finished	Occurs when the range value stops changing.	No	Yes
Range: Value Change Started	Occurs when the range value starts changing.	No	Yes
Range: Value Changed	Occurs when the range value has changed.	No	Yes
Scroll View: Scroll Ended	Occurs when the scroll position of a Scroll View node stops changing.	No	Yes
Scroll View: Scroll Started	Occurs when the scroll position of a Scroll View node starts changing.	No	Yes
Scroll View: Scroll Zoomed	Occurs when the zoom level of a Scroll View node changes.	No	Yes
Scroll View: Scrolled	Occurs when the scroll position of a Scroll View node changes.	No	Yes
Scroll View: Snap Request	Occurs when a Scroll View node requests snapping target from the hosting component.	No	Yes
Scroll View: User Scroll Ended	Occurs when the user stops scrolling a Scroll View node.	No	Yes
Scroll View: User Scroll Started	Occurs when the user starts scrolling a Scroll View node.	No	Yes
State Manager: Entered State	Occurs when a state manager has entered a state.	No	Yes
State Manager: Left State	Occurs when a state manager has left a state.	No	Yes
State Manager: Transition Finished	Occurs when a state manager finishes a transition to a state.	No	Yes
State Manager: Transition Started	Occurs when a state manager begins a transition to a state.	No	Yes
Text Box: Composition Text Changed	Occurs when the text produced in an Input Method Editor is updated in a Text Box node.	No	Yes
Text Box: Composition Text Committed	Occurs: - When the text produced in an Input Method Editor is committed to the cached text in a Text Box node. - When a trigger executes the Commit Composition Text action.	No	Yes
Text Box: Cursor Moved	Occurs when the user moves the cursor in a Text Box node.	No	Yes
Text Box: Editing Finished	Occurs when a Text Box node leaves the editing state after the user modified the text content.	No	Yes
Text Box: Editing Started	Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state.	No	Yes
Text Box: Entered Editing State	Occurs when a Text Box node enters the editing state.	No	Yes
Text Box: Input Method Action	Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node.	No	Yes
Text Box: Input Method Available	Occurs when an input method becomes available to a Text Box node. For example, an on-screen keyboard becomes available when it appears on the screen.	No	Yes
Text Box: Input Method Unavailable	Occurs when the input method that is composing text in a Text Box node becomes unavailable. For example, an on-screen keyboard becomes unavailable when the user hides it.	No	Yes
Text Box: Left Editing State	Occurs when a Text Box node leaves the editing state	No	Yes
Text Box: Selection Changed	Occurs when the user changes the text selection in a Text Box node.	No	Yes
Text Box: Selection Cleared	Occurs when the user clears or resets the text selection in a Text Box node.	No	Yes
Text Box: Selection Started	Occurs when the user starts selecting text in a Text Box node.	No	Yes
Text Box: Text Changed	Occurs when the user changes the text in a Text Box node.	No	Yes
Text Box: Text Composition Canceled	Occurs: - When the text composition in a Text Box node is canceled by Input Method that is in text composition state. - When a trigger executes the Cancel Text Composition action.	No	Yes
Toggle Button Group: Toggled	Occurs when the toggle state of a Toggle Button node in a Toggle Button Group node changes.	No	Yes
Toggle Button: State Toggled	Occurs when the toggle state of the Button changes.	No	Yes
Toggle Button: Toggled Off	Occurs when the Button is toggled off.	No	Yes
Toggle Button: Toggled On	Occurs when the Button is toggled on.	No	Yes