Property manager. More...

#include <kanzi/platform/platform.hpp>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>

Namespaces
	kanzi

Functions
KANZI_API kzsError	kzuPropertyIntValueSourceCreate (const struct KzuPropertyManager propertyManager, kzInt value, struct KzuPropertyIntValueSource *out_valueSource)
	Create a int value source. More...

KANZI_API kzsError	kzuPropertyIntValueSourceDelete (struct KzuPropertyIntValueSource *valueSource)
	Delete a int value source. More...

KANZI_API kzsError	kzuPropertyIntValueSourceClone (const struct KzuPropertyManager propertyManager, const struct KzuPropertyIntValueSource valueSource, struct KzuPropertyIntValueSource **out_newValueSource)
	Copy a int value source. More...

KANZI_API kzsError	kzuPropertyIntValueSourceCopy (struct KzuPropertyIntValueSource target, const struct KzuPropertyIntValueSource source)
	Copy a int value source. More...

KANZI_API kzsError	kzuPropertyIntValueSourceSetValue (struct KzuPropertyIntValueSource *valueSource, kzInt value)
	Set a int value source. More...

KANZI_API kzInt	kzuPropertyIntValueSourceGetValue (const struct KzuPropertyIntValueSource *valueSource)
	Get a int value source. More...

KANZI_API kzsError	kzuPropertyManagerSetInt (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType *propertyType, kzInt value)
	Set a property of propertyType associated with an object. More...

KANZI_API kzBool	kzuPropertyManagerGetInt (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, kzInt out_value)
	Get the value of a property of propertyType associated with an object. More...

KANZI_API kzBool	kzuPropertyManagerGetBaseInt (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, kzInt out_value)
	Get the base value of a property of propertyType associated with an object. More...

KANZI_API kzInt	kzuPropertyManagerGetIntDefault (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType *propertyType)
	Get a property of propertyType associated with an object and return the default value from the property type if not found. More...

KANZI_API kzsError	kzuObjectNodeSetIntProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzInt value)
	Set a property on an object node. More...

KANZI_API kzBool	kzuObjectNodeGetIntProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzInt *out_value)
	Get the value of a property of propertyType associated with an object node. More...

KANZI_API kzBool	kzuObjectNodeGetBaseIntProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzInt *out_value)
	Get the base value of a property of propertyType associated with an object node. More...

KANZI_API kzInt	kzuObjectNodeGetIntPropertyDefault (const kanzi::Node objectNode, const struct KzuPropertyType propertyType)
	Get the value of a property associated with an object node. More...

Detailed Description

Property manager.

Function Documentation

KANZI_API kzsError kzuPropertyIntValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		kzInt	value,
		struct KzuPropertyIntValueSource **	out_valueSource
	)

Create a int value source.

KANZI_API kzsError kzuPropertyIntValueSourceDelete ( struct KzuPropertyIntValueSource * valueSource )

Delete a int value source.

KANZI_API kzsError kzuPropertyIntValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyIntValueSource *	valueSource,
		struct KzuPropertyIntValueSource **	out_newValueSource
	)

Copy a int value source.

KANZI_API kzsError kzuPropertyIntValueSourceCopy	(	struct KzuPropertyIntValueSource *	target,
		const struct KzuPropertyIntValueSource *	source
	)

Copy a int value source.

KANZI_API kzsError kzuPropertyIntValueSourceSetValue	(	struct KzuPropertyIntValueSource *	valueSource,
		kzInt	value
	)

Set a int value source.

KANZI_API kzInt kzuPropertyIntValueSourceGetValue ( const struct KzuPropertyIntValueSource * valueSource )

Get a int value source.

KANZI_API kzsError kzuPropertyManagerSetInt	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzInt	value
	)

Set a property of propertyType associated with an object.

KANZI_API kzBool kzuPropertyManagerGetInt	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzInt *	out_value
	)

Get the value of a property of propertyType associated with an object.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

If an animation is applied to the property, the animated value is returned. It is calculated from the base and relative values of the property.
The value associated with the object is returned.
If the property is not associated with the object, the property groups associated with the object are queried: 3.1 Property groups associated with the object are queried in the reverse order than they were added.
If the property can not be deduced, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzBool kzuPropertyManagerGetBaseInt	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzInt *	out_value
	)

Get the base value of a property of propertyType associated with an object.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise.

KANZI_API kzInt kzuPropertyManagerGetIntDefault	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType
	)

Get a property of propertyType associated with an object and return the default value from the property type if not found.

If the property value can be deduced with kzuPropertyManagerGetInt then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API kzsError kzuObjectNodeSetIntProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzInt	value
	)

Set a property on an object node.

KANZI_API kzBool kzuObjectNodeGetIntProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzInt *	out_value
	)

Get the value of a property of propertyType associated with an object node.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

kzuPropertyManagerGetInt is used for getting the property value.
If the property value can not be deduced from the object node, the same query is performed for the parent of the current object node.
If the property is not found until the root is reached, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzBool kzuObjectNodeGetBaseIntProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzInt *	out_value
	)

Get the base value of a property of propertyType associated with an object node.

Behaves like kzuObjectNodeGetIntProperty but does not take animation into account.

KANZI_API kzInt kzuObjectNodeGetIntPropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property associated with an object node.

Behaves like kzuObjectNodeGetIntProperty, but if the property value can not be deduced, the default value from the property type is returned.

Namespaces

Functions

Detailed Description

Function Documentation