Kanzi  3.9.6
Kanzi Engine API
Static Public Member Functions | List of all members
kanzi::ParallelActivityHostContentHandler Struct Reference
Activity

Helper class used to modify the ParallelActivityHostContent of a ParallelActivityHost. More...

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

Static Public Member Functions

static ParallelActivityHostConcept::ParallelActivityHostContent addActivity (Node &hostNode, string_view name, string_view prefabPath, bool isInitiallyActive, uint32_t priorityLayer)
 Adds an Activity node to the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty. More...
 
static ParallelActivityHostConcept::ParallelActivityHostContent addActivity (Node &hostNode, string_view name, string_view prefabPath, bool isInitiallyActive)
 Adds an Activity node to the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty. More...
 
static ParallelActivityHostConcept::ParallelActivityHostContent read (string_view value)
 Converts a Parallel Activity Host Content from a string to a ParallelActivityHostContent object. More...
 
static ParallelActivityHostConcept::ParallelActivityHostContent removeActivity (Node &hostNode, string_view name)
 Removes an Activity node from the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty. More...
 
static string write (const ParallelActivityHostConcept::ParallelActivityHostContent &content)
 Converts a Parallel Activity Host Content from a ParallelActivityHostContent object to a string. More...
 

Detailed Description

Helper class used to modify the ParallelActivityHostContent of a ParallelActivityHost.

Since
Kanzi 3.9.0

Member Function Documentation

◆ addActivity() [1/2]

static ParallelActivityHostConcept::ParallelActivityHostContent kanzi::ParallelActivityHostContentHandler::addActivity ( Node &  hostNode,
string_view  name,
string_view  prefabPath,
bool  isInitiallyActive,
uint32_t  priorityLayer 
)
static

Adds an Activity node to the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty.

Parameters
hostNodeThe ParallelActivityHost node whose ParallelActivityHostContentProperty you want to modify.
nameThe name of the Activity node to add as a child node of the given ParallelActivityHost node.
prefabPathThe path to the prefab of the Activity node.
isInitiallyActiveFlag 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.
priorityLayerThe priority layer value of the Activity node.
See also
ParallelActivityHostContentProperty for more information regarding priority layer value.
Returns
The structure that describes the Activity nodes after this modification.

◆ addActivity() [2/2]

static ParallelActivityHostConcept::ParallelActivityHostContent kanzi::ParallelActivityHostContentHandler::addActivity ( Node &  hostNode,
string_view  name,
string_view  prefabPath,
bool  isInitiallyActive 
)
static

Adds an Activity node to the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty.

Parameters
hostNodeThe ParallelActivityHost node whose ParallelActivityHostContentProperty you want to modify.
nameThe name of the Activity node to add as a child node of the given ParallelActivityHost node.
prefabPathThe path to the prefab of the Activity node.
isInitiallyActiveFlag 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.
Returns
The structure that describes the Activity nodes after this modification.

◆ removeActivity()

static ParallelActivityHostConcept::ParallelActivityHostContent kanzi::ParallelActivityHostContentHandler::removeActivity ( Node &  hostNode,
string_view  name 
)
static

Removes an Activity node from the given ParallelActivityHost by modifying its ParallelActivityHostContentProperty.

Parameters
hostNodeThe ParallelActivityHost node whose ParallelActivityHostContentProperty you want to modify.
nameThe name of the Activity node that you want to remove from the ParallelActivityHost node.
Returns
The structure that describes the Activity nodes after this modification.

◆ read()

static ParallelActivityHostConcept::ParallelActivityHostContent kanzi::ParallelActivityHostContentHandler::read ( string_view  value)
static

Converts a Parallel Activity Host Content from a string to a ParallelActivityHostContent object.

Parameters
valueContent description as a string.
Returns
The Parallel Activity Host Content as a ParallelActivityHostContent object.

◆ write()

static string kanzi::ParallelActivityHostContentHandler::write ( const ParallelActivityHostConcept::ParallelActivityHostContent &  content)
static

Converts a Parallel Activity Host Content from a ParallelActivityHostContent object to a string.

Parameters
contentStructure that describes the Activity nodes.
Returns
The Parallel Activity Host Content as a string.
The documentation for this struct was generated from the following file: