Property manager. More...

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

Namespaces
	kanzi

Functions
kzsError	kzuPropertyMatrix3x3ValueSourceCreate (const struct KzuPropertyManager propertyManager, struct KzcMatrix3x3 value, struct KzuPropertyMatrix3x3ValueSource *out_valueSource)
	Create a matrix3x3 value source. More...

kzsError	kzuPropertyMatrix3x3ValueSourceCreateSRT (const struct KzuPropertyManager propertyManager, const struct KzcVector2 scale, kzFloat rotateInDegrees, const struct KzcVector2 translate, struct KzuPropertyMatrix3x3ValueSource *out_valueSource)
	Create matrix3x3 value source from SRT. More...

kzsError	kzuPropertyMatrix3x3ValueSourceDelete (struct KzuPropertyMatrix3x3ValueSource *valueSource)
	Delete a matrix3x3 value source. More...

kzsError	kzuPropertyMatrix3x3ValueSourceClone (const struct KzuPropertyManager propertyManager, const struct KzuPropertyMatrix3x3ValueSource valueSource, struct KzuPropertyMatrix3x3ValueSource **out_newValueSource)
	Copy a matrix3x3 value source. More...

kzsError	kzuPropertyMatrix3x3ValueSourceCopy (struct KzuPropertyMatrix3x3ValueSource target, const struct KzuPropertyMatrix3x3ValueSource source)
	Copy a matrix3x3 value source. More...

KANZI_API kzsError	kzuPropertyMatrix3x3ValueSourceSetValue (struct KzuPropertyMatrix3x3ValueSource *valueSource, struct KzcMatrix3x3 value)
	Set a matrix3x3 value source. More...

KANZI_API kzsError	kzuPropertyMatrix3x3ValueSourceSetValueSRT (struct KzuPropertyMatrix3x3ValueSource valueSource, const struct KzcVector2 scale, kzFloat rotateInDegrees, const struct KzcVector2 *translate)
	Set a matrix3x3 value source using SRT. More...

KANZI_API KzcMatrix3x3	kzuPropertyMatrix3x3ValueSourceGetValue (struct KzuPropertyMatrix3x3ValueSource *valueSource)
	Get a matrix3x3 value source. More...

KANZI_API void	kzuPropertyMatrix3x3ValueSourceGetValueSRT (const struct KzuPropertyMatrix3x3ValueSource valueSource, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 out_translate)
	Get a matrix3x3 value source using SRT. More...

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

KANZI_API kzsError	kzuPropertyManagerSetMatrix3x3SRT (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, const struct KzcVector2 scale, kzFloat rotateInDegrees, const struct KzcVector2 *translate)
	Set a property of propertyType associated with an object in SRT form, rotation in degrees. More...

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

KANZI_API kzBool	kzuPropertyManagerGetMatrix3x3SRT (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 out_translate)
	Get the value of a property of propertyType associated with an object in SRT form. More...

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

KANZI_API kzBool	kzuPropertyManagerGetBaseMatrix3x3SRT (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 out_translate)
	Get the base value of a property of propertyType associated with an object in SRT format. More...

KANZI_API struct KzcMatrix3x3	kzuPropertyManagerGetMatrix3x3Default (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 void	kzuPropertyManagerGetMatrix3x3DefaultSRT (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 out_translate)
	Get a property of propertyType associated with an object and return the default value from the property type if not found, in form of SRT. More...

KANZI_API kzBool	kzuPropertyManagerGetMatrix3x3Combined (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, struct KzcMatrix3x3 out_matrix, struct KzcVector2 out_scale, kzFloat out_rotation, struct KzcVector2 out_translation, kzBool out_isMatrixValue)
	Get combined value of matrix and SRT values. More...

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

KANZI_API kzsError	kzuObjectNodeSetMatrix3x3PropertySRT (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, const struct KzcVector2 scale, kzFloat rotate, const struct KzcVector2 translate)
	Set a property on an object node in SRT format. More...

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

KANZI_API kzBool	kzuObjectNodeGetMatrix3x3SRTProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 *out_translate)
	Get the value of a property of propertyType associated with an object node in SRT format. More...

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

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

KANZI_API void	kzuObjectNodeGetMatrix3x3PropertyDefaultSRT (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, struct KzcVector2 out_scale, kzFloat out_rotateInDegrees, struct KzcVector2 *out_translate)
	Get the value of a property associated with an object node in SRT format. More...

Detailed Description

Property manager.

Function Documentation

kzsError kzuPropertyMatrix3x3ValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		struct KzcMatrix3x3	value,
		struct KzuPropertyMatrix3x3ValueSource **	out_valueSource
	)

Create a matrix3x3 value source.

kzsError kzuPropertyMatrix3x3ValueSourceCreateSRT	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzcVector2 *	scale,
		kzFloat	rotateInDegrees,
		const struct KzcVector2 *	translate,
		struct KzuPropertyMatrix3x3ValueSource **	out_valueSource
	)

