Kanzi  3.9.5
Kanzi Engine API
kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo Struct Reference

Stores information that identifies an Activity node under a ParallelActivityHost. More...

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

Inheritance diagram for kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo:
[legend]

Public Member Functions

 ActivityInParallelHostInfo (string_view name, string_view prefabPath)
 Constructor. More...
 
 ActivityInParallelHostInfo (string_view name, string_view prefabPath, bool isInitallyActive, uint32_t priorityLevel)
 Constructor. More...
 
- Public Member Functions inherited from kanzi::ActivityHostConcept::ActivityInfo
 ActivityInfo (string_view activityName, string_view activityPrefabPath)
 Constructor. More...
 

Public Attributes

bool isInitiallyActive
 Tracks whether an Activity node is active when a ParallelActivityHost is activated: More...
 
uint32_t priorityLayer
 The priority layer value of an Activity node. More...
 
- Public Attributes inherited from kanzi::ActivityHostConcept::ActivityInfo
string name
 The name of the Activity node. More...
 
string prefabPath
 The path to the prefab of the Activity node. More...
 

Detailed Description

Stores information that identifies an Activity node under a ParallelActivityHost.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ActivityInParallelHostInfo() [1/2]

kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo::ActivityInParallelHostInfo ( string_view  name,
string_view  prefabPath 
)
inlineexplicit

Constructor.

Parameters
nameThe name of the Activity node.
prefabPathThe path to the prefab of the Activity node.

◆ ActivityInParallelHostInfo() [2/2]

kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo::ActivityInParallelHostInfo ( string_view  name,
string_view  prefabPath,
bool  isInitallyActive,
uint32_t  priorityLevel 
)
inlineexplicit

Constructor.

Parameters
nameThe name of the Activity node.
prefabPathThe path to the prefab of the Activity node.
isInitallyActiveFlag that indicates whether the Activity node is active when the ParallelActivityHost is activated:
  • When set to true, the Activity node is activated when the ParallelActivityHost is activated.
  • When set to false, the Activity node is not activated when the ParallelActivityHost is activated.
priorityLevelThe priority layer value of the Activity node.
See also
ParallelActivityHostContentProperty for more information regarding priority layer value.

Member Data Documentation

◆ isInitiallyActive

bool kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo::isInitiallyActive

Tracks whether an Activity node is active when a ParallelActivityHost is activated:

  • When set to true, the Activity node is activated when the ParallelActivityHost is activated.
  • When set to false, the Activity node is not activated when the ParallelActivityHost is activated.

◆ priorityLayer

uint32_t kanzi::ParallelActivityHostConcept::ActivityInParallelHostInfo::priorityLayer

The priority layer value of an Activity node.

See also
ParallelActivityHostContentProperty for more information regarding priority layer value.

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