Transition collection is used to define transitions within a Page Host. More...

#include <kanzi/ui/node/page_transition_collection.hpp>

Inheritance diagram for kanzi::PageTransitionCollection:

Classes
class	Runtime
	Runtime class that is instantiated per page. Drives the internal state manager that is used to animate transitions. More...

class	Transition
	Describes transition from one page to another. More...

class	TransitionAnimation
	Entry in transition animation array. More...

Public Types
typedef shared_ptr< TransitionAnimation >	TransitionAnimationSharedPtr
	Shared ptr declaration for transition animation. More...

typedef vector< TransitionAnimationSharedPtr >	TransitionAnimationContainer
	Container class for transition animations. More...

typedef shared_ptr< Transition >	TransitionSharedPtr
	Shared ptr declaration for transition definition. More...

typedef vector< TransitionSharedPtr >	TransitionContainer
	Container & iterator types for transitions. More...

typedef TransitionContainer::const_iterator	TransitionConstIterator

typedef shared_ptr< Runtime >	RuntimeSharedPtr

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
virtual	~PageTransitionCollection () KZ_OVERRIDE

void	addTransition (TransitionSharedPtr transition)
	Add transition to transition group, needs to be called before transition group is attached to scene graph. More...

void	removeTransition (TransitionSharedPtr transition)
	Remove transition from transition group, needs to be called before transition group is attached to scene graph. More...

TransitionConstIterator	beginTransitions () const
	Returns iterator to start of the transition container. More...

TransitionConstIterator	endTransitions () const
	Returns iterator to end of the transition container. More...

TransitionSharedPtr	findTransition (string_view source, string_view target)
	Finds matching transition definition for given parameters, falls back to default. More...

RuntimeSharedPtr	attach (Page *node)
	Attach transitions to Page component. More...

