kanzi::ParallelActivityHostConcept Class Reference

This is the base class for Parallel Activity Host nodes. More...

#include <kanzi/ui/node/concept/activity/parallel_activity_host_concept.hpp>

Inheritance diagram for kanzi::ParallelActivityHostConcept:

Classes
struct	ActivityInParallelHostInfo
	Stores information that identifies an Activity node under a ParallelActivityHost. More...
class	ActivityInParallelHostPrefabLoader
	Extends ActivityPrefabLoader with a specialized behavior for child Activity nodes of a ParallelExclusiveActivityHost. More...

Public Types
using	ParallelActivityHostContent = vector< ActivityInParallelHostInfo >
	Container for the content information for a ParallelActivityHost. More...
enum	ParallelActivityHostFocusingPolicy { ParallelActivityHostFocusingPolicy::WhenHostHasFocus, ParallelActivityHostFocusingPolicy::AlwaysFocus, ParallelActivityHostFocusingPolicy::NeverFocus }
	Specifies the focusing policy that Kanzi applies to an activating Activity in a Parallel Activity Host. More...

Public Member Functions
virtual	~ParallelActivityHostConcept ()=default
	Destructor. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns the PropertyType editor information for a Parallel Activity Host Concept. More...

Static Public Attributes
Properties
static PropertyType< bool >	BringActivatedToFrontProperty
	Sets whether to show the activated Activity in front within its Parallel Activity Host. More...
static PropertyType< bool >	ActivationStackProperty
	Sets whether a Parallel Activity Host keeps a child Activity node active to satisfy the request from both ActivateActivityMessage activation and ApplyActivationAction mechanism. More...
static PropertyType< string >	ParallelActivityHostContentProperty
	Describes the content of a Parallel Activity Host node. More...
static PropertyType< ParallelActivityHostFocusingPolicy >	FocusOnActivationProperty
	Sets the focusing policy that Kanzi uses to decide whether it tries to set focus to an activating Activity in a Parallel Activity Host. More...

Detailed Description

This is the base class for Parallel Activity Host nodes.

See also

ParallelActivityHost2D, ParallelActivityHost3D.

Member Typedef Documentation

ParallelActivityHostContent

using kanzi::ParallelActivityHostConcept::ParallelActivityHostContent = vector<ActivityInParallelHostInfo>

Container for the content information for a ParallelActivityHost.

For each child Activity node contains this information:

• The Activity node name
• The path to the prefab of the Activity node
• Whether the Activity node is active when its ParallelActivityHost is activated
• The priority layer value

See also

ParallelActivityHostContentProperty.

Since

Kanzi 3.9.0

Member Enumeration Documentation

ParallelActivityHostFocusingPolicy

enum kanzi::ParallelActivityHostConcept::ParallelActivityHostFocusingPolicy

strong

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.

Since

Kanzi 3.9.4

Enumerator
WhenHostHasFocus	If the Activity Host contains focus, set focus to the Activity.
AlwaysFocus	Always set focus to the Activity.
NeverFocus	Never set focus to the Activity.

Constructor & Destructor Documentation

~ParallelActivityHostConcept()

virtual kanzi::ParallelActivityHostConcept::~ParallelActivityHostConcept ( )

virtualdefault

Destructor.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ParallelActivityHostConcept::makeEditorInfo ( )

static

Returns the PropertyType editor information for a Parallel Activity Host Concept.

Returns

The PropertyType editor information for the Parallel Activity Host Concept.

Member Data Documentation

BringActivatedToFrontProperty

PropertyType<bool> kanzi::ParallelActivityHostConcept::BringActivatedToFrontProperty

static

Sets whether to show the activated Activity in front within its Parallel Activity Host.

This property affects the z-order of the Activities within the same priority layer:

• When set to true, the Parallel Activity Host brings the activated child Activity to the front.
• When set to false, the order in which you added the Activity to its Parallel Activity Host determines the z-order.

Changing the value of this property does not affect the z-order of already active Activities.

The default value is false.

ActivationStackProperty

PropertyType<bool> kanzi::ParallelActivityHostConcept::ActivationStackProperty

static

Sets whether a Parallel Activity Host keeps a child Activity node active to satisfy the request from both ActivateActivityMessage activation and ApplyActivationAction mechanism.

To activate an Activity node, the ApplyActivationAction mechanism sets a property modifier for the ActivationStackProperty.

Set this property on child Activity nodes of a Parallel Activity Host. The default value is false.

Since

Kanzi 3.9.0

ParallelActivityHostContentProperty

PropertyType<string> kanzi::ParallelActivityHostConcept::ParallelActivityHostContentProperty

static

Describes the content of a Parallel Activity Host node.

The Parallel Activity Host uses this content to instantiate Activity node prefabs and control the status and lifetime of its child Activity nodes.

Kanzi Studio user cannot directly edit this property. 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 node descriptions. Each description contains:

• The name of the Activity node.
• A boolean value describing whether the Activity node is going to be active on the ParallelActivityHost activation. When set to true the Activity node is going to be active, when set to false, the Activity node is not going to be active.
• The path to the prefab of the Activity node.
• The priority layer value of the Activity node. The priority layer value decides the z-order of the child Activity node. The child Activity node with a higher priority value, is displayed on the top of a child Activity node with the lower priority value. The z-order of the child Activity nodes with the same priority value depends on their order of addition to the Activity Host. The latest added child Activity node is always displayed on top on the existing child Activity nodes with the same priority value.

The values in this property must be separated by a comma.

Syntax: {{<child-activity-name>,<controller-property-value>,<activity-prefab-path>,<priority-layer-number>},{<child-activity-name>,<controller-property-value>,<activity-prefab-path>,<priority-layer-number>},...} Example: {{name1,1,path1,0},{name2,0,path2,1}}.

By default this property value is empty, that is, the Activity Host does not contain any content.

Since

Kanzi 3.9.0

FocusOnActivationProperty

PropertyType<ParallelActivityHostFocusingPolicy> kanzi::ParallelActivityHostConcept::FocusOnActivationProperty

static

Sets the focusing policy that Kanzi uses to decide whether it tries to set focus to an activating Activity in a Parallel Activity Host.

See also

ParallelActivityHostConcept::ParallelActivityHostFocusingPolicy.

Since

Kanzi 3.9.4

---

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

• kanzi/ui/node/concept/activity/parallel_activity_host_concept.hpp