kzu_button_common.h File Reference

Common button code. More...

#include <user/scene_graph/kzu_object_common.h>
#include <user/layers/kzu_layer.h>
#include <core/util/math/kzc_vector2.h>
#include <core/util/math/kzc_vector3.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuButtonCommonData
	ButtonCommon's private data struct that is stored in each button object. More...

Functions
kzsError	kzuButtonCommonInitialize2D (struct KzuObjectNode *button)
	Initializer for a KzuLayer button. More...
kzsError	kzuButtonCommonUninitialize2D (struct KzuObjectNode *button)
	Uninitializer for a KzuLayer button. More...
kzsError	kzuButtonCommonMeasure2D (struct KzuLayer *button, const struct KzcVector2 *availableSize, struct KzcVector2 *out_size)
	Measure function for a KzuLayer button. More...
kzsError	kzuButtonCommonArrange2D (struct KzuLayer *button)
	Arrange function for a KzuLayer button. More...
kzsError	kzuButtonCommonInitialize3D (struct KzuObjectNode *button)
	Initializer for a KzuUiComponentNode button. More...
kzsError	kzuButtonCommonUninitialize3D (struct KzuObjectNode *button)
	Uninitializer for a KzuUiComponentNode button. More...
kzsError	kzuButtonCommonMeasure3D (struct KzuUiComponentNode *button, struct KzcVector3 *out_size)
	Measure function for a KzuUiComponentNode button. More...
kzsError	kzuButtonCommonArrange3D (struct KzuUiComponentNode *button)
	Arrange function for a KzuUiComponentNode button. More...
kzsError	kzuButtonCommonOnAttached3D (struct KzuObjectNode *button, struct KzuButtonCommonData *data)
	OnAttached function for 3D. More...
kzsError	kzuButtonCommonOnAttached2D (struct KzuObjectNode *button, struct KzuButtonCommonData *data)
	OnAttached function for 2D. More...
kzsError	kzuButtonCommonOnDetached3D (struct KzuObjectNode *button, struct KzuButtonCommonData *data)
	OnDetached function for 3D. More...
kzsError	kzuButtonCommonOnDetached2D (struct KzuObjectNode *button, struct KzuButtonCommonData *data)
	OnDetached function for 2D. More...
kzsError	kzuButtonCommonSetToggleState (const struct KzuObjectNode *button, kzUint state)
	Sets the current toggle state of the button. More...
kzUint	kzuButtonCommonGetToggleState (const struct KzuObjectNode *button)
	Returns the current toggle state of the button. More...
kzsError	kzuButtonCommonSetToggleStateCount (const struct KzuObjectNode *button, kzUint state)
	Sets the number of toggle states the button has. More...
kzUint	kzuButtonCommonGetToggleStateCount (const struct KzuObjectNode *button)
	Returns the number of toggle states the button has. More...
kzFloat	kzuButtonCommonGetLongPressInterval (const struct KzuObjectNode *button)
	Gets the long release interval property of a button. More...
kzFloat	kzuButtonCommonGetRepeatInterval (const struct KzuObjectNode *button)
	Gets the repeat interval property of a button. More...

Detailed Description

Common button code.

Shared between KzuUiButton, KzuUiToggleButton, KzuButtonLayer, KzuToggleButtonLayer.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuButtonCommonInitialize2D

(

struct KzuObjectNode *

button)

Initializer for a KzuLayer button.

kzsError kzuButtonCommonUninitialize2D

(

struct KzuObjectNode *

button)

Uninitializer for a KzuLayer button.

kzsError kzuButtonCommonMeasure2D	(	struct KzuLayer *	button,
		const struct KzcVector2 *	availableSize,
		struct KzcVector2 *	out_size
	)

Measure function for a KzuLayer button.

kzsError kzuButtonCommonArrange2D

(

struct KzuLayer *

button)

Arrange function for a KzuLayer button.

kzsError kzuButtonCommonInitialize3D

(

struct KzuObjectNode *

button)

Initializer for a KzuUiComponentNode button.

kzsError kzuButtonCommonUninitialize3D

(

struct KzuObjectNode *

button)

Uninitializer for a KzuUiComponentNode button.

kzsError kzuButtonCommonMeasure3D	(	struct KzuUiComponentNode *	button,
		struct KzcVector3 *	out_size
	)

Measure function for a KzuUiComponentNode button.

kzsError kzuButtonCommonArrange3D

(

struct KzuUiComponentNode *

button)

Arrange function for a KzuUiComponentNode button.

kzsError kzuButtonCommonOnAttached3D	(	struct KzuObjectNode *	button,
		struct KzuButtonCommonData *	data
	)

OnAttached function for 3D.

kzsError kzuButtonCommonOnAttached2D	(	struct KzuObjectNode *	button,
		struct KzuButtonCommonData *	data
	)

OnAttached function for 2D.

kzsError kzuButtonCommonOnDetached3D	(	struct KzuObjectNode *	button,
		struct KzuButtonCommonData *	data
	)

OnDetached function for 3D.

kzsError kzuButtonCommonOnDetached2D	(	struct KzuObjectNode *	button,
		struct KzuButtonCommonData *	data
	)

OnDetached function for 2D.

kzsError kzuButtonCommonSetToggleState	(	const struct KzuObjectNode *	button,
		kzUint	state
	)

Sets the current toggle state of the button.

kzUint kzuButtonCommonGetToggleState

(

const struct KzuObjectNode *

button)

Returns the current toggle state of the button.

kzsError kzuButtonCommonSetToggleStateCount	(	const struct KzuObjectNode *	button,
		kzUint	state
	)

Sets the number of toggle states the button has.

Also resets the current toggle state to zero.

kzUint kzuButtonCommonGetToggleStateCount

(

const struct KzuObjectNode *

button)

Returns the number of toggle states the button has.

kzFloat kzuButtonCommonGetLongPressInterval

(

const struct KzuObjectNode *

button)

Gets the long release interval property of a button.

kzFloat kzuButtonCommonGetRepeatInterval

(

const struct KzuObjectNode *

button)

Gets the repeat interval property of a button.