virtual void	loadFromKZB (const KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Function for loading the resource from .KZB. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

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 >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. 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...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

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...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static PageTransitionCollectionSharedPtr	create (Domain *domain, string_view name="")

static void	detach (RuntimeSharedPtr transitionGroupRuntime)
	Detach transitions from Page component. More...

static PageTransitionCollectionSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads page transition collection from KZB and returns it. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
Properties
static PropertyType< int >	PageTransitionDurationProperty
	PageTransitionDuration property. More...

static PropertyType< string >	PageTransitionFromProperty
	PageTransitionFrom property. More...

static PropertyType< string >	PageTransitionToProperty
	PageTransitionTo property. More...

static PropertyType< PageTransitionCollection::Transition::Direction >	PageTransitionDirectionProperty
	PageTransitionDirection property. More...

static PropertyType< string >	PageTransitionAnimationPropertyTypeProperty
	PageTransitionAnimationPropertyType property. More...

static PropertyType< PageTransitionCollection::Transition::AnimationTarget >	PageTransitionAnimationAnimationTargetProperty
	PageTransitionAnimationAnimationTarget property. More...

static PropertyType< string >	PageTransitionAnimationStartValueProperty
	PageTransitionAnimationStartValue property. More...

static PropertyType< string >	PageTransitionAnimationEndValueProperty
	PageTransitionAnimationEndValue property. More...

Protected Member Functions
	PageTransitionCollection (Domain *domain, string_view name="")

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Copy local value from property storage. More...

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Friends
class	ResourceManager

class	Page

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Transition collection is used to define transitions within a Page Host.

Member Typedef Documentation

typedef shared_ptr<TransitionAnimation> kanzi::PageTransitionCollection::TransitionAnimationSharedPtr

Shared ptr declaration for transition animation.

typedef vector<TransitionAnimationSharedPtr> kanzi::PageTransitionCollection::TransitionAnimationContainer

Container class for transition animations.

typedef shared_ptr<Transition> kanzi::PageTransitionCollection::TransitionSharedPtr

Shared ptr declaration for transition definition.

typedef vector<TransitionSharedPtr> kanzi::PageTransitionCollection::TransitionContainer

Container & iterator types for transitions.

typedef TransitionContainer::const_iterator kanzi::PageTransitionCollection::TransitionConstIterator

typedef shared_ptr<Runtime> kanzi::PageTransitionCollection::RuntimeSharedPtr

Constructor & Destructor Documentation

virtual kanzi::PageTransitionCollection::~PageTransitionCollection ( )

virtual

kanzi::PageTransitionCollection::PageTransitionCollection	(	Domain *	domain,
		string_view	name = `""`
	)

explicitprotected

Member Function Documentation

static PageTransitionCollectionSharedPtr kanzi::PageTransitionCollection::create	(	Domain *	domain,
		string_view	name = `""`
	)

static

void kanzi::PageTransitionCollection::addTransition ( TransitionSharedPtr transition )

Add transition to transition group, needs to be called before transition group is attached to scene graph.

Parameters

transition Transition to add.

void kanzi::PageTransitionCollection::removeTransition ( TransitionSharedPtr transition )

Remove transition from transition group, needs to be called before transition group is attached to scene graph.

Parameters

transition Transition to remove.

TransitionConstIterator kanzi::PageTransitionCollection::beginTransitions ( ) const

Returns iterator to start of the transition container.

Returns: Iterator at the beginning of the container.

TransitionConstIterator kanzi::PageTransitionCollection::endTransitions ( ) const

Returns iterator to end of the transition container.

Returns: Iterator at the end of the container.

TransitionSharedPtr kanzi::PageTransitionCollection::findTransition	(	string_view	source,
		string_view	target
	)

Finds matching transition definition for given parameters, falls back to default.

Parameters

source	Transition source, relative path to page host.
target	Transition target, relative path to page host.

Returns: The transition definition which has best match for this scenario.

RuntimeSharedPtr kanzi::PageTransitionCollection::attach ( Page * node )

Attach transitions to Page component.

Parameters

page	Page to attach transitions in to.

Returns: Runtime object that manages page transitions.

static void kanzi::PageTransitionCollection::detach ( RuntimeSharedPtr transitionGroupRuntime )

static

Detach transitions from Page component.

Parameters

transitionGroupRuntime Transitions to detach.

virtual void kanzi::PageTransitionCollection::loadFromKZB	(	const KzuResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Function for loading the resource from .KZB.

This function is called when loading the data from .KZB file. Implementations should call super class loadFromKZB before reading anything else from inputStream. This function is called from arbitrary loading threads. The parameter threadContext contains thread safe memory manager and a thread specific Property manager which can be locked with the threadLock in the threadContext. This function may not access resource manager or the UIDomain due to race conditions.

Reimplemented from kanzi::Resource.

static PageTransitionCollectionSharedPtr kanzi::PageTransitionCollection::loadFromKZB	(	Domain *	domain,
		string_view	name,
		KzbFile &	kzbFile,
		ReadOnlyMemoryFile &	file,
		KzbMemoryParser &	parser
	)

static

Loads page transition collection from KZB and returns it.

Parameters

domain	Domain.
name	Name of page transition collection.
kzbFile	KZB to read page transition collection from.
file	File entry in KZB which contains page transition collection data.
parser	Parser to parse page transition collection data.

Returns: Loaded page transition collection.

Friends And Related Function Documentation

friend class ResourceManager

friend

friend class Page

friend

Member Data Documentation

PropertyType<int> kanzi::PageTransitionCollection::PageTransitionDurationProperty

static

PageTransitionDuration property.

The duration of a Page node transition (in milliseconds). The default value is 500.

See also: setPageTransitionDuration(), getPageTransitionDuration()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionFromProperty

static

PageTransitionFrom property.

The selection criteria for the source Page node. Use * for any Page node. The default value is "".

See also: setPageTransitionFrom(), getPageTransitionFrom()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionToProperty

static

PageTransitionTo property.

The selection criteria for the target Page node. Use * for any Page node. The default value is "".

See also: setPageTransitionTo(), getPageTransitionTo()

PropertyType<PageTransitionCollection::Transition::Direction> kanzi::PageTransitionCollection::PageTransitionDirectionProperty

static

PageTransitionDirection property.

Defines whether the transition is unidirectional (one way) or bidirectional (two way). The default value is PageTransitionCollection::Transition::Bidirectional.

See also: setPageTransitionDirection(), getPageTransitionDirection()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationPropertyTypeProperty

static

PageTransitionAnimationPropertyType property.

Defines which property to animate. The default value is "".

See also: setPageTransitionAnimationPropertyType(), getPageTransitionAnimationPropertyType()

PropertyType<PageTransitionCollection::Transition::AnimationTarget> kanzi::PageTransitionCollection::PageTransitionAnimationAnimationTargetProperty

static

PageTransitionAnimationAnimationTarget property.

Defines the animation target, either page transitioning in or page transitioning out. The default value is PageTransitionCollection::Transition::PageIn.

See also: setPageTransitionAnimationAnimationTarget(), getPageTransitionAnimationAnimationTarget()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationStartValueProperty

static

PageTransitionAnimationStartValue property.

The starting value for the animation. The default value is "".

See also: setPageTransitionAnimationStartValue(), getPageTransitionAnimationStartValue()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationEndValueProperty

static

PageTransitionAnimationEndValue property.

The ending value for the animation. The default value is "".

See also: setPageTransitionAnimationEndValue(), getPageTransitionAnimationEndValue()

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

kanzi/ui/node/page_transition_collection.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation