kzu_property_query.h File Reference

Property query. More...

#include <core/util/math/kzc_vector2.h>
#include <core/util/math/kzc_vector3.h>
#include <core/util/math/kzc_vector4.h>
#include <core/util/math/kzc_matrix2x2.h>
#include <core/util/math/kzc_matrix3x3.h>
#include <core/util/math/kzc_matrix4x4.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuPropertyQueryCreate (const struct KzcMemoryManager *memoryManager, struct KzuPropertyManager *propertyManager, struct KzcMemoryManager *quickMemoryManager, struct KzuPropertyQuery **out_propertyQuery)
	Create a property query object. More...
kzsError	kzuPropertyQueryDelete (struct KzuPropertyQuery *propertyQuery)
	Delete a property query object. More...
struct KzuPropertyManager *	kzuPropertyQueryGetPropertyManager (const struct KzuPropertyQuery *propertyQuery)
	Gets the property manager of the property query. More...
kzsError	kzuPropertyQueryPush (const struct KzuPropertyQuery *propertyQuery, const void *object)
	Push an arbitrary pointer to the property query. More...
kzsError	kzuPropertyQueryPushObjectNode (const struct KzuPropertyQuery *propertyQuery, const struct KzuObjectNode *objectNode)
	Push an object node to the property query. More...
kzsError	kzuPropertyQueryPushTransformedObjectNode (const struct KzuPropertyQuery *propertyQuery, const struct KzuTransformedObjectNode *transformedObjectNode)
	Push an transformed object node to the property query. More...
kzsError	kzuPropertyQueryPop (const struct KzuPropertyQuery *propertyQuery)
	Pop the last pushed item from the property query. More...
kzsError	kzuPropertyQueryResetFrame (struct KzuPropertyQuery *propertyQuery)
	Resets property query frame. More...
kzsError	kzuPropertyQueryAddFirst (const struct KzuPropertyQuery *propertyQuery, const void *object)
	Add an arbitrary pointer to the beginning of the property query. More...
kzsError	kzuPropertyQueryRemoveFirst (const struct KzuPropertyQuery *propertyQuery)
	Remove an item from the beginning of the property query. More...
kzBool	kzuPropertyQueryIsEmpty (const struct KzuPropertyQuery *propertyQuery)
	Returns if property query is empty. More...
kzFloat	kzuPropertyQueryGetFloat (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
kzInt	kzuPropertyQueryGetInt (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
kzBool	kzuPropertyQueryGetBool (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcColorRGBA	kzuPropertyQueryGetColor (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcVector2	kzuPropertyQueryGetVector2 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcVector3	kzuPropertyQueryGetVector3 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcVector4	kzuPropertyQueryGetVector4 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcMatrix2x2	kzuPropertyQueryGetMatrix2x2 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcMatrix3x3	kzuPropertyQueryGetMatrix3x3 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
struct KzcMatrix4x4	kzuPropertyQueryGetMatrix4x4 (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType)
	Get the value of a property using the property query. More...
kzsError	kzuPropertyQueryGetResource (const struct KzuPropertyQuery *propertyQuery, const struct KzuPropertyType *propertyType, struct KzuResource **out_resource)
	Get the value of a property using the property query. More...

Detailed Description

Property query.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPropertyQueryCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPropertyManager *	propertyManager,
		struct KzcMemoryManager *	quickMemoryManager,
		struct KzuPropertyQuery **	out_propertyQuery
	)

Create a property query object.

kzsError kzuPropertyQueryDelete

(

struct KzuPropertyQuery *

propertyQuery)

Delete a property query object.

struct KzuPropertyManager* kzuPropertyQueryGetPropertyManager

(

const struct KzuPropertyQuery *

propertyQuery)

Gets the property manager of the property query.

kzsError kzuPropertyQueryPush	(	const struct KzuPropertyQuery *	propertyQuery,
		const void *	object
	)

Push an arbitrary pointer to the property query.

kzsError kzuPropertyQueryPushObjectNode	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuObjectNode *	objectNode
	)

Push an object node to the property query.

kzsError kzuPropertyQueryPushTransformedObjectNode	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuTransformedObjectNode *	transformedObjectNode
	)

Push an transformed object node to the property query.

kzsError kzuPropertyQueryPop

(

const struct KzuPropertyQuery *

propertyQuery)

Pop the last pushed item from the property query.

kzsError kzuPropertyQueryResetFrame

(

struct KzuPropertyQuery *

propertyQuery)

Resets property query frame.

kzsError kzuPropertyQueryAddFirst	(	const struct KzuPropertyQuery *	propertyQuery,
		const void *	object
	)

Add an arbitrary pointer to the beginning of the property query.

kzsError kzuPropertyQueryRemoveFirst

(

const struct KzuPropertyQuery *

propertyQuery)

Remove an item from the beginning of the property query.

kzBool kzuPropertyQueryIsEmpty

(

const struct KzuPropertyQuery *

propertyQuery)

Returns if property query is empty.

kzFloat kzuPropertyQueryGetFloat	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetFloat is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

kzInt kzuPropertyQueryGetInt	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetInt is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

kzBool kzuPropertyQueryGetBool	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetBool is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcColorRGBA kzuPropertyQueryGetColor	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetColor is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcVector2 kzuPropertyQueryGetVector2	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetVector2 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcVector3 kzuPropertyQueryGetVector3	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetVector3 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcVector4 kzuPropertyQueryGetVector4	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetVector4 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcMatrix2x2 kzuPropertyQueryGetMatrix2x2	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetMatrix2x2 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcMatrix3x3 kzuPropertyQueryGetMatrix3x3	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetMatrix3x3 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

struct KzcMatrix4x4 kzuPropertyQueryGetMatrix4x4	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetMatrix4x4 is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.

kzsError kzuPropertyQueryGetResource	(	const struct KzuPropertyQuery *	propertyQuery,
		const struct KzuPropertyType *	propertyType,
		struct KzuResource **	out_resource
	)

Get the value of a property using the property query.

The return value is calculated based on the following steps:

1. kzuPropertyManagerGetPointer is used for getting the property value from all pushed objects.
2. If the property is found from multiple objects, the one with the highest priority wins. If the highest priority is on multiple objects, the last pushed object of those wins.
3. If the property is not found from any of the pushed objects, the default value from the property type is returned.
4. In every case when a value is found, a check is made to ensure that the value is a reference to KzuResource. If not, KZ_NULL is returned.