kanzi::ActivityBrowserController Class Reference

ActivityBrowserController is an interface class for implementing runtime data exchange between the Kanzi Studio Preview and the ActivityBrowser Kanzi Studio plugin. More...

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

Inheritance diagram for kanzi::ActivityBrowserController:

Classes
class	ForceTriggerMessageArguments
	Message arguments for the ForceTriggerMessage. More...
class	NodeInfoTreeAvailableArguments
	Message arguments for the NodeInfoTreeAvailableMessage. More...

Public Types
using	ActivityID = uint32_t
	The type of the unique ID that the ActivityBrowserController assigns to each Activity node. More...

Public Member Functions
virtual optional< ActivityID >	getActivityID (string_view path)=0
	Returns the ID of an Activity node. More...
virtual void	registerRoot (NodeSharedPtr rootNode)=0
	Registers an ActivityElement node as the root node in the Activity Browser. More...
virtual void	unregisterRoot (NodeSharedPtr rootNode)=0
	Unregisters a registered ActivityElement node in the Activity Browser. More...
virtual void	updatePrefabPathProperty (ActivityID activityID, Node &sourceNode)=0
	Updates the ActivityConcept::PrefabPathProperty of an Activity node in the Activity Browser. More...
virtual void	updateProperties (ActivityID activityID, Node &sourceNode)=0
	Updates the properties of an Activity node in the Activity Browser. More...
virtual void	updateTreeDescriptionToCurrentActivityInfoRoot ()=0
	Updates the information tree of the Activity Browser. More...
	~ActivityBrowserController () override=default
	Destructor. More...
Public Member Functions inherited from kanzi::PatchingNotificationHandler
virtual void	onPatchingFinished ()=0
	The domain calls this function when patching ends. More...
virtual void	onPatchingStarted ()=0
	The domain calls this function when patching starts. More...
void	setKzbFile (KzbFile *kzbFile)
	Sets the kzb patch file to apply. More...
virtual	~PatchingNotificationHandler ()=default
	Destructor. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< ForceTriggerMessageArguments >	ForceTriggerMessage
	The message that the ActivityBrowserController sends to an Activity node to execute a trigger. More...
static MessageType< NodeInfoTreeAvailableArguments >	NodeInfoTreeAvailableMessage
	The message that the ActivityBrowserController sends to an Activity node to connect to the editing data. More...

Additional Inherited Members
Protected Attributes inherited from kanzi::PatchingNotificationHandler
KzbFile *	m_kzbFile
	The kzb patch file to apply. More...

Detailed Description

ActivityBrowserController is an interface class for implementing runtime data exchange between the Kanzi Studio Preview and the ActivityBrowser Kanzi Studio plugin.

This class provides the methods, messages, and properties that Activity nodes and Activity Host nodes use to communicate with the ActivityBrowser plugin.

Member Typedef Documentation

ActivityID

using kanzi::ActivityBrowserController::ActivityID = uint32_t

The type of the unique ID that the ActivityBrowserController assigns to each Activity node.

Constructor & Destructor Documentation

~ActivityBrowserController()

kanzi::ActivityBrowserController::~ActivityBrowserController ( )

overridedefault

Destructor.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ActivityBrowserController::makeEditorInfo ( )

static

getActivityID()

virtual optional<ActivityID> kanzi::ActivityBrowserController::getActivityID ( string_view  path )

pure virtual

Returns the ID of an Activity node.

Parameters

path	The path to the Activity node.

Returns

Returns the ID of the Activity node. If the function cannot find the Activity node, returns nullopt.

registerRoot()

virtual void kanzi::ActivityBrowserController::registerRoot ( NodeSharedPtr  rootNode )

pure virtual

Registers an ActivityElement node as the root node in the Activity Browser.

Parameters

rootNode

The topmost ActivityElement node in the node hierarchy.

unregisterRoot()

virtual void kanzi::ActivityBrowserController::unregisterRoot ( NodeSharedPtr  rootNode )

pure virtual

Unregisters a registered ActivityElement node in the Activity Browser.

Parameters

rootNode

The topmost ActivityElement node in the node hierarchy that is going to be unregistered.

updateTreeDescriptionToCurrentActivityInfoRoot()

virtual void kanzi::ActivityBrowserController::updateTreeDescriptionToCurrentActivityInfoRoot ( )

pure virtual

Updates the information tree of the Activity Browser.

updateProperties()

virtual void kanzi::ActivityBrowserController::updateProperties ( ActivityID  activityID, Node &  sourceNode  )

pure virtual

Updates the properties of an Activity node in the Activity Browser.

Parameters

activityID	The ID of the Activity node to update.
sourceNode	The Activity node to update.

updatePrefabPathProperty()

virtual void kanzi::ActivityBrowserController::updatePrefabPathProperty ( ActivityID  activityID, Node &  sourceNode  )

pure virtual

Updates the ActivityConcept::PrefabPathProperty of an Activity node in the Activity Browser.

Parameters

activityID	The ID of the Activity node to update.
sourceNode	The Activity node to update.

Member Data Documentation

ForceTriggerMessage

MessageType<ForceTriggerMessageArguments> kanzi::ActivityBrowserController::ForceTriggerMessage

static

The message that the ActivityBrowserController sends to an Activity node to execute a trigger.

NodeInfoTreeAvailableMessage

MessageType<NodeInfoTreeAvailableArguments> kanzi::ActivityBrowserController::NodeInfoTreeAvailableMessage

static

The message that the ActivityBrowserController sends to an Activity node to connect to the editing data.

---

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

• kanzi/ui/node/concept/activity/activity_browser_controller.hpp