kzu_ui_component_base.h File Reference

UI component node private members. More...

#include <user/scene_graph/kzu_object_base.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuUiComponentNodeClass
	Class definition for UI components. More...
struct	KzuUiComponentNode
	Structure for graphical user interface component node, inherited from KzuObjectNode. More...

Typedefs
typedef kzsError(*	KzuUiComponentNodeMeasureFunction )(struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize)
	Function type to measure desired size of the UI component. More...
typedef kzsError(*	KzuUiComponentNodeArrangeFunction )(struct KzuUiComponentNode *componentNode)
	Function type to arrange UI component to space reserved for it. More...

Functions
kzsError	kzuUiComponentNodeCreate_protected (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, const struct KzuUiComponentNodeClass *componentNodeClass, struct KzuUiComponentNode *componentNode)
	Creates a UI component. More...
kzsError	kzuUiComponentNodeInitialize_protected (struct KzuObjectNode *objectNode)
	Initializes a UI component. More...
kzsError	kzuUiComponentNodeUninitialize_protected (struct KzuObjectNode *objectNode)
	Uninitializes a UI component. More...
kzsError	kzuUiComponentNodeOnPropertyChanged_protected (struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, enum KzuPropertyNotificationReason reason)
	Implementation of UI component property change callback. More...
kzsError	kzuUiComponentNodeMeasure_protected (struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize)
	Default measure implementation. More...
kzsError	kzuUiComponentNodeCenteredMeasure_protected (struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize)
	Default implementation of measure for a layout that accommodates all children at its center. More...
kzsError	kzuUiComponentNodeCenteredArrange_protected (struct KzuUiComponentNode *componentNode)
	Default implementation of arrange for a layout that accommodates all children at its center. More...
kzsError	kzuUiComponentNodeArrange_protected (struct KzuUiComponentNode *componentNode)
	Default arrange implementation. More...
kzsError	kzuUiComponentNodeValidateRender_protected (struct KzuUiComponentNode *componentNode)
	Default validate render implementation. More...
kzsError	kzuUiComponentNodeCopy_protected (const struct KzuObjectNode *sourceObjectNode, struct KzuObjectNode *targetObjectNode)
	Default component copy implementation. More...
kzsError	kzuUiComponentNodeRender_protected (const struct KzuObjectNode *objectNode, struct KzuRenderer *renderer, const struct KzuTransformedObjectNode *transformedObjectNode, struct KzcMatrix4x4 *worldTransformation)
	Default render implementation. More...
kzsError	kzuUiComponentNodeGetBoundingVolume_protected (const struct KzuObjectNode *objectNode, struct KzuBoundingVolume **out_boundingVolume)
	Default bounding volume getter implementation. More...
kzsError	kzuUiComponentNodeLoadFromKZB_protected (struct KzuObjectNode *objectNode, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Default implementation for loading UI component node from KZB. More...

Variables
struct KzuObjectNodeClass	KZU_UI_COMPONENT_NODE_CLASS
	User interface component's object node class. More...

Detailed Description

UI component node private members.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzuUiComponentNodeMeasureFunction)(struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize)

Function type to measure desired size of the UI component.

typedef kzsError(* KzuUiComponentNodeArrangeFunction)(struct KzuUiComponentNode *componentNode)

Function type to arrange UI component to space reserved for it.

Function Documentation

kzsError kzuUiComponentNodeCreate_protected	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		const struct KzuUiComponentNodeClass *	componentNodeClass,
		struct KzuUiComponentNode *	componentNode
	)

Creates a UI component.

kzsError kzuUiComponentNodeInitialize_protected

(

struct KzuObjectNode *

objectNode)

Initializes a UI component.

kzsError kzuUiComponentNodeUninitialize_protected

(

struct KzuObjectNode *

objectNode)

Uninitializes a UI component.

kzsError kzuUiComponentNodeOnPropertyChanged_protected	(	struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		enum KzuPropertyNotificationReason	reason
	)

Implementation of UI component property change callback.

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

Default measure implementation.

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

Default implementation of measure for a layout that accommodates all children at its center.

kzsError kzuUiComponentNodeCenteredArrange_protected

(

struct KzuUiComponentNode *

componentNode)

Default implementation of arrange for a layout that accommodates all children at its center.

kzsError kzuUiComponentNodeArrange_protected

(

struct KzuUiComponentNode *

componentNode)

Default arrange implementation.

kzsError kzuUiComponentNodeValidateRender_protected

(

struct KzuUiComponentNode *

componentNode)

Default validate render implementation.

kzsError kzuUiComponentNodeCopy_protected	(	const struct KzuObjectNode *	sourceObjectNode,
		struct KzuObjectNode *	targetObjectNode
	)

Default component copy implementation.

kzsError kzuUiComponentNodeRender_protected	(	const struct KzuObjectNode *	objectNode,
		struct KzuRenderer *	renderer,
		const struct KzuTransformedObjectNode *	transformedObjectNode,
		struct KzcMatrix4x4 *	worldTransformation
	)

Default render implementation.

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

Default bounding volume getter implementation.

kzsError kzuUiComponentNodeLoadFromKZB_protected	(	struct KzuObjectNode *	objectNode,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Default implementation for loading UI component node from KZB.

Variable Documentation

struct KzuObjectNodeClass KZU_UI_COMPONENT_NODE_CLASS

User interface component's object node class.