Kanzi  3.9.6
Kanzi Engine API
kanzi::ActivityHostConcept::ActivatingActivity Struct Reference

Class to manage storing and switching of Activity nodes. More...

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

Public Member Functions

 ActivatingActivity (const ActivityInfo &activityInfo, string_view activationSequence)
 Constructor. More...
 

Public Attributes

NodeWeakPtr activity
 The activating Activity node. More...
 
bool animations
 Flag that indicates whether an Activity node activation with an animation. More...
 
vector< string > forwardingPath
 The activation path that Kanzi forwards when it completes the loading of the prefab. More...
 
string name
 The name of the activating Activity node. More...
 
string prefabPath
 The path to the prefab for the activating Activity node. More...
 
ActivationStatus status
 The current status of the activating Activity node. More...
 

Detailed Description

Class to manage storing and switching of Activity nodes.

Holds the record of an activating Activity node.

Constructor & Destructor Documentation

◆ ActivatingActivity()

kanzi::ActivityHostConcept::ActivatingActivity::ActivatingActivity ( const ActivityInfo activityInfo,
string_view  activationSequence 
)
inlineexplicit

Constructor.

Parameters
activityInfoAn ActivityInfo object of an activating Activity node.
activationSequenceThe path of the activation sequence for this Activity node and its child nodes.

Member Data Documentation

◆ status

ActivationStatus kanzi::ActivityHostConcept::ActivatingActivity::status

The current status of the activating Activity node.

◆ activity

NodeWeakPtr kanzi::ActivityHostConcept::ActivatingActivity::activity

The activating Activity node.

◆ name

string kanzi::ActivityHostConcept::ActivatingActivity::name

The name of the activating Activity node.

◆ prefabPath

string kanzi::ActivityHostConcept::ActivatingActivity::prefabPath

The path to the prefab for the activating Activity node.

◆ forwardingPath

vector<string> kanzi::ActivityHostConcept::ActivatingActivity::forwardingPath

The activation path that Kanzi forwards when it completes the loading of the prefab.

◆ animations

bool kanzi::ActivityHostConcept::ActivatingActivity::animations

Flag that indicates whether an Activity node activation with an animation.

If an Activity node activates with animations, use true, otherwise false.


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