Kanzi  3.9.4
Kanzi Engine API
kanzi::Domain Class Reference

Domain binds Kanzi subsystems and objects together. More...

#include <kanzi/core.ui/domain/domain.hpp>

Inheritance diagram for kanzi::Domain:
[legend]

Public Types

using PluginHandler = function< ModuleSharedPtr(string_view, bool)>
 Type alias for plugin loading functionality. More...
 
using ThreadCreationCallback = function< void(string_view)>
 Type definition for the thread creation callback. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

void appendEventSource (EventSourceSharedPtr eventSource)
 Attach event source. More...
 
void appendGraphicsOutput (GraphicsOutputSharedPtr graphicsOutput)
 Attach graphics output. More...
 
void clearEventSources ()
 Removes all event sources. More...
 
void clearGraphicsOutputs ()
 Removes all graphics outputs. More...
 
void createPreviewTimeline ()
 Create preview timeline context. More...
 
void destroyPreviewTimeline ()
 Destroy preview timeline context. More...
 
void enableEditing (bool enable)
 Enables or disables editing mode. More...
 
ColorWorkflow getColorWorkflow () const
 Gets the currently configured ColorWorkflow. More...
 
CompositionManagergetCompositionManager () const
 
DebugRenderRegistrygetDebugRenderRegistry () const
 
EventSourceSharedPtr getEventSource (size_t index) const
 Access event sources. More...
 
size_t getEventSourceCount () const
 Access event source count. More...
 
FocusManagergetFocusManager () const
 Returns the domain's focus manager. More...
 
FontManagergetFontManager () const
 
GraphicsOutputSharedPtr getGraphicsOutput (size_t index) const
 Access graphics outputs. More...
 
size_t getGraphicsOutputCount () const
 Access graphics output count. More...
 
InputManagergetInputManager () const
 
InputMethodManagergetInputMethodManager () const
 Returns the input method manager of this domain. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 
detail::MessageDispatcher * getMessageDispatcher () const
 
ModulegetModule (string_view name)
 Get Module instance by the name it is registered with. More...
 
ObjectFactorygetObjectFactory () const
 
ObjectLoadergetObjectLoader () const
 
PatchingNotificationHandlerSharedPtr getPatchingNotificationHandler () const
 Gets the patching notification handler. More...
 
PreviewTimelinePlaybackSharedPtr getPreviewTimelinePlayback () const
 
DomainProfilerCollectiongetProfilers () const
 Access to the domain profiler objects. More...
 
RenderergetRenderer () const
 
Renderer3DgetRenderer3D () const
 
ResourceLoaderFactorygetResourceLoaderFactory () const
 
ResourceManagergetResourceManager () const
 
TimelineClockSharedPtr getRootTimelineClock () const
 
TaskDispatchergetTaskDispatcher () const
 Returns the task dispatcher of this domain. More...
 
TextManagergetTextManager () const
 
void initialize ()
 Initializes the domain. More...
 
bool isEditingEnabled () const
 
void loadPlugin (string_view url)
 Dynamically loads a plugin from a file. More...
 
void onThreadCreation (string_view name) const
 Notifies that Kanzi created a thread and the name of the thread. More...
 
void registerModule (string_view name, shared_ptr< Module > module)
 Register a Module. More...
 
template<typename TModule >
void registerModule (string_view name)
 Register a Module. More...
 
void registerPluginHandler (string_view protocol, PluginHandler handler)
 Registers a plugin handler for a given protocol. More...
 
void removeEventSource (size_t index)
 Remove event source. More...
 
void removeGraphicsOutput (size_t index)
 Remove graphics output. More...
 
void setColorWorkflow (ColorWorkflow colorWorkflow)
 Sets the ColorWorkflow that has been configured. More...
 
void setCompositionManager (unique_ptr< CompositionManager > compositionManager)
 Set composition manager. More...
 
void setMainLoopScheduler (MainLoopScheduler *mainLoopScheduler)
 
void setOnThreadCreation (ThreadCreationCallback callback)
 On thread creation, Kanzi calls the callback with the internal name that Kanzi assigns to the thread. More...
 
void setPatchingNotificationHandler (PatchingNotificationHandlerSharedPtr handler)
 Sets the patching notification handler. More...
 
KZ_NO_DISCARD bool tryLoadPlugin (string_view url)
 Attempts to dynamically load a plugin from a file. More...
 
void unregisterPluginHandler (string_view protocol)
 Unregisters existing plugin handler for a given protocol. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static Domaincreate ()
 
static DomaincreateEmpty ()
 Creates an uninitialized domain. More...
 
static void destroy (Domain *domain)
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

Properties
static PropertyType< string > ProjectPluginReferencesProperty
 ProjectPluginReferences property. More...
 
static PropertyType< bool > StateToolsEditStateEnabledProperty
 StateToolsEditStateEnabled property. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Domain binds Kanzi subsystems and objects together.

All objects and subsystems in Kanzi are associated with a domain when created. Objects in the same domain share access to the same subsystems. Objects from different domains cannot be used together.

