kzu_property_manager_matrix2x2.h File Reference

Property manager. More...

#include <core/util/math/kzc_matrix2x2.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuPropertyMatrix2x2ValueSourceCreate (const struct KzuPropertyManager *propertyManager, struct KzcMatrix2x2 value, struct KzuPropertyMatrix2x2ValueSource **out_valueSource)
	Create a matrix2x2 value source. More...
kzsError	kzuPropertyMatrix2x2ValueSourceDelete (struct KzuPropertyMatrix2x2ValueSource *valueSource)
	Delete a matrix2x2 value source. More...
kzsError	kzuPropertyMatrix2x2ValueSourceClone (const struct KzuPropertyManager *propertyManager, const struct KzuPropertyMatrix2x2ValueSource *valueSource, struct KzuPropertyMatrix2x2ValueSource **out_newValueSource)
	Copy a matrix2x2 value source. More...
kzsError	kzuPropertyMatrix2x2ValueSourceCopy (struct KzuPropertyMatrix2x2ValueSource *target, const struct KzuPropertyMatrix2x2ValueSource *source)
	Copy a matrix2x2 value source. More...
kzsError	kzuPropertyMatrix2x2ValueSourceSetValue (struct KzuPropertyMatrix2x2ValueSource *valueSource, struct KzcMatrix2x2 value)
	Set a matrix2x2 value source. More...
struct KzcMatrix2x2	kzuPropertyMatrix2x2ValueSourceGetValue (const struct KzuPropertyMatrix2x2ValueSource *valueSource)
	Get a matrix2x2 value source. More...
kzsError	kzuPropertyManagerSetMatrix2x2 (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, const struct KzcMatrix2x2 *value)
	Set a property of propertyType associated with an object. More...
kzBool	kzuPropertyManagerGetMatrix2x2 (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, struct KzcMatrix2x2 *out_value)
	Get the value of a property of propertyType associated with an object. More...
kzBool	kzuPropertyManagerGetBaseMatrix2x2 (const struct KzuPropertyManager *propertyManager, const void *object, const struct KzuPropertyType *propertyType, struct KzcMatrix2x2 *out_value)
	Get the base value of a property of propertyType associated with an object. More...
struct KzcMatrix2x2	kzuPropertyManagerGetMatrix2x2Default (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	kzuObjectNodeSetMatrix2x2Property (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, const struct KzcMatrix2x2 *value)
	Set a property on an object node. More...
kzBool	kzuObjectNodeGetMatrix2x2Property (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, struct KzcMatrix2x2 *out_value)
	Get the value of a property of propertyType associated with an object node. More...
kzBool	kzuObjectNodeGetBaseMatrix2x2Property (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, struct KzcMatrix2x2 *out_value)
	Get the base value of a property of propertyType associated with an object node. More...
struct KzcMatrix2x2	kzuObjectNodeGetMatrix2x2PropertyDefault (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 kzuPropertyMatrix2x2ValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		struct KzcMatrix2x2	value,
		struct KzuPropertyMatrix2x2ValueSource **	out_valueSource
	)

Create a matrix2x2 value source.

kzsError kzuPropertyMatrix2x2ValueSourceDelete

(

struct KzuPropertyMatrix2x2ValueSource *

valueSource)

Delete a matrix2x2 value source.

kzsError kzuPropertyMatrix2x2ValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyMatrix2x2ValueSource *	valueSource,
		struct KzuPropertyMatrix2x2ValueSource **	out_newValueSource
	)

Copy a matrix2x2 value source.

kzsError kzuPropertyMatrix2x2ValueSourceCopy	(	struct KzuPropertyMatrix2x2ValueSource *	target,
		const struct KzuPropertyMatrix2x2ValueSource *	source
	)

Copy a matrix2x2 value source.

kzsError kzuPropertyMatrix2x2ValueSourceSetValue	(	struct KzuPropertyMatrix2x2ValueSource *	valueSource,
		struct KzcMatrix2x2	value
	)

Set a matrix2x2 value source.

struct KzcMatrix2x2 kzuPropertyMatrix2x2ValueSourceGetValue

(

const struct KzuPropertyMatrix2x2ValueSource *

valueSource)

Get a matrix2x2 value source.

kzsError kzuPropertyManagerSetMatrix2x2	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix2x2 *	value
	)

Set a property of propertyType associated with an object.

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

kzsError kzuObjectNodeSetMatrix2x2Property	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix2x2 *	value
	)

Set a property on an object node.

kzBool kzuObjectNodeGetMatrix2x2Property	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix2x2 *	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. kzuPropertyManagerGetMatrix2x2 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 kzuObjectNodeGetBaseMatrix2x2Property	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix2x2 *	out_value
	)

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

Behaves like kzuObjectNodeGetMatrix2x2Property but does not take animation into account.

struct KzcMatrix2x2 kzuObjectNodeGetMatrix2x2PropertyDefault	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

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

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