Create matrix3x3 value source from SRT.

kzsError kzuPropertyMatrix3x3ValueSourceDelete ( struct KzuPropertyMatrix3x3ValueSource * valueSource )

Delete a matrix3x3 value source.

kzsError kzuPropertyMatrix3x3ValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyMatrix3x3ValueSource *	valueSource,
		struct KzuPropertyMatrix3x3ValueSource **	out_newValueSource
	)

Copy a matrix3x3 value source.

kzsError kzuPropertyMatrix3x3ValueSourceCopy	(	struct KzuPropertyMatrix3x3ValueSource *	target,
		const struct KzuPropertyMatrix3x3ValueSource *	source
	)

Copy a matrix3x3 value source.

KANZI_API kzsError kzuPropertyMatrix3x3ValueSourceSetValue	(	struct KzuPropertyMatrix3x3ValueSource *	valueSource,
		struct KzcMatrix3x3	value
	)

Set a matrix3x3 value source.

KANZI_API kzsError kzuPropertyMatrix3x3ValueSourceSetValueSRT	(	struct KzuPropertyMatrix3x3ValueSource *	valueSource,
		const struct KzcVector2 *	scale,
		kzFloat	rotateInDegrees,
		const struct KzcVector2 *	translate
	)

Set a matrix3x3 value source using SRT.

KANZI_API KzcMatrix3x3 kzuPropertyMatrix3x3ValueSourceGetValue ( struct KzuPropertyMatrix3x3ValueSource * valueSource )

Get a matrix3x3 value source.

KANZI_API void kzuPropertyMatrix3x3ValueSourceGetValueSRT	(	const struct KzuPropertyMatrix3x3ValueSource *	valueSource,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

Get a matrix3x3 value source using SRT.

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

KANZI_API kzsError kzuPropertyManagerSetMatrix3x3	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix3x3 *	value
	)

Set a property of propertyType associated with an object.

KANZI_API kzsError kzuPropertyManagerSetMatrix3x3SRT	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		const struct KzcVector2 *	scale,
		kzFloat	rotateInDegrees,
		const struct KzcVector2 *	translate
	)

Set a property of propertyType associated with an object in SRT form, rotation in degrees.

KANZI_API kzBool kzuPropertyManagerGetMatrix3x3	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix3x3 *	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 kzuPropertyManagerGetMatrix3x3SRT	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

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

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. Doesn't take relative matrix into account. 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.

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

KANZI_API kzBool kzuPropertyManagerGetBaseMatrix3x3	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix3x3 *	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 kzBool kzuPropertyManagerGetBaseMatrix3x3SRT	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

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

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise.

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

KANZI_API struct KzcMatrix3x3 kzuPropertyManagerGetMatrix3x3Default	(	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 kzuPropertyManagerGetMatrix3x3 then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API void kzuPropertyManagerGetMatrix3x3DefaultSRT	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

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

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

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

KANZI_API kzBool kzuPropertyManagerGetMatrix3x3Combined	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix3x3 *	out_matrix,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotation,
		struct KzcVector2 *	out_translation,
		kzBool *	out_isMatrixValue
	)

Get combined value of matrix and SRT values.

Also retrieves flag value if matrix value was last set (if so, SRT values are not reliable since they are extracted from matrix).

KANZI_API kzsError kzuObjectNodeSetMatrix3x3Property	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix3x3 *	value
	)

Set a property on an object node.

KANZI_API kzsError kzuObjectNodeSetMatrix3x3PropertySRT	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		const struct KzcVector2 *	scale,
		kzFloat	rotate,
		const struct KzcVector2 *	translate
	)

Set a property on an object node in SRT format.

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

kzuPropertyManagerGetMatrix3x3 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 kzuObjectNodeGetMatrix3x3SRTProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

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

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

kzuPropertyManagerGetMatrix3x3 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.

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

KANZI_API kzBool kzuObjectNodeGetBaseMatrix3x3Property	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcMatrix3x3 *	out_value
	)

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

Behaves like kzuObjectNodeGetMatrix3x3Property but does not take animation into account.

KANZI_API struct KzcMatrix3x3 kzuObjectNodeGetMatrix3x3PropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

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

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

KANZI_API void kzuObjectNodeGetMatrix3x3PropertyDefaultSRT	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		struct KzcVector2 *	out_scale,
		kzFloat *	out_rotateInDegrees,
		struct KzcVector2 *	out_translate
	)

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

Parameters

out_scale	Scale vector of the matrix SRT, not returned when KZ_NULL given as an argument.
out_rotate	Rotate scalar of the matrix SRT in degrees, not returned when KZ_NULL given as an argument.
out_translate	Translate vector of the matrix SRT, not returned when KZ_NULL given as an argument.

Namespaces

Functions

Detailed Description

Function Documentation