Property manager. More...

#include <kanzi/platform/platform.hpp>
#include <core/util/color/kzc_color.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>

Namespaces
	kanzi

Functions
KANZI_API kzsError	kzuPropertyColorValueSourceCreate (const struct KzuPropertyManager propertyManager, struct KzcColorRGBA value, struct KzuPropertyColorValueSource *out_valueSource)
	Create a Color value source. More...

KANZI_API kzsError	kzuPropertyColorValueSourceDelete (struct KzuPropertyColorValueSource *valueSource)
	Delete a Color value source. More...

KANZI_API kzsError	kzuPropertyColorValueSourceClone (const struct KzuPropertyManager propertyManager, const struct KzuPropertyColorValueSource valueSource, struct KzuPropertyColorValueSource **out_newValueSource)
	Copy a color value source. More...

KANZI_API kzsError	kzuPropertyColorValueSourceCopy (struct KzuPropertyColorValueSource target, const struct KzuPropertyColorValueSource source)
	Copy a color value source. More...

KANZI_API kzsError	kzuPropertyColorValueSourceSetValue (struct KzuPropertyColorValueSource *valueSource, struct KzcColorRGBA value)
	Set a color value source. More...

KANZI_API struct KzcColorRGBA	kzuPropertyColorValueSourceGetValue (const struct KzuPropertyColorValueSource *valueSource)
	Gets a color value source value. More...

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

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

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

KANZI_API struct KzcColorRGBA	kzuPropertyManagerGetColorDefault (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	kzuObjectNodeSetColorProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, struct KzcColorRGBA value)
	Set a property on an object node. More...

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

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

KANZI_API struct KzcColorRGBA	kzuObjectNodeGetColorPropertyDefault (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 kzuPropertyColorValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		struct KzcColorRGBA	value,
		struct KzuPropertyColorValueSource **	out_valueSource
	)

Create a Color value source.

KANZI_API kzsError kzuPropertyColorValueSourceDelete ( struct KzuPropertyColorValueSource * valueSource )

Delete a Color value source.

KANZI_API kzsError kzuPropertyColorValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyColorValueSource *	valueSource,
		struct KzuPropertyColorValueSource **	out_newValueSource
	)

Copy a color value source.

KANZI_API kzsError kzuPropertyColorValueSourceCopy	(	struct KzuPropertyColorValueSource *	target,
		const struct KzuPropertyColorValueSource *	source
	)

Copy a color value source.

KANZI_API kzsError kzuPropertyColorValueSourceSetValue	(	struct KzuPropertyColorValueSource *	valueSource,
		struct KzcColorRGBA	value
	)

Set a color value source.

KANZI_API struct KzcColorRGBA kzuPropertyColorValueSourceGetValue ( const struct KzuPropertyColorValueSource * valueSource )

Gets a color value source value.

KANZI_API kzsError kzuPropertyManagerSetColor	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA	value
	)

Set a property of propertyType associated with an object.

KANZI_API kzBool kzuPropertyManagerGetColor	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA *	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 kzuPropertyManagerGetBaseColor	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA *	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 struct KzcColorRGBA kzuPropertyManagerGetColorDefault	(	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 kzuPropertyManagerGetColor then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API kzsError kzuObjectNodeSetColorProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA	value
	)

Set a property on an object node.

KANZI_API kzBool kzuObjectNodeGetColorProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA *	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:

kzuPropertyManagerGetColor 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 kzuObjectNodeGetBaseColorProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA *	out_value
	)

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

Behaves like kzuObjectNodeGetColorProperty but does not take animation into account.

KANZI_API struct KzcColorRGBA kzuObjectNodeGetColorPropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

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

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

Namespaces

Functions

Detailed Description

Function Documentation