kanzi::Domain Class Reference

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

#include <kanzi/domain/domain.hpp>

Public Member Functions
KzcMemoryManager *	getMemoryManager () const
KzuPropertyManager *	getPropertyManager () const
ResourceManager *	getResourceManager () const
KzuMessageDispatcher *	getMessageDispatcher () const
KzuTaskScheduler *	getTaskScheduler () const
KzuTextRenderer *	getTextRenderer () const
ObjectFactory *	getObjectFactory () const
TimelineClockSharedPtr	getRootTimelineClock () const
ScriptingSystemSharedPtr	getScriptingSystem () const
void	setScriptingSystem (ScriptingSystemSharedPtr scriptingSystem)
void	registerModule (string_view moduleName, shared_ptr< Module > module)
template<typename TModule >
void	registerModule (string_view moduleName)
Module *	getModule (string_view moduleName)
void	loadPlugin (string moduleName)
KzuAnimationPlayer *	getRootAnimationPlayer () const
void	setRootAnimationPlayer (KzuAnimationPlayer *animationPlayer)
KzuAnimationPlayer *	getScrubabbleAnimationPlayer () const
void	setScrubbableAnimationPlayer (KzuAnimationPlayer *animationPlayer)
void	enableEditing (bool enable)
bool	isEditingEnabled () const

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
static Domain *	create (const KzcMemoryManager *memoryManager, KzuPropertyManager *propertyManager, ResourceManager *resourceManager, KzuMessageDispatcher *messageDispatcher, KzuTaskScheduler *taskScheduler, KzuTextRenderer *textRenderer, ObjectFactory *objectFactory)
static void	destroy (Domain *domain)

Static Public Attributes
Properties
static PropertyType< bool >	HalfFloatTextureFormatProperty
	HalfFloatTextureFormat property. More...
static PropertyType< bool >	HalfFloatColorAttachmentProperty
	HalfFloatColorAttachment property. More...
static PropertyType< bool >	ExternalTextureProperty
	ExternalTexture property. More...
static PropertyType< string >	ProjectPluginReferencesProperty
	ProjectPluginReferences property. More...
static PropertyType< string >	StartupScreenProperty
	StartupScreen property. More...
static PropertyType< bool >	StateToolsEditStateEnabledProperty
	StateToolsEditStateEnabled property. More...
static PropertyType< ColorRGBA >	PreviewWindowBackgroundColorProperty
	PreviewWindowBackgroundColor property. More...
static PropertyType< int >	MessageLimitPerFrameProperty
	MessageLimitPerFrame property. More...

Static Protected Member Functions
static kzsError	timelineClockTask (kzUint deltaTime, void *userData, kzBool *out_done)

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 Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::Domain::makeEditorInfo ( )

inlinestatic

static Domain* kanzi::Domain::create ( const KzcMemoryManager *  memoryManager, KzuPropertyManager *  propertyManager, ResourceManager *  resourceManager, KzuMessageDispatcher *  messageDispatcher, KzuTaskScheduler *  taskScheduler, KzuTextRenderer *  textRenderer, ObjectFactory *  objectFactory  )

static

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

static

KzcMemoryManager* kanzi::Domain::getMemoryManager

(

)

const

KzuPropertyManager* kanzi::Domain::getPropertyManager

(

)

const

ResourceManager* kanzi::Domain::getResourceManager

(

)

const

KzuMessageDispatcher* kanzi::Domain::getMessageDispatcher

(

)

const

KzuTaskScheduler* kanzi::Domain::getTaskScheduler

(

)

const

KzuTextRenderer* kanzi::Domain::getTextRenderer

(

)

const

ObjectFactory* kanzi::Domain::getObjectFactory

(

)

const

TimelineClockSharedPtr kanzi::Domain::getRootTimelineClock

(

)

const

ScriptingSystemSharedPtr kanzi::Domain::getScriptingSystem

(

)

const

void kanzi::Domain::setScriptingSystem

(

ScriptingSystemSharedPtr

scriptingSystem

)

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

template<typename TModule >

void kanzi::Domain::registerModule ( string_view  moduleName )

inline

Module* kanzi::Domain::getModule

(

string_view

moduleName

)

void kanzi::Domain::loadPlugin

(

string

moduleName

)

KzuAnimationPlayer* kanzi::Domain::getRootAnimationPlayer ( ) const

inline

void kanzi::Domain::setRootAnimationPlayer ( KzuAnimationPlayer *  animationPlayer )

inline

KzuAnimationPlayer* kanzi::Domain::getScrubabbleAnimationPlayer ( ) const

inline

void kanzi::Domain::setScrubbableAnimationPlayer ( KzuAnimationPlayer *  animationPlayer )

inline

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

inline

bool kanzi::Domain::isEditingEnabled ( ) const

inline

static kzsError kanzi::Domain::timelineClockTask ( kzUint  deltaTime, void *  userData, kzBool *  out_done  )

staticprotected

Member Data Documentation

PropertyType<bool> kanzi::Domain::HalfFloatTextureFormatProperty

static

HalfFloatTextureFormat property.

The default value is false.

See also

setHalfFloatTextureFormat(), isHalfFloatTextureFormat()

PropertyType<bool> kanzi::Domain::HalfFloatColorAttachmentProperty

static

HalfFloatColorAttachment property.

The default value is false.

See also

setHalfFloatColorAttachment(), isHalfFloatColorAttachment()

PropertyType<bool> kanzi::Domain::ExternalTextureProperty

static

ExternalTexture property.

The default value is false.

See also

setExternalTexture(), isExternalTexture()

PropertyType<string> kanzi::Domain::ProjectPluginReferencesProperty

static

ProjectPluginReferences property.

The default value is "".

See also

setProjectPluginReferences(), getProjectPluginReferences()

PropertyType<string> kanzi::Domain::StartupScreenProperty

static

StartupScreen property.

The default value is "".

See also

setStartupScreen(), getStartupScreen()

PropertyType<bool> kanzi::Domain::StateToolsEditStateEnabledProperty

static

StateToolsEditStateEnabled property.

The default value is false.

See also

setStateToolsEditStateEnabled(), isStateToolsEditStateEnabled()

PropertyType<ColorRGBA> kanzi::Domain::PreviewWindowBackgroundColorProperty

static

PreviewWindowBackgroundColor property.

The default value is ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f).

See also

setPreviewWindowBackgroundColor(), getPreviewWindowBackgroundColor()

PropertyType<int> kanzi::Domain::MessageLimitPerFrameProperty

static

MessageLimitPerFrame property.

The default value is 1000.

See also

setMessageLimitPerFrame(), getMessageLimitPerFrame()

---

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

• kanzi/domain/domain.hpp