Basic layouting definitions. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuUiGridLayoutDefinition
	Grid layouting size definition. More...

struct	KzuUiGridLayoutObjectLocationWorkspace
	Information used to store the state between function calls when locating objects. More...

Enumerations
enum	KzuUiGridLayoutSizeMode { KZU_UI_GRID_LAYOUT_SIZE_USER, KZU_UI_GRID_LAYOUT_SIZE_AUTO, KZU_UI_GRID_LAYOUT_SIZE_WEIGHED }
	Grid layout size mode for rows and columns. More...

enum	KzuStackLayoutDirection { KZU_STACK_LAYOUT_DIRECTION_X, KZU_STACK_LAYOUT_DIRECTION_Y, KZU_STACK_LAYOUT_DIRECTION_Z }
	Stack layout direction enumeration. More...

enum	KzuUiGridLayoutDirection { KZU_GRID_LAYOUT_DIRECTION_RIGHT, KZU_GRID_LAYOUT_DIRECTION_DOWN }
	Direction of layout of grid layout. More...

Functions
kzBool	kzuUiGridLayoutGetAddressProperty_private (const struct KzuObjectNode objectNode, const struct KzuPropertyType propertyType, kzUint minValue, kzUint *out_address)
	Gets an address property. More...

void	kzuUiGridLayoutGetObjectLocation_private (const struct KzuObjectNode objectNode, struct KzuUiGridLayoutObjectLocationWorkspace workspace, kzUint out_row, kzUint out_column)
	Gets location of the given object. More...

kzsError	kzuGridLayoutObjectLocationWorkspace_private (const struct KzuObjectNode objectNode, kzUint rowCount, kzUint columnCount, struct KzuUiGridLayoutObjectLocationWorkspace workspace)
	Initialize an object location workspace. More...

kzUint	kzuUiGridLayoutGetAddressProperty (const struct KzuObjectNode objectNode, const struct KzuPropertyType propertyType, kzUint minValue)
	Get the address (row or column index) from a child of a grid layout. More...

kzUint	kzuUiGridLayoutGetObjectColumn (const struct KzuObjectNode *gridLayoutItem)
	Get a column for an object in a grid. More...

kzsError	kzuUiGridLayoutSetObjectColumn (const struct KzuObjectNode *gridLayoutItem, kzUint column)
	Set a column for an object in a grid. More...

kzUint	kzuUiGridLayoutGetObjectColumnSpan (const struct KzuObjectNode *gridLayoutItem)
	Get column span for an object in a grid. More...

kzsError	kzuUiGridLayoutSetObjectColumnSpan (const struct KzuObjectNode *gridLayoutItem, kzUint columnSpan)
	Set column span for an object in a grid. More...

kzUint	kzuUiGridLayoutGetObjectRow (const struct KzuObjectNode *gridLayoutItem)
	Get a row for an object in a grid. More...

kzsError	kzuUiGridLayoutSetObjectRow (const struct KzuObjectNode *gridLayoutItem, kzUint row)
	Set a row for an object in a grid. More...

kzUint	kzuUiGridLayoutGetObjectRowSpan (const struct KzuObjectNode *gridLayoutItem)
	Get row span for an object in a grid. More...

kzsError	kzuUiGridLayoutSetObjectRowSpan (const struct KzuObjectNode *gridLayoutItem, kzUint rowSpan)
	Set row span for an object in a grid. More...

void	kzuUiGridLayoutCalculateWeighedSizes (const struct KzcDynamicArray *definitions, kzFloat weightMultiplier)
	Calculate grid layout weighed sizes. More...

void	kzuUiGridLayoutCalculateOffsets (const struct KzcDynamicArray *definitions)
	Calculate grid layout offsets. More...

kzFloat	kzuUiGridLayoutFindMaximumAccumulated (const struct KzcDynamicArray *definitions)
	Find maximum accumulated space from grid layout definitions. More...

kzsError	kzuUiGridLayoutDefinitionArrayDelete (struct KzcDynamicArray *definitionArray)
	Delete a dynamic array consisting of grid layout definitions. More...

kzsError	kzuUiGridLayoutParseDefinitions (const struct KzcMemoryManager memoryManager, kzString definitionCollection, struct KzcDynamicArray definitions)
	Parse grid layout definition array from property string. More...

kzFloat	kzuUiGridLayoutResetDefinitionsAndCalculateWeights (const struct KzcDynamicArray *definitions)
	Reset grid layout definition array and calculate assigned weight. More...

kzsError	kzuUiLayoutGetBoundingVolume (const struct KzuObjectNode objectNode, struct KzuBoundingVolume out_boundingVolume)
	Bounding volume getter shared between 3D layouts. More...

Detailed Description

Basic layouting definitions.