Member Typedef Documentation

◆ PluginHandler

using kanzi::Domain::PluginHandler = function<ModuleSharedPtr(string_view, bool)>

Type alias for plugin loading functionality.

Parameters
urlURL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.
tryLoadingTrue if failures should be silent, i.e. exceptions should not be thrown.

◆ ThreadCreationCallback

using kanzi::Domain::ThreadCreationCallback = function<void(string_view )>

Type definition for the thread creation callback.

Parameters
nameKanzi name for the thread.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Domain::makeEditorInfo ( )
inlinestatic

◆ create()

static Domain* kanzi::Domain::create ( )
static

◆ createEmpty()

static Domain* kanzi::Domain::createEmpty ( )
static

Creates an uninitialized domain.

Use initialize() to initialize the returned object.

Returns
A new domain object.

◆ destroy()

static void kanzi::Domain::destroy ( Domain domain)
static

◆ initialize()

void kanzi::Domain::initialize ( )

Initializes the domain.

◆ getRenderer()

Renderer* kanzi::Domain::getRenderer ( ) const

◆ getRenderer3D()

Renderer3D* kanzi::Domain::getRenderer3D ( ) const

◆ getResourceManager()

ResourceManager* kanzi::Domain::getResourceManager ( ) const

◆ getResourceLoaderFactory()

ResourceLoaderFactory* kanzi::Domain::getResourceLoaderFactory ( ) const

◆ getMessageDispatcher()

detail::MessageDispatcher* kanzi::Domain::getMessageDispatcher ( ) const

◆ getTaskDispatcher()

TaskDispatcher* kanzi::Domain::getTaskDispatcher ( ) const

Returns the task dispatcher of this domain.

You can use the task dispatcher returned by this function to dispatch tasks that the system will execute on the thread of this domain.

See also
TaskDispatcher

◆ getInputManager()

InputManager* kanzi::Domain::getInputManager ( ) const

◆ getInputMethodManager()

InputMethodManager* kanzi::Domain::getInputMethodManager ( ) const

Returns the input method manager of this domain.

Returns
The input method manager of the domain.

◆ getFocusManager()

FocusManager* kanzi::Domain::getFocusManager ( ) const

Returns the domain's focus manager.

Returns
The focus manager of the domain.

◆ getFontManager()

FontManager* kanzi::Domain::getFontManager ( ) const

◆ getTextManager()

TextManager* kanzi::Domain::getTextManager ( ) const

◆ getObjectFactory()

ObjectFactory* kanzi::Domain::getObjectFactory ( ) const

◆ getObjectLoader()

ObjectLoader* kanzi::Domain::getObjectLoader ( ) const

◆ getRootTimelineClock()

TimelineClockSharedPtr kanzi::Domain::getRootTimelineClock ( ) const

◆ getPreviewTimelinePlayback()

PreviewTimelinePlaybackSharedPtr kanzi::Domain::getPreviewTimelinePlayback ( ) const

◆ getCompositionManager()

CompositionManager* kanzi::Domain::getCompositionManager ( ) const

◆ getDebugRenderRegistry()

DebugRenderRegistry* kanzi::Domain::getDebugRenderRegistry ( ) const

◆ setMainLoopScheduler()

void kanzi::Domain::setMainLoopScheduler ( MainLoopScheduler mainLoopScheduler)

◆ getMainLoopScheduler()

MainLoopScheduler* kanzi::Domain::getMainLoopScheduler ( ) const

◆ setPatchingNotificationHandler()

void kanzi::Domain::setPatchingNotificationHandler ( PatchingNotificationHandlerSharedPtr  handler)

Sets the patching notification handler.

Parameters
handlerThe patching notification handler to use for notifying about the patching events.

◆ getPatchingNotificationHandler()

PatchingNotificationHandlerSharedPtr kanzi::Domain::getPatchingNotificationHandler ( ) const

Gets the patching notification handler.

Returns
The patching notification handler.

◆ setCompositionManager()

void kanzi::Domain::setCompositionManager ( unique_ptr< CompositionManager compositionManager)

Set composition manager.

Will take ownership of composition manager passed.

Parameters
compositionManagerNew composition manager.

◆ registerModule() [1/2]

void kanzi::Domain::registerModule ( string_view  name,
shared_ptr< Module module 
)

Register a Module.

Parameters
nameName of the module.
moduleShared pointer to the module.

◆ registerModule() [2/2]

template<typename TModule >
void kanzi::Domain::registerModule ( string_view  name)
inline

Register a Module.

Template Parameters
TModuleThe module class.
Parameters
nameName of the module.

◆ getModule()

Module* kanzi::Domain::getModule ( string_view  name)

Get Module instance by the name it is registered with.

Parameters
nameName of the module.

◆ loadPlugin()

void kanzi::Domain::loadPlugin ( string_view  url)

Dynamically loads a plugin from a file.

Throws exceptions in cases of failure.

Parameters
urlURL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.

◆ tryLoadPlugin()

KZ_NO_DISCARD bool kanzi::Domain::tryLoadPlugin ( string_view  url)

Attempts to dynamically load a plugin from a file.

Does not throw exceptions in cases of failure.

Parameters
urlURL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.
Returns
False, if the loading fails. True, if the loading succeeds, or module of same name already exists.
Since
Kanzi 3.9.0

◆ registerPluginHandler()

void kanzi::Domain::registerPluginHandler ( string_view  protocol,
PluginHandler  handler 
)

Registers a plugin handler for a given protocol.

Parameters
protocolThe format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.
handlerA plugin handler that implements functionality for loading a plugin from the associated plugin file.
Since
Kanzi 3.9.0

◆ unregisterPluginHandler()

void kanzi::Domain::unregisterPluginHandler ( string_view  protocol)

Unregisters existing plugin handler for a given protocol.

Parameters
protocolThe format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.
Since
Kanzi 3.9.0

◆ enableEditing()

void kanzi::Domain::enableEditing ( bool  enable)
inline

Enables or disables editing mode.

Preview timeline will be created or destroyed depending on whether editing is enabled or not..

◆ isEditingEnabled()

bool kanzi::Domain::isEditingEnabled ( ) const
inline

◆ createPreviewTimeline()

void kanzi::Domain::createPreviewTimeline ( )

Create preview timeline context.

◆ destroyPreviewTimeline()

void kanzi::Domain::destroyPreviewTimeline ( )

Destroy preview timeline context.

◆ setColorWorkflow()

void kanzi::Domain::setColorWorkflow ( ColorWorkflow  colorWorkflow)
inline

Sets the ColorWorkflow that has been configured.

◆ getColorWorkflow()

ColorWorkflow kanzi::Domain::getColorWorkflow ( ) const
inline

Gets the currently configured ColorWorkflow.

◆ getGraphicsOutputCount()

size_t kanzi::Domain::getGraphicsOutputCount ( ) const

Access graphics output count.

Returns
Number of attached graphics outputs.

◆ getGraphicsOutput()

GraphicsOutputSharedPtr kanzi::Domain::getGraphicsOutput ( size_t  index) const

Access graphics outputs.

Parameters
indexIndex of the graphics output to access.
Returns
Shared pointer to the specified graphics output.

◆ appendGraphicsOutput()

void kanzi::Domain::appendGraphicsOutput ( GraphicsOutputSharedPtr  graphicsOutput)

Attach graphics output.

Parameters
graphicsOutputShared pointer to the graphics output to attach.

◆ removeGraphicsOutput()

void kanzi::Domain::removeGraphicsOutput ( size_t  index)

Remove graphics output.

Parameters
indexIndex of the graphics output to remove.

◆ clearGraphicsOutputs()

void kanzi::Domain::clearGraphicsOutputs ( )

Removes all graphics outputs.

◆ getEventSourceCount()

size_t kanzi::Domain::getEventSourceCount ( ) const

Access event source count.

Returns
Number of attached event sources.

◆ getEventSource()

EventSourceSharedPtr kanzi::Domain::getEventSource ( size_t  index) const

Access event sources.

Parameters
indexIndex of the event source to access.
Returns
Shared pointer to the specified event source.

◆ appendEventSource()

void kanzi::Domain::appendEventSource ( EventSourceSharedPtr  eventSource)

Attach event source.

Parameters
eventSourceShared pointer to the event source to attach.

◆ removeEventSource()

void kanzi::Domain::removeEventSource ( size_t  index)

Remove event source.

Parameters
indexIndex of the event source to remove.

◆ clearEventSources()

void kanzi::Domain::clearEventSources ( )

Removes all event sources.

◆ getProfilers()

DomainProfilerCollection* kanzi::Domain::getProfilers ( ) const
inline

Access to the domain profiler objects.

Returns
The domain profiler collection.

◆ setOnThreadCreation()

void kanzi::Domain::setOnThreadCreation ( ThreadCreationCallback  callback)
inline

On thread creation, Kanzi calls the callback with the internal name that Kanzi assigns to the thread.

◆ onThreadCreation()

void kanzi::Domain::onThreadCreation ( string_view  name) const
inline

Notifies that Kanzi created a thread and the name of the thread.

Kanzi calls this function on the created thread, and you can use it for thread-specific startup.

Parameters
nameThread name to set natively and pass to callback.

Member Data Documentation

◆ ProjectPluginReferencesProperty

PropertyType<string> kanzi::Domain::ProjectPluginReferencesProperty
static

ProjectPluginReferences property.

The default value is "".

See also
setProjectPluginReferences(), getProjectPluginReferences()

◆ StateToolsEditStateEnabledProperty

PropertyType<bool> kanzi::Domain::StateToolsEditStateEnabledProperty
static

StateToolsEditStateEnabled property.

The default value is false.

See also
setStateToolsEditStateEnabled(), isStateToolsEditStateEnabled()

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