kzu_property_manager_color.h File Reference

Property manager. More...

#include <core/util/color/kzc_color.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuPropertyColorValueSourceCreate (const struct KzuPropertyManager *propertyManager, struct KzcColorRGBA value, struct KzuPropertyColorValueSource **out_valueSource)
	Create a Color value source. More...
kzsError	kzuPropertyColorValueSourceDelete (struct KzuPropertyColorValueSource *valueSource)
	Delete a Color value source. More...
kzsError	kzuPropertyColorValueSourceClone (const struct KzuPropertyManager *propertyManager, const struct KzuPropertyColorValueSource *valueSource, struct KzuPropertyColorValueSource **out_newValueSource)
	Copy a color value source. More...
kzsError	kzuPropertyColorValueSourceCopy (struct KzuPropertyColorValueSource *target, const struct KzuPropertyColorValueSource *source)
	Copy a color value source. More...
kzsError	kzuPropertyColorValueSourceSetValue (struct KzuPropertyColorValueSource *valueSource, struct KzcColorRGBA value)
	Set a color value source. More...
struct KzcColorRGBA	kzuPropertyColorValueSourceGetValue (const struct KzuPropertyColorValueSource *valueSource)
	Gets a color value source value. More...
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...
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...
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...
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...
kzsError	kzuObjectNodeSetColorProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, struct KzcColorRGBA value)
	Set a property on an object node. More...
kzBool	kzuObjectNodeGetColorProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, struct KzcColorRGBA *out_value)
	Get the value of a property of propertyType associated with an object node. More...
kzBool	kzuObjectNodeGetBaseColorProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, struct KzcColorRGBA *out_value)
	Get the base value of a property of propertyType associated with an object node. More...
struct KzcColorRGBA	kzuObjectNodeGetColorPropertyDefault (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType)
	Get the value of a property associated with an object node. More...

Detailed Description

Property manager.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPropertyColorValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		struct KzcColorRGBA	value,
		struct KzuPropertyColorValueSource **	out_valueSource
	)

Create a Color value source.

kzsError kzuPropertyColorValueSourceDelete

(

struct KzuPropertyColorValueSource *

valueSource)

Delete a Color value source.

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

Copy a color value source.

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

Copy a color value source.

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

Set a color value source.

struct KzcColorRGBA kzuPropertyColorValueSourceGetValue

(

const struct KzuPropertyColorValueSource *

valueSource)

Gets a color value source value.

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.

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:

1. 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.
2. The value associated with the object is returned.
3. 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.
4. If the property can not be deduced, the output value is not modified and KZ_FALSE is returned.

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.

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.

kzsError kzuObjectNodeSetColorProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcColorRGBA	value
	)

Set a property on an object node.

kzBool kzuObjectNodeGetColorProperty	(	const struct KzuObjectNode *	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:

1. kzuPropertyManagerGetColor is used for getting the property value.
2. 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.
3. If the property is not found until the root is reached, the output value is not modified and KZ_FALSE is returned.

kzBool kzuObjectNodeGetBaseColorProperty	(	const struct KzuObjectNode *	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.

struct KzcColorRGBA kzuObjectNodeGetColorPropertyDefault	(	const struct KzuObjectNode *	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.