Base class for the Data-Driven Exclusive Activity Host classes.
More...
#include <kanzi/ui/node/concept/activity/data_driven_exclusive_activity_host_concept.hpp>
Base class for the Data-Driven Exclusive Activity Host classes.
This class defines the common types, functionality, and properties for the Data-Driven Exclusive Activity Host classes.
- See also
- DataDrivenExclusiveActivityHost2D, DataDrivenExclusiveActivityHost3D
- Since
- Kanzi 3.9.0
◆ ~DataDrivenExclusiveActivityHostConcept()
virtual kanzi::DataDrivenExclusiveActivityHostConcept::~DataDrivenExclusiveActivityHostConcept |
( |
| ) |
|
|
virtualdefault |
◆ makeEditorInfo()
Returns PropertyType editor info of exclusive activity concept.
◆ getNode() [1/2]
virtual Node* kanzi::DataDrivenExclusiveActivityHostConcept::getNode |
( |
| ) |
|
|
pure virtual |
◆ getNode() [2/2]
virtual const Node* kanzi::DataDrivenExclusiveActivityHostConcept::getNode |
( |
| ) |
const |
|
pure virtual |
◆ getActivitySource()
ResourceSharedPtr kanzi::DataDrivenExclusiveActivityHostConcept::getActivitySource |
( |
| ) |
const |
◆ setActivitySource()
void kanzi::DataDrivenExclusiveActivityHostConcept::setActivitySource |
( |
ResourceSharedPtr |
value | ) |
|
◆ getActivityTemplate()
string kanzi::DataDrivenExclusiveActivityHostConcept::getActivityTemplate |
( |
| ) |
const |
◆ setActivityTemplate()
void kanzi::DataDrivenExclusiveActivityHostConcept::setActivityTemplate |
( |
string |
prefabUrl | ) |
|
◆ getActiveItemIndex()
int kanzi::DataDrivenExclusiveActivityHostConcept::getActiveItemIndex |
( |
| ) |
const |
◆ setActiveItemIndex()
void kanzi::DataDrivenExclusiveActivityHostConcept::setActiveItemIndex |
( |
int |
value | ) |
|
◆ getNameForIndex()
static string kanzi::DataDrivenExclusiveActivityHostConcept::getNameForIndex |
( |
int |
index | ) |
|
|
static |
Returns a unique name for the data Activity node at the given index in the Data Source List.
- Parameters
-
index | Index of the data Activity node in the Data Source List. |
- Returns
- Unique name for data Activity node at the given index.
◆ ActivitySourceProperty
◆ ActivityTemplateProperty
PropertyType<string> kanzi::DataDrivenExclusiveActivityHostConcept::ActivityTemplateProperty |
|
static |
◆ ActiveItemIndexProperty
PropertyType<int> kanzi::DataDrivenExclusiveActivityHostConcept::ActiveItemIndexProperty |
|
static |
The index of the active Activity in the Data-Driven Exclusive Activity Host node.
After instantiating all Activity nodes from a Data Source, this property refers to the only currently active Activity in the Data-Driven Exclusive Activity Host node. To deactivate all the Activities in an Activity Host node, set this property to -1. By default none of the Activity nodes are active, and the value of this index is -1.
- See also
- setActiveItemIndex(), getActiveItemIndex()
◆ s_activeDataActivityName
constexpr const char* kanzi::DataDrivenExclusiveActivityHostConcept::s_activeDataActivityName |
|
static |
Public name which Kanzi uses to refer to the currently and exclusively active data Activity node of a Data-Driven Exclusive Activity Host.
The Activity node with this name internally holds the data of the currently active item from the Data Source List.
◆ s_defaultActiveItemIndex
constexpr int kanzi::DataDrivenExclusiveActivityHostConcept::s_defaultActiveItemIndex |
|
static |
The documentation for this class was generated from the following file: