kzu_property.h File Reference

Specifies property. More...

#include <kanzi/platform/platform.hpp>
#include <kanzi/platform/types.hpp>
#include <kanzi/property/property_data_type.hpp>
#include <kanzi/property/property_field.hpp>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <kanzi/platform/memory.hpp>

Namespaces
	kanzi

Functions
KANZI_API kzsError	kzuPropertyTypesInitialize (const struct KzcMemoryManager *memoryManager)
	Initializes property types. More...
KANZI_API kzsError	kzuPropertyTypesUninitialize (void)
	Uninitializes property types. More...
KANZI_API kzsError	kzuPropertyTypeCreate (const struct KzcMemoryManager *memoryManager, kanzi::PropertyDataType dataType, kzString name, struct KzuPropertyType **out_propertyType)
	Creates a property type. More...
KANZI_API kzsError	kzuPropertyTypeDelete (const struct KzuPropertyType *propertyType)
	Deletes a property type. More...
KANZI_API kzsError	kzuPropertyTypeSetReadOnly (struct KzuPropertyType *propertyType)
	Marks the property type as read-only. More...
KANZI_API kzsError	kzuPropertyTypeLoadFromKZB (struct KzuPropertyType *propertyType, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads a property type from KZB. More...
KANZI_API kzString	kzuPropertyTypeGetName (const struct KzuPropertyType *propertyType)
	Returns property type's name. More...
KANZI_API kzString	kzuPropertyTypeGetUnqualifiedName (const struct KzuPropertyType *propertyType)
	Returns property type's unqualified name. More...
KANZI_API kanzi::PropertyDataType	kzuPropertyTypeGetDataType (const KzuPropertyType *propertyType)
	Gets data type of property. More...
KANZI_API void	kzuPropertyTypeSetInherited (struct KzuPropertyType *propertyType, kzBool inherited)
	Sets the inheritance behavior of the property type. More...
KANZI_API kzBool	kzuPropertyTypeIsInherited (const struct KzuPropertyType *propertyType)
	Gets the inheritance behavior of the property type. More...
KANZI_API void	kzuPropertyTypeSetChangeFlags (struct KzuPropertyType *propertyType, kzU32 flags)
	Sets the change flags this type updates when a property is set on object nodes. More...
KANZI_API void	kzuPropertyTypeClearChangeFlags (struct KzuPropertyType *propertyType, kzU32 flags)
	Clear the change flags this type updates when a property is set on object nodes. More...
KANZI_API kzU32	kzuPropertyTypeGetChangeFlags (const struct KzuPropertyType *propertyType)
	Get the change flags this type updates when a property is set on object nodes. More...
KANZI_API kzFloat	kzuPropertyFieldGetFloat (const struct KzuPropertyManager *propertyManager, const struct KzuPropertyType *propertyType, kanzi::PropertyField targetAttribute, const void *targetObject, kzBool localValue)
	Gets the float-type property field of the given property type for the referenced target object. More...
KANZI_API kzUint	kzuPropertyTypeGetIndex (const struct KzuPropertyType *propertyType)
	Gets the index of the property type that is used inside property manager for look-up. More...
KANZI_API kanzi::PropertyTypeEditorInfoSharedPtr	kzuPropertyTypeGetEditorInfo (const struct KzuPropertyType *propertyType)
KANZI_API void	kzuPropertyTypeSetEditorInfo (KzuPropertyType *propertyType, kanzi::PropertyTypeEditorInfoSharedPtr info)

Variables
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_FINAL_TRANSFORMATION
	Property type with this flag affects final transformation of an object and all its children. More...
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_MEASURE
	Property type with this flag affects layout. More...
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_PARENT_MEASURE
	Property type with this flag affects layout of node's parent. More...
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_ARRANGE
	Property type with this flag affects layout arrange. More...
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER
	Property type with this flag affects rendering. More...
static const uint32_t	KZU_PROPERTY_TYPE_CHANGE_FLAG_CONSTRAINT
	Property type with this flag informs that constraints are in use. More...

Detailed Description

Specifies property.

Copyright 2008-2020 by Rightware. All rights reserved.

Function Documentation

KANZI_API kzsError kzuPropertyTypesInitialize

(

const struct KzcMemoryManager *

memoryManager

)

Initializes property types.

KANZI_API kzsError kzuPropertyTypesUninitialize

(

void

)

Uninitializes property types.

KANZI_API kzsError kzuPropertyTypeCreate	(	const struct KzcMemoryManager *	memoryManager,
		kanzi::PropertyDataType	dataType,
		kzString	name,
		struct KzuPropertyType **	out_propertyType
	)

Creates a property type.

KANZI_API kzsError kzuPropertyTypeDelete

(

const struct KzuPropertyType *

propertyType

)

Deletes a property type.

KANZI_API kzsError kzuPropertyTypeSetReadOnly

(

struct KzuPropertyType *

propertyType

)

Marks the property type as read-only.

This means that .KZB files cannot overwrite any of its data later on.

KANZI_API kzsError kzuPropertyTypeLoadFromKZB	(	struct KzuPropertyType *	propertyType,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads a property type from KZB.

KANZI_API kzString kzuPropertyTypeGetName

(

const struct KzuPropertyType *

propertyType

)

Returns property type's name.

KANZI_API kzString kzuPropertyTypeGetUnqualifiedName

(

const struct KzuPropertyType *

propertyType

)

Returns property type's unqualified name.

Unqualified names do not contain namespaces or class names. Unqualified names are used in binding to shader and script properties.

KANZI_API kanzi::PropertyDataType kzuPropertyTypeGetDataType

(

const KzuPropertyType *

propertyType

)

Gets data type of property.

KANZI_API void kzuPropertyTypeSetInherited	(	struct KzuPropertyType *	propertyType,
		kzBool	inherited
	)

Sets the inheritance behavior of the property type.

KANZI_API kzBool kzuPropertyTypeIsInherited

(

const struct KzuPropertyType *

propertyType

)

Gets the inheritance behavior of the property type.

KANZI_API void kzuPropertyTypeSetChangeFlags	(	struct KzuPropertyType *	propertyType,
		kzU32	flags
	)

Sets the change flags this type updates when a property is set on object nodes.

KANZI_API void kzuPropertyTypeClearChangeFlags	(	struct KzuPropertyType *	propertyType,
		kzU32	flags
	)

Clear the change flags this type updates when a property is set on object nodes.

KANZI_API kzU32 kzuPropertyTypeGetChangeFlags

(

const struct KzuPropertyType *

propertyType

)

Get the change flags this type updates when a property is set on object nodes.

KANZI_API kzFloat kzuPropertyFieldGetFloat	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyType *	propertyType,
		kanzi::PropertyField	targetAttribute,
		const void *	targetObject,
		kzBool	localValue
	)

Gets the float-type property field of the given property type for the referenced target object.

KANZI_API kzUint kzuPropertyTypeGetIndex

(

const struct KzuPropertyType *

propertyType

)

Gets the index of the property type that is used inside property manager for look-up.

KANZI_API kanzi::PropertyTypeEditorInfoSharedPtr kzuPropertyTypeGetEditorInfo

(

const struct KzuPropertyType *

propertyType

)

KANZI_API void kzuPropertyTypeSetEditorInfo	(	KzuPropertyType *	propertyType,
		kanzi::PropertyTypeEditorInfoSharedPtr	info
	)

Variable Documentation

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_FINAL_TRANSFORMATION

static

Property type with this flag affects final transformation of an object and all its children.

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_MEASURE

static

Property type with this flag affects layout.

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_PARENT_MEASURE

static

Property type with this flag affects layout of node's parent.

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_ARRANGE

static

Property type with this flag affects layout arrange.

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER

static

Property type with this flag affects rendering.

const uint32_t KZU_PROPERTY_TYPE_CHANGE_FLAG_CONSTRAINT

static

Property type with this flag informs that constraints are in use.