Module parallel_activity_host3d

Structs§

ACTIVATE_ACTIVITY_MESSAGE
Send this message to an Activity Host to activate its child Activity that you set in the message. On successful activation, Exclusive Activity Hosts automatically deactivates the previously active Activity.
ACTIVATION_STACK_PROPERTY
ACTIVITY_PREFAB_ATTACHED_MESSAGE
An Activity Host sends this message when it attaches the prefab of the Activity that is activated.
ACTIVITY_PREFAB_DETACHED_MESSAGE
An Activity Host sends this message when it detaches the prefab of the Activity that is deactivated.
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.
ActivationMessageArguments
ActivityHostConcept
BRING_ACTIVATED_TO_FRONT_PROPERTY
Sets whether to show the activated Activity in front within its Parallel Activity Host. This property affects the z-order of the activated Activity within the same Activity priority layer:
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
DEACTIVATE_ACTIVITY_MESSAGE
Send this message to an Activity Host to deactivate its child Activity that you set in the message. You can use this message only to deactivate an Activity in a Parallel Activity Host.
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.
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.
FOCUSABLE_PROPERTY
Indicates whether the node can receive focus.
FOCUSED_PROPERTY
Indicates whether the node has the key focus.
FOCUS_ON_ACTIVATION_PROPERTY
Sets the policy that a Parallel Activity Host uses to decide whether it tries to set the key focus to an activating Activity:
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
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.
PARALLEL_ACTIVITY_HOST_CONTENT_PROPERTY
Describes the content of a Parallel Activity Host. The Parallel Activity Host uses this content to instantiate Activity prefabs and control the status and lifetime of its child Activities. This property is not directly editable by a Kanzi Studio user. The ActivityBrowserController sets the value of this property according to the changes done to the state of the Activity Tree in the ActivityBrowser. The expected format for the property value is a list of Activity descriptions. Each of this Activity description contains:
PATH_PROPERTY
Full path to the node.
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.
ParallelActivityHost3D
An Activity Host that can display multiple Activity nodes at a time.
ParallelActivityHostConcept
REGISTER_HOST_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.
RegisterActivityElementInternalMessageArguments
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STYLE_PROPERTY
Sets a style to the node.
UNREGISTER_HOST_INTERNAL_MESSAGE
UnregisterActivityElementInternalMessageArguments
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§

ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
HorizontalAlignment
Horizontal alignment options.
ParallelActivityHostFocusingPolicy
Specifies the focusing policy that Kanzi applies to an activating Activity in a Parallel Activity Host. Apply this rule to an Activity in a Parallel Activity Host.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
IActivityHostConcept
Base class for Activity Host classes. This class defines common types, properties and messages for Activity Host classes. See: ExclusiveActivityHost2D, ExclusiveActivityHost3D, ParallelActivityHost2D, ParallelActivityHost3D.
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
IParallelActivityHostConcept
This is the base class for Parallel Activity Host nodes. See: ParallelActivityHost2D, ParallelActivityHost3D.

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref