Base class for Activity classes. More...

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

Inheritance diagram for kanzi::ActivityConcept:

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
	KZ_METACLASS_PROPERTY_TYPE (StatusManagerProperty)

	KZ_METACLASS_PROPERTY_TYPE (DummyStateManagerProperty)

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

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< DeactivateInternalMessageArguments >	DeactivateInternalMessage
	Internal message sent by an activity host to the activity to deactivate the activity. More...

static MessageType< ActivityBaseArguments >	FinishedExclusiveDeactivatingAnimationInternalMessage
	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< ActivityBaseArguments >	FinishedParallelActivatingAnimationInternalMessage
	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< ActivityBaseArguments >	FinishedParallelDeactivatingAnimationInternalMessage
	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< ActivityBaseArguments >	PrefabAttachedMessage
	Informs when Kanzi attaches the prefab of this Activity node. More...

static MessageType< ActivityBaseArguments >	PrefabDetachedMessage
	Informs when Kanzi detaches the prefab of this Activity node. More...

static MessageType< ActivityBaseArguments >	ReadyForActivationAnimationInternalMessage
	Internal message sent by the activity to its parent host when the activity has finished initializing its resources. More...

static MessageType< StartActivationInternalMessageArguments >	StartActivationInternalMessage
	Internal message sent by an activity host to the activity to initialize the resources of the activity. More...

static MessageType< ActivityConceptInternalArguments >	StartExclusiveActivatingAnimationInternalMessage
	Internal message sent by an activity host to the activity to start the exclusive activation animation of the activity. More...

static MessageType< ActivityConceptInternalArguments >	StartExclusiveDeactivatingAnimationInternalMessage
	Internal message sent by an activity host to the activity to start the exclusive deactivation animation of the activity. More...

static MessageType< ActivityConceptInternalArguments >	StartParallelActivatingAnimationInternalMessage
	Internal message sent by an activity host to the activity to start the parallel activation animation of the activity. More...

static MessageType< ActivityConceptInternalArguments >	StartParallelDeactivatingAnimationInternalMessage
	Internal message sent by an activity host to the activity to start the parallel deactivation animation of the activity. More...

static MessageType< StatusChangedMessageArguments >	StatusChangedMessage
	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< Status >	StatusProperty

static PropertyType< ResourceSharedPtr >	StatusManagerProperty
	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...

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

enum kanzi::ActivityConcept::Status

strong

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

virtual kanzi::ActivityConcept::~ActivityConcept ( )

virtualdefault

Destructor.

Member Function Documentation

kanzi::ActivityConcept::KZ_METACLASS_PROPERTY_TYPE ( StatusManagerProperty )

kanzi::ActivityConcept::KZ_METACLASS_PROPERTY_TYPE ( DummyStateManagerProperty )

static PropertyTypeEditorInfoSharedPtr kanzi::ActivityConcept::makeEditorInfo ( )

static

Member Data Documentation

PropertyType<Status> kanzi::ActivityConcept::StatusProperty

static

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.

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.

MessageType<StatusChangedMessageArguments> kanzi::ActivityConcept::StatusChangedMessage

static

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

MessageType<StartActivationInternalMessageArguments> kanzi::ActivityConcept::StartActivationInternalMessage

static

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

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::ReadyForActivationAnimationInternalMessage

static

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

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.

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.

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.

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.

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.

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.

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.

MessageType<DeactivateInternalMessageArguments> kanzi::ActivityConcept::DeactivateInternalMessage

static

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

MessageType<ActivityBaseArguments> kanzi::ActivityConcept::PrefabAttachedMessage

static

Informs when Kanzi attaches the prefab of this Activity node.

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:

kanzi/ui/node/concept/activity/activity_concept.hpp


Kanzi Engine API

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation