kzu_ui_component.h File Reference

User interface component. More...

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

Functions
kzsError	kzuUiComponentNodeMeasure (struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize)
	Calls the measure function of the user interface component. More...
kzsError	kzuUiComponentNodeArrange (struct KzuUiComponentNode *componentNode)
	Calls the arrange function of the user interface component. More...
struct KzuUiComponentNode *	kzuUiComponentNodeFromObjectNode (const struct KzuObjectNode *objectNode)
	Casts UI component node from object node. More...
struct KzuObjectNode *	kzuUiComponentNodeToObjectNode (const struct KzuUiComponentNode *componentNode)
	Casts UI component node to object node. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_UI_COMPONENT
	Object type identifier for component objects. More...

Detailed Description

User interface component.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuUiComponentNodeMeasure	(	struct KzuUiComponentNode *	componentNode,
		struct KzcVector3 *	out_coreDesiredSize
	)

Calls the measure function of the user interface component.

Parameters

componentNode	The UI component to measure.
out_coreDesiredSize	The desired size of the component calculated in the measure function of the component.

Returns

KZS_SUCCESS on success.

kzsError kzuUiComponentNodeArrange

(

struct KzuUiComponentNode *

componentNode)

Calls the arrange function of the user interface component.

The actual size of the component must be set before calling this function.

Parameters

componentNode

The UI component to arrange.

Returns

KZS_SUCCESS on success.

struct KzuUiComponentNode* kzuUiComponentNodeFromObjectNode

(

const struct KzuObjectNode *

objectNode)

Casts UI component node from object node.

struct KzuObjectNode* kzuUiComponentNodeToObjectNode

(

const struct KzuUiComponentNode *

componentNode)

Casts UI component node to object node.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_UI_COMPONENT

Object type identifier for component objects.