Common for both 3D and 2D layouts.

Enumeration Type Documentation

enum KzuUiGridLayoutSizeMode

Grid layout size mode for rows and columns.

Enumerator
KZU_UI_GRID_LAYOUT_SIZE_USER	User specified size.
KZU_UI_GRID_LAYOUT_SIZE_AUTO	Size based on content.
KZU_UI_GRID_LAYOUT_SIZE_WEIGHED	Size based on content with a weight factor applied.

enum KzuStackLayoutDirection

Stack layout direction enumeration.

Enumerator
KZU_STACK_LAYOUT_DIRECTION_X	Layout direction X.
KZU_STACK_LAYOUT_DIRECTION_Y	Layout direction Y.
KZU_STACK_LAYOUT_DIRECTION_Z	Layout direction Z.

enum KzuUiGridLayoutDirection

Direction of layout of grid layout.

Enumerator
KZU_GRID_LAYOUT_DIRECTION_RIGHT	Layout first right, then down.
KZU_GRID_LAYOUT_DIRECTION_DOWN	Layout first down, then right.

Function Documentation

kzBool kzuUiGridLayoutGetAddressProperty_private	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzUint	minValue,
		kzUint *	out_address
	)

Gets an address property.

Returns whether it was found.

void kzuUiGridLayoutGetObjectLocation_private	(	const struct KzuObjectNode *	objectNode,
		struct KzuUiGridLayoutObjectLocationWorkspace *	workspace,
		kzUint *	out_row,
		kzUint *	out_column
	)

Gets location of the given object.

Requires a workspace to store state between calls.

kzsError kzuGridLayoutObjectLocationWorkspace_private	(	const struct KzuObjectNode *	objectNode,
		kzUint	rowCount,
		kzUint	columnCount,
		struct KzuUiGridLayoutObjectLocationWorkspace *	workspace
	)

Initialize an object location workspace.

Used in laying out grid items.

kzUint kzuUiGridLayoutGetAddressProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzUint	minValue
	)

Get the address (row or column index) from a child of a grid layout.

kzUint kzuUiGridLayoutGetObjectColumn ( const struct KzuObjectNode * gridLayoutItem)

Get a column for an object in a grid.

kzsError kzuUiGridLayoutSetObjectColumn	(	const struct KzuObjectNode *	gridLayoutItem,
		kzUint	column
	)

Set a column for an object in a grid.

kzUint kzuUiGridLayoutGetObjectColumnSpan ( const struct KzuObjectNode * gridLayoutItem)

Get column span for an object in a grid.

kzsError kzuUiGridLayoutSetObjectColumnSpan	(	const struct KzuObjectNode *	gridLayoutItem,
		kzUint	columnSpan
	)

Set column span for an object in a grid.

kzUint kzuUiGridLayoutGetObjectRow ( const struct KzuObjectNode * gridLayoutItem)

Get a row for an object in a grid.

kzsError kzuUiGridLayoutSetObjectRow	(	const struct KzuObjectNode *	gridLayoutItem,
		kzUint	row
	)

Set a row for an object in a grid.

kzUint kzuUiGridLayoutGetObjectRowSpan ( const struct KzuObjectNode * gridLayoutItem)

Get row span for an object in a grid.

kzsError kzuUiGridLayoutSetObjectRowSpan	(	const struct KzuObjectNode *	gridLayoutItem,
		kzUint	rowSpan
	)

Set row span for an object in a grid.

void kzuUiGridLayoutCalculateWeighedSizes	(	const struct KzcDynamicArray *	definitions,
		kzFloat	weightMultiplier
	)

Calculate grid layout weighed sizes.

void kzuUiGridLayoutCalculateOffsets ( const struct KzcDynamicArray * definitions)

Calculate grid layout offsets.

kzFloat kzuUiGridLayoutFindMaximumAccumulated ( const struct KzcDynamicArray * definitions)

Find maximum accumulated space from grid layout definitions.

kzsError kzuUiGridLayoutDefinitionArrayDelete ( struct KzcDynamicArray * definitionArray)

Delete a dynamic array consisting of grid layout definitions.

kzsError kzuUiGridLayoutParseDefinitions	(	const struct KzcMemoryManager *	memoryManager,
		kzString	definitionCollection,
		struct KzcDynamicArray *	definitions
	)

Parse grid layout definition array from property string.

kzFloat kzuUiGridLayoutResetDefinitionsAndCalculateWeights ( const struct KzcDynamicArray * definitions)

Reset grid layout definition array and calculate assigned weight.

kzsError kzuUiLayoutGetBoundingVolume	(	const struct KzuObjectNode *	objectNode,
		struct KzuBoundingVolume *	out_boundingVolume
	)

Bounding volume getter shared between 3D layouts.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation