kzu_property_manager_array.h File Reference

Property manager. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Typedefs
typedef const void *	KzuArrayPropertyElement
	Type for struct property. More...

Functions
kzsError	kzuPropertyManagerSetArray (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, kzUint index, KzuArrayPropertyElement *const out_value)
	Set a property of propertyType associated with an object. More...
kzBool	kzuPropertyManagerGetArray (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, kzUint index, KzuArrayPropertyElement *const out_value)
	Get the value of a property of propertyType associated with an object. More...
KzuArrayPropertyElement	kzuPropertyManagerGetArrayDefault (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, kzUint index)
	Get a property of propertyType associated with an object and return the default value from the property type if not found. More...
kzsError	kzuPropertyManagerGetArraySize (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, kzUint *out_size)
	Gets a size of array property, i.e. More...
kzsError	kzuObjectNodeSetArrayProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, kzUint index, KzuArrayPropertyElement *const out_value)
	Set a property on an object node. More...
kzBool	kzuObjectNodeGetArrayProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, kzUint index, KzuArrayPropertyElement *const out_value)
	Get the value of a property of propertyType associated with an object node. More...
KzuArrayPropertyElement	kzuObjectNodeGetArrayPropertyDefault (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, kzUint index)
	Get the value of a property associated with an object node. More...

Detailed Description

Property manager.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef const void* KzuArrayPropertyElement

Type for struct property.

Function Documentation

kzsError kzuPropertyManagerSetArray	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzUint	index,
		KzuArrayPropertyElement *const	out_value
	)

Set a property of propertyType associated with an object.

Return an object representing the struct, which can be used for assigning child properties to.

kzBool kzuPropertyManagerGetArray	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzUint	index,
		KzuArrayPropertyElement *const	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.

   Parameters

   out_value

   Output value from array, an object that can be used for property manager object (e.g. asking for float property by using this as key). KZ_NULL if not used.

KzuArrayPropertyElement kzuPropertyManagerGetArrayDefault	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzUint	index
	)

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 kzuPropertyManagerGetArray then that value is returned. If the property can not be deduced, KZ_NULL is returned.

kzsError kzuPropertyManagerGetArraySize	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzUint *	out_size
	)

Gets a size of array property, i.e.

number of elements in array.

kzsError kzuObjectNodeSetArrayProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzUint	index,
		KzuArrayPropertyElement *const	out_value
	)

Set a property on an object node.

kzBool kzuObjectNodeGetArrayProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzUint	index,
		KzuArrayPropertyElement *const	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. kzuPropertyManagerGetArray 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.

KzuArrayPropertyElement kzuObjectNodeGetArrayPropertyDefault	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzUint	index
	)

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

Behaves like kzuObjectNodeGetArrayProperty, but if the property value can not be deduced, KZ_NULL is returned.