Module activity3d

Structs§

ACTIVATED_BY_ACTIVATION_MODIFIER_PROPERTY
ACTIVITY_ACTIVATED_MESSAGE
An Activity sends this message when it is activated.
ACTIVITY_ACTIVATING_MESSAGE
An Activity sends this message when it is in the activating state.
ACTIVITY_DEACTIVATED_MESSAGE
An Activity sends this message when it is deactivated.
ACTIVITY_DEACTIVATING_MESSAGE
An Activity sends this message when it is in the deactivating state.
ACTUAL_DEPTH_PROPERTY
The calculated size of the node in depth direction when used in a layout.
ACTUAL_HEIGHT_PROPERTY
The calculated height of the node when used in a layout.
ACTUAL_WIDTH_PROPERTY
The calculated width of the node when used in a layout.
ATTACHED_PROPERTY
Activity3D
An Activity is a part of application UI that is responsible for a task. For example, a media player application can have Activity nodes, such as radio, music player, and AUX. However, an Activity can also be a smaller task, such as an Activity for the popup volume indicator that appears only when the user changes the volume in a media player. An Activity can be visual, but does not have to be. For example, an Activity that is visual can instantiate a prefab to show a popup window, while an Activity that is not visual can be music playback which plays music in the background regardless of other Activity nodes.
ActivityConcept
ActivityElement
ActivityInternalMessageArguments
ActivityMessageArguments
ActivityPrefabMessageArguments
CLIP_CHILDREN_PROPERTY
Sets whether to clip the child nodes of this node. Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.
CONTENT_STRETCH_PROPERTY
Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
CREATED_FROM_KZB_PROPERTY
Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.
ContentLayout3D
The measured dimensions of the Content Layout 3D are determined by the combined maximum dimensions of its items.
ContentLayoutConcept
DEPTH_ALIGNMENT_PROPERTY
The alignment in depth direction the node should use when it resides under a layout.
DEPTH_MARGIN_PROPERTY
Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
DEPTH_PADDING_PROPERTY
Sets the padding spaces between the content and the front and back boundaries of the Content Layout 3D node.
DEPTH_PROPERTY
The size of the node in depth direction when used in a layout. Overrides the default bounds of the item.
DUMMY_STATE_MANAGER_PROPERTY
EFFECTIVELY_ENABLED_PROPERTY
Indicates whether this node and its ancestor nodes are enabled. Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled:
ENABLED_PROPERTY
Whether this node is enabled. When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.
FINAL_TRANSFORMATION_PROPERTY
The combined location, orientation and scale of the node and its ancestor nodes. Automatically calculated by the system.
FINISHED_EXCLUSIVE_DEACTIVATING_ANIMATION_INTERNAL_MESSAGE
FINISHED_PARALLEL_ACTIVATING_ANIMATION_INTERNAL_MESSAGE
FINISHED_PARALLEL_DEACTIVATING_ANIMATION_INTERNAL_MESSAGE
FOCUSABLE_PROPERTY
Indicates whether the node can receive focus.
FOCUSED_PROPERTY
Indicates whether the node has the key focus.
FOCUS_STATE_PROPERTY
Reports the focus state of a node:
FONT_FAMILY_PROPERTY
The font family used to render the text.
FRUSTUM_CULL_MARGIN_PROPERTY
The margin of the frustum cull radius of the node. For example, set the margin when a vertex shader modifies the geometry of the node. To use this property, enable the Frustum Culling property in the Draw Objects Render Pass you use to render the node.
HEIGHT_PROPERTY
The height of the node when used in a layout. Overrides the default bounds of the item.
HIT_TESTABLE_CONTAINER_PROPERTY
When enabled, Kanzi uses the layout bounds as geometry for hit testing.
HIT_TESTABLE_PROPERTY
When enabled, the node can be hit tested. Enabling Hit Testable for a 2D node enables hit testing only for that node. Enabling Hit Testable for a 3D node enables hit testing also for the child nodes. Kanzi hit tests 3D nodes using the default Camera node or the Hit Test Camera node of the active Scene node.
HORIZONTAL_ALIGNMENT_PROPERTY
The alignment in horizontal direction the node should use when it resides under a layout.
HORIZONTAL_MARGIN_PROPERTY
Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
HORIZONTAL_PADDING_PROPERTY
Sets the padding spaces between the content and the left and right boundaries of the Content Layout node.
HOVER_PROPERTY
Indicates whether a node is the foremost hit testable node under the cursor.
INode3DBase
KEEP_ACTIVITY_ALIVE_PROPERTY
Sets how to handle the Activity node when you deactivate it:
LAYOUT_TRANSFORMATION_PROPERTY
The location, orientation and scale of the node relative to its parent node. Layout Transformation affects the layout. If you do not want to affect the layout, use Render Transformation.
LOCALE_PROPERTY
The locale of the node.
MessageSubscriptionToken
Message subscription token for nodes.
NAME_PROPERTY
Node name.
Node
Base class for Kanzi nodes.
Node3D
Base class for all 3D nodes.
Node3DChildrenIterator
NodeComponentIterator
OPACITY_PROPERTY
Opacity of the node.
PATH_PROPERTY
Full path to the node.
PRESERVE_HISTORY_PROPERTY
Determines whether Kanzi preserves Activity property values when that Activity becomes inactive:
PROJECTION_2D_TO_3D_SCALE_PROPERTY
Sets the scale factor to project pixels to 3D size. When scale is 1, then the size of one pixel is one 3D space unit.
READY_FOR_ACTIVATION_ANIMATION_INTERNAL_MESSAGE
RENDER_TRANSFORMATION_PROPERTY
The location, orientation, and scale of the node relative to its parent node. Render transformation does not affect the layout of the node.
SAVE_LAST_FOCUSED_NODE_PROPERTY
When this property is enabled, Kanzi remembers the last-focused node in this Activity and sets the key focus to that node when you activate this Activity again. This is the default. When you do not want Kanzi to remember the last-focused node in this Activity, disable this property.
START_ACTIVATION_INTERNAL_MESSAGE
START_DEACTIVATION_INTERNAL_MESSAGE
START_EXCLUSIVE_ACTIVATING_ANIMATION_INTERNAL_MESSAGE
START_EXCLUSIVE_DEACTIVATING_ANIMATION_INTERNAL_MESSAGE
START_PARALLEL_ACTIVATING_ANIMATION_INTERNAL_MESSAGE
START_PARALLEL_DEACTIVATING_ANIMATION_INTERNAL_MESSAGE
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STATUS_CHANGED_MESSAGE
An Activity sends this message when the value of its Activity Status property changes.
STATUS_PROPERTY
Sets the possible states of the Activity when its Activity Host activates or deactivates that Activity.
STYLE_PROPERTY
Sets a style to the node.
StartActivationInternalMessageArguments
StatusChangedInternalMessageArguments
StatusChangedMessageArguments
VERTICAL_ALIGNMENT_PROPERTY
The alignment in vertical direction the node should use when it resides under a layout.
VERTICAL_MARGIN_PROPERTY
Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
VERTICAL_PADDING_PROPERTY
Sets the padding spaces between the content and the top and bottom boundaries of the Content Layout node.
VISIBLE_AMOUNT_IN_PARENT_PROPERTY
Sets the amount the node is inside its parent. Use the value of this property in shaders to implement fades. Calculated by the parent node.
VISIBLE_PROPERTY
When disabled, Kanzi does not render the node.
WIDTH_PROPERTY
The width of the node when used in a layout. Overrides the default bounds of the item.

Enums§

ActivityStatus
Legacy version of enum “kanzi.ActivityConcept.Status”. Defines possible states of an Activity. Activity Host nodes can activate and deactivate their child Activities. This enumeration defines the possible states of an Activity during the the process of activation and deactivation. You can use this functionality to react to changes in Activity status in your application code and in Kanzi Studio. See: Activity, StatusProperty
ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
HorizontalAlignment
Horizontal alignment options.
KeepAlivePolicy
Defines the policy for an inactive Activity.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
IActivityConcept
Base class for Activity classes. This class defines common types, properties, and messages for Activity classes. See: Activity2D, Activity3D
IActivityElement
ActivityElement is the base class for all Activity and Activity Host classes.
IContentLayoutConcept
Use the Content Layout nodes to present complex content as one element in the UI. You can use a Content Layout node to create a control that adapts to the size of its content, or a control where the content adapts to the size of the control.
INode3D

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref