Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::DataDrivenExclusiveActivityHostConcept Class Referenceabstract

Base class for the Data-Driven Exclusive Activity Host classes. More...

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

Inheritance diagram for kanzi::DataDrivenExclusiveActivityHostConcept:
[legend]

Public Member Functions

int getActiveItemIndex () const
 Gets the value of the ActiveItemIndexProperty. More...
 
ResourceSharedPtr getActivitySource () const
 Gets the value of the ActivitySourceProperty. More...
 
string getActivityTemplate () const
 Gets the value of the ActivityTemplateProperty. More...
 
virtual NodegetNode ()=0
 Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance. More...
 
virtual const NodegetNode () const =0
 Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance. More...
 
void setActiveItemIndex (int value)
 Sets the value of the ActiveItemIndexProperty. More...
 
void setActivitySource (ResourceSharedPtr value)
 Sets the value of the ActivitySourceProperty. More...
 
void setActivityTemplate (string prefabUrl)
 Sets the value of the ActivityTemplateProperty. More...
 
virtual ~DataDrivenExclusiveActivityHostConcept ()=default
 Destructor. More...
 

Static Public Member Functions

static string getNameForIndex (int index)
 Returns a unique name for the data Activity node at the given index in the Data Source List. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Returns PropertyType editor info of exclusive activity concept. More...
 

Static Public Attributes

static constexpr const char * s_activeDataActivityName
 Public name which Kanzi uses to refer to the currently and exclusively active data Activity node of a Data-Driven Exclusive Activity Host. More...
 
static constexpr int s_defaultActiveItemIndex
 The default value of the DataDrivenExclusiveActivityHostConcept::ActiveItemIndexProperty. More...
 
Properties
static PropertyType< ResourceSharedPtrActivitySourceProperty
 Sets the DataObject that provides the data for Activity nodes of a Data-Driven Exclusive Activity Host. More...
 
static PropertyType< string > ActivityTemplateProperty
 Sets the prefab template that a Data-Driven Exclusive Activity Host uses for Activity nodes that it creates. More...
 
static PropertyType< int > ActiveItemIndexProperty
 The index of the active Activity in the Data-Driven Exclusive Activity Host node. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~DataDrivenExclusiveActivityHostConcept()

virtual kanzi::DataDrivenExclusiveActivityHostConcept::~DataDrivenExclusiveActivityHostConcept ( )
virtualdefault

Destructor.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::DataDrivenExclusiveActivityHostConcept::makeEditorInfo ( )
static

Returns PropertyType editor info of exclusive activity concept.

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ getActivitySource()

ResourceSharedPtr kanzi::DataDrivenExclusiveActivityHostConcept::getActivitySource ( ) const

Gets the value of the ActivitySourceProperty.

See also
setActivitySource()

◆ setActivitySource()

void kanzi::DataDrivenExclusiveActivityHostConcept::setActivitySource ( ResourceSharedPtr  value)

Sets the value of the ActivitySourceProperty.

See also
getActivitySource()

◆ getActivityTemplate()

string kanzi::DataDrivenExclusiveActivityHostConcept::getActivityTemplate ( ) const

Gets the value of the ActivityTemplateProperty.

See also
setActivityTemplate()

◆ setActivityTemplate()

void kanzi::DataDrivenExclusiveActivityHostConcept::setActivityTemplate ( string  prefabUrl)

Sets the value of the ActivityTemplateProperty.

See also
getActivityTemplate()

◆ getActiveItemIndex()

int kanzi::DataDrivenExclusiveActivityHostConcept::getActiveItemIndex ( ) const

Gets the value of the ActiveItemIndexProperty.

See also
setActiveItemIndex()

◆ setActiveItemIndex()

void kanzi::DataDrivenExclusiveActivityHostConcept::setActiveItemIndex ( int  value)

Sets the value of the ActiveItemIndexProperty.

See also
getActiveItemIndex()

◆ 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
indexIndex of the data Activity node in the Data Source List.
Returns
Unique name for data Activity node at the given index.

Member Data Documentation

◆ ActivitySourceProperty

PropertyType<ResourceSharedPtr> kanzi::DataDrivenExclusiveActivityHostConcept::ActivitySourceProperty
static

Sets the DataObject that provides the data for Activity nodes of a Data-Driven Exclusive Activity Host.

The default value is ResourceSharedPtr().

See also
setActivitySource(), getActivitySource()

◆ ActivityTemplateProperty

PropertyType<string> kanzi::DataDrivenExclusiveActivityHostConcept::ActivityTemplateProperty
static

Sets the prefab template that a Data-Driven Exclusive Activity Host uses for Activity nodes that it creates.

The default value is "".

See also
setActivityTemplate(), getActivityTemplate()

◆ 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 default value of the DataDrivenExclusiveActivityHostConcept::ActiveItemIndexProperty.

Set the DataDrivenExclusiveActivityHostConcept::ActiveItemIndexProperty to this value to deactivate all the Activities in a Data-Driven Exclusive Activity Host.


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