Kanzi Graphics Engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
kzu_property.h File Reference

Specifies property. More...

Macros

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_TRANSFORMATION
 Property type with this flag affects transformation of an object. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_FINAL_TRANSFORMATION
 Property type with this flag affects final transformation of an object and all its children. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_LAYOUT
 Property type with this flag affects layout. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_ARRANGE
 Property type with this flag affects layout arrange. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER
 Property type with this flag affects rendering. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER_LAYER_MASK_AREA
 Property type with this flag only affects to mask area, used in layer render order on-demand. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER_TREE
 Property type with this flag only affects to mask area, used in layer render order on-demand. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_PARTIAL_RENDERING_OBJECT
 Property type with this flag affects partial rendering of itself. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_PARTIAL_RENDERING_TREE
 Property type with this flag affects partial rendering of itself and all its children. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_CONSTRAINT
 Property type with this flag informs that constraints are in use. More...
 
#define KZU_PROPERTY_TYPE_CHANGE_FLAG_LAYER_RENDER_QUAD
 Property type with this flag informs that rendered quad area of layer changed, i.e. More...
 

Functions

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

Detailed Description

Specifies property.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_TRANSFORMATION

Property type with this flag affects transformation of an object.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_FINAL_TRANSFORMATION

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

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_LAYOUT

Property type with this flag affects layout.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_ARRANGE

Property type with this flag affects layout arrange.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER

Property type with this flag affects rendering.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER_LAYER_MASK_AREA

Property type with this flag only affects to mask area, used in layer render order on-demand.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_RENDER_TREE

Property type with this flag only affects to mask area, used in layer render order on-demand.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_PARTIAL_RENDERING_OBJECT

Property type with this flag affects partial rendering of itself.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_PARTIAL_RENDERING_TREE

Property type with this flag affects partial rendering of itself and all its children.

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_CONSTRAINT

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

#define KZU_PROPERTY_TYPE_CHANGE_FLAG_LAYER_RENDER_QUAD

Property type with this flag informs that rendered quad area of layer changed, i.e.

there are different fragments covered by layer than on previous arrange.

Function Documentation

kzsError kzuPropertyTypesInitialize ( const struct KzcMemoryManager memoryManager)

Initializes property types.

kzsError kzuPropertyTypesUninitialize ( void  )

Uninitializes property types.

kzsError kzuPropertyTypeCreate ( const struct KzcMemoryManager memoryManager,
enum KzuPropertyDataType  dataType,
kzString  name,
struct KzuPropertyType **  out_propertyType 
)

Creates a property type.

kzsError kzuPropertyTypeDelete ( const struct KzuPropertyType propertyType)

Deletes a property type.

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.

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

Loads a property type from KZB.

kzString kzuPropertyTypeGetName ( const struct KzuPropertyType propertyType)

Returns property type's name.

enum KzuPropertyDataType kzuPropertyTypeGetDataType ( const struct KzuPropertyType propertyType)

Gets data type of property.

void kzuPropertyTypeSetInherited ( struct KzuPropertyType propertyType,
kzBool  inherited 
)

Sets the inheritance behavior of the property type.

kzBool kzuPropertyTypeIsInherited ( const struct KzuPropertyType propertyType)

Gets the inheritance behavior of the property type.

void kzuPropertyTypeSetChangeFlags ( struct KzuPropertyType propertyType,
kzU32  flags 
)

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

void kzuPropertyTypeClearChangeFlags ( struct KzuPropertyType propertyType,
kzU32  flags 
)

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

kzU32 kzuPropertyTypeGetChangeFlags ( const struct KzuPropertyType propertyType)

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

kzFloat kzuPropertyFieldGetFloat ( const struct KzuPropertyManager *  propertyManager,
const struct KzuPropertyType propertyType,
enum KzuPropertyField  targetAttribute,
const void targetObject,
kzBool  localValue 
)

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

kzUint kzuPropertyTypeGetIndex ( const struct KzuPropertyType propertyType)

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