Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::ActivityConcept Class Reference

Base class for Activity classes. More...

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

Inheritance diagram for kanzi::ActivityConcept:
[legend]

Classes

class  ActivityBaseArguments
 Base class for the Activity message argument classes. More...
 
class  ActivityConceptInternalArguments
 Base class for the Activity Concept message argument classes. More...
 
class  DeactivateInternalMessageArguments
 Message arguments for the DeactivateInternal message. More...
 
class  StartActivationInternalMessageArguments
 Message arguments for the StartActivationInternal message. More...
 
class  StatusChangedMessageArguments
 Message arguments for the StatusChanged message. More...
 

Public Types

enum  Status { Status::Active, Status::Inactive, Status::Activating, Status::Deactivating }
 Defines possible states of an Activity node. More...
 

Public Member Functions

virtual ~ActivityConcept ()=default
 Destructor. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static MessageType< DeactivateInternalMessageArgumentsDeactivateInternalMessage
 Internal message sent by an activity host to the activity to deactivate the activity. More...
 
static MessageType< ActivityBaseArgumentsFinishedExclusiveDeactivatingAnimationInternalMessage
 Internal message sent by the activity to its parent host when the activity has finished the exclusive deactivation animation of the activity. More...
 
static MessageType< ActivityBaseArgumentsFinishedParallelActivatingAnimationInternalMessage
 Internal message sent by the activity to its parent host when the activity has finished the parallel activation animation of the activity. More...
 
static MessageType< ActivityBaseArgumentsFinishedParallelDeactivatingAnimationInternalMessage
 Internal message sent by the activity to its parent host when the activity has finished the parallel deactivation animation of the activity. More...
 
static MessageType< ActivityBaseArgumentsPrefabAttachedMessage
 Informs when Kanzi attaches the prefab of this Activity node. More...
 
static MessageType< ActivityBaseArgumentsPrefabDetachedMessage
 Informs when Kanzi detaches the prefab of this Activity node. More...
 
static MessageType< ActivityBaseArgumentsReadyForActivationAnimationInternalMessage
 Internal message sent by the activity to its parent host when the activity has finished initializing its resources. More...
 
static MessageType< StartActivationInternalMessageArgumentsStartActivationInternalMessage
 Internal message sent by an activity host to the activity to initialize the resources of the activity. More...
 
static MessageType< ActivityConceptInternalArgumentsStartExclusiveActivatingAnimationInternalMessage
 Internal message sent by an activity host to the activity to start the exclusive activation animation of the activity. More...
 
static MessageType< ActivityConceptInternalArgumentsStartExclusiveDeactivatingAnimationInternalMessage
 Internal message sent by an activity host to the activity to start the exclusive deactivation animation of the activity. More...
 
static MessageType< ActivityConceptInternalArgumentsStartParallelActivatingAnimationInternalMessage
 Internal message sent by an activity host to the activity to start the parallel activation animation of the activity. More...
 
static MessageType< ActivityConceptInternalArgumentsStartParallelDeactivatingAnimationInternalMessage
 Internal message sent by an activity host to the activity to start the parallel deactivation animation of the activity. More...
 
static MessageType< StatusChangedMessageArgumentsStatusChangedMessage
 You can subscribe to this message to receive notifications when the Status of this activity changes. More...
 
Properties

Specifies the status of this activity.

static PropertyType< StatusStatusProperty
 
static PropertyType< ResourceSharedPtrStatusManagerProperty
 Specifies the State Manager that handles the Status property changes. More...
 
static PropertyType< float > DummyStateManagerProperty
 Lack of a queuing mechanism for incoming messages from an Activity Host node can cause Kanzi to enter a recursive call in the setProperty(). More...
 
static PropertyType< bool > ActivatedByActivationModifierProperty
 Specifies whether the activation of an Activity node is requested by modifier bindings callbacks of an ApplyAction of a DataTrigger. More...
 
static PropertyType< bool > SaveLastFocusedNodeProperty
 Indicates whether to serialize the last focused child node of a focus scope Activity and restore the focus on deserialization. More...
 

Detailed Description

Base class for Activity classes.

This class defines common types, properties, and messages for Activity classes.

See also
Activity2D, Activity3D

Member Enumeration Documentation

◆ Status

Defines possible states of an Activity node.

Activity Host nodes can activate and deactivate their child Activity nodes. This enumeration defines the possible states of an Activity node during the the process of activation and deactivation. You can use this functionality to react to changes in Activity node status in your application code and in Kanzi Studio.

See also
Activity, StatusProperty
Enumerator
Active 

The Activity node is active.

In an Exclusive Activity Host node only one child Activity node can be in the Active state at a time. In a Parallel Activity Host node more than one Activity node can be in the Active state at the same time, therefore any Activity node can be in any state.

Inactive 

The Activity node is inactive.

Inactive Activity nodes do not show their content.

Activating 

The Activity is transitioning into the active state.

In an Exclusive Activity Host node while one Activity node is in Activating state, another Activity node can be in the Deactivating state at the same time. In a Parallel Activity Host node more than one Activity node can be in the Active state at the same time, therefore any Activity node can be in any state.

Deactivating 

The Activity is transitioning into the inactive state.

In an Exclusive Activity Host node while one Activity is in Deactivating state, another Activity node can at the same time be in the Activating state. In a Parallel Activity Host node more than one Activity node can be in the Active state at the same time, therefore any Activity node can be in any state.

Constructor & Destructor Documentation

◆ ~ActivityConcept()

virtual kanzi::ActivityConcept::~ActivityConcept ( )
virtualdefault

Destructor.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ActivityConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ StatusProperty

PropertyType<Status> kanzi::ActivityConcept::StatusProperty
static

◆ StatusManagerProperty

PropertyType<ResourceSharedPtr> kanzi::ActivityConcept::StatusManagerProperty
static

Specifies the State Manager that handles the Status property changes.

The activity will monitor transitions in this state manager to know when to progress status changes.

◆ DummyStateManagerProperty

PropertyType<float> kanzi::ActivityConcept::DummyStateManagerProperty
static

Lack of a queuing mechanism for incoming messages from an Activity Host node can cause Kanzi to enter a recursive call in the setProperty().

A temporary solution to this is the StatusManagerProperty that Kanzi sets in states with different values, and adds an any-to-any transition with the duration of 1 millisecond.

◆ ActivatedByActivationModifierProperty

PropertyType<bool> kanzi::ActivityConcept::ActivatedByActivationModifierProperty
static

Specifies whether the activation of an Activity node is requested by modifier bindings callbacks of an ApplyAction of a DataTrigger.

Kanzi uses this property internally to disable serialization and deserialization of the activation status for such Activity nodes.

Since
Kanzi 3.9.0

◆ SaveLastFocusedNodeProperty

PropertyType<bool> kanzi::ActivityConcept::SaveLastFocusedNodeProperty
static

Indicates whether to serialize the last focused child node of a focus scope Activity and restore the focus on deserialization.

If an Activity or Activity Host is a focus scope, add and set this property to True when you want to save and restore the focus from serialized Activities and Activity Host in that focus scope.

Since
Kanzi 3.9.0

◆ StatusChangedMessage

MessageType<StatusChangedMessageArguments> kanzi::ActivityConcept::StatusChangedMessage
static

You can subscribe to this message to receive notifications when the Status of this activity changes.

◆ StartActivationInternalMessage

MessageType<StartActivationInternalMessageArguments> kanzi::ActivityConcept::StartActivationInternalMessage
static

Internal message sent by an activity host to the activity to initialize the resources of the activity.

◆ ReadyForActivationAnimationInternalMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::ReadyForActivationAnimationInternalMessage
static

Internal message sent by the activity to its parent host when the activity has finished initializing its resources.

◆ StartParallelActivatingAnimationInternalMessage

MessageType<ActivityConceptInternalArguments> kanzi::ActivityConcept::StartParallelActivatingAnimationInternalMessage
static

Internal message sent by an activity host to the activity to start the parallel activation animation of the activity.

◆ FinishedParallelActivatingAnimationInternalMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::FinishedParallelActivatingAnimationInternalMessage
static

Internal message sent by the activity to its parent host when the activity has finished the parallel activation animation of the activity.

◆ StartExclusiveActivatingAnimationInternalMessage

MessageType<ActivityConceptInternalArguments> kanzi::ActivityConcept::StartExclusiveActivatingAnimationInternalMessage
static

Internal message sent by an activity host to the activity to start the exclusive activation animation of the activity.

◆ StartExclusiveDeactivatingAnimationInternalMessage

MessageType<ActivityConceptInternalArguments> kanzi::ActivityConcept::StartExclusiveDeactivatingAnimationInternalMessage
static

Internal message sent by an activity host to the activity to start the exclusive deactivation animation of the activity.

◆ FinishedExclusiveDeactivatingAnimationInternalMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::FinishedExclusiveDeactivatingAnimationInternalMessage
static

Internal message sent by the activity to its parent host when the activity has finished the exclusive deactivation animation of the activity.

◆ StartParallelDeactivatingAnimationInternalMessage

MessageType<ActivityConceptInternalArguments> kanzi::ActivityConcept::StartParallelDeactivatingAnimationInternalMessage
static

Internal message sent by an activity host to the activity to start the parallel deactivation animation of the activity.

◆ FinishedParallelDeactivatingAnimationInternalMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::FinishedParallelDeactivatingAnimationInternalMessage
static

Internal message sent by the activity to its parent host when the activity has finished the parallel deactivation animation of the activity.

◆ DeactivateInternalMessage

MessageType<DeactivateInternalMessageArguments> kanzi::ActivityConcept::DeactivateInternalMessage
static

Internal message sent by an activity host to the activity to deactivate the activity.

◆ PrefabAttachedMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::PrefabAttachedMessage
static

Informs when Kanzi attaches the prefab of this Activity node.

◆ PrefabDetachedMessage

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::PrefabDetachedMessage
static

Informs when Kanzi detaches the prefab of this Activity node.


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