kzu_preview_transformation_gizmo_system.h File Reference

Preview transformation gizmo system structure contains the transformation gizmo that is used in the preview application. More...

#include <user/preview/kzu_preview_system.h>
#include <user/util/kzu_transform_gizmo.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>
#include <system/input/kzs_input.h>

Functions
kzsError	kzuPreviewTransformationGizmoSystemCreate (const struct KzcMemoryManager *memoryManager, struct KzuPreviewSystem *previewSystem, struct KzuUIDomain *uiDomain, struct KzuPreviewTransformationGizmoSystem **out_previewTransformationGizmoSystem)
	Creates a new preview transformation gizmo system object. More...
kzsError	KzuPreviewTransformationGizmoSystemDelete (struct KzuPreviewTransformationGizmoSystem *previewTransformationGizmoSystem)
	Deletes a preview transformation gizmo system object. More...
kzsError	kzuPreviewTransformationGizmoSystemHandleKeyEvent (const struct KzuPreviewTransformationGizmoSystem *previewGizmoSystem, enum KzsInputKey keyCode, enum KzsInputKeyDeviceState keyState)
	Handles key events of the preview gizmo system. More...
kzsError	kzuPreviewTransformationGizmoSystemHandleLayerPointingEvent (const struct KzuPreviewTransformationGizmoSystem *previewTransformationGizmoSystem, const struct KzuEngine *engine, const struct KzuUIDomain *uiDomain, const struct KzuViewportLayer *viewportLayer, struct KzuPick *pick, kzInt pointerX, kzInt pointerY, enum KzsInputPointingDeviceState state, kzBool *out_previewInputHandled)
	Notifies the preview transformation gizmo system of a pointing device event. More...
kzsError	kzuPreviewTransformationGizmoSystemRender (const struct KzuPreviewTransformationGizmoSystem *previewTransformationGizmoSystem, struct KzuRenderer *renderer, struct KzuRenderContextStack *renderContextStack, const struct KzuTransformedScene *transformedScene)
	Renders the preview transformation gizmo system. More...
struct KzuTransformGizmo *	kzuPreviewTransformationGizmoSystemGetTransformGizmo (const struct KzuPreviewTransformationGizmoSystem *previewTransformationGizmoSystem)
	Gets the transformation gizmo. More...

Detailed Description

Preview transformation gizmo system structure contains the transformation gizmo that is used in the preview application.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPreviewTransformationGizmoSystemCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPreviewSystem *	previewSystem,
		struct KzuUIDomain *	uiDomain,
		struct KzuPreviewTransformationGizmoSystem **	out_previewTransformationGizmoSystem
	)

Creates a new preview transformation gizmo system object.

kzsError KzuPreviewTransformationGizmoSystemDelete

(

struct KzuPreviewTransformationGizmoSystem *

previewTransformationGizmoSystem)

Deletes a preview transformation gizmo system object.

kzsError kzuPreviewTransformationGizmoSystemHandleKeyEvent	(	const struct KzuPreviewTransformationGizmoSystem *	previewGizmoSystem,
		enum KzsInputKey	keyCode,
		enum KzsInputKeyDeviceState	keyState
	)

Handles key events of the preview gizmo system.

kzsError kzuPreviewTransformationGizmoSystemHandleLayerPointingEvent	(	const struct KzuPreviewTransformationGizmoSystem *	previewTransformationGizmoSystem,
		const struct KzuEngine *	engine,
		const struct KzuUIDomain *	uiDomain,
		const struct KzuViewportLayer *	viewportLayer,
		struct KzuPick *	pick,
		kzInt	pointerX,
		kzInt	pointerY,
		enum KzsInputPointingDeviceState	state,
		kzBool *	out_previewInputHandled
	)

Notifies the preview transformation gizmo system of a pointing device event.

kzsError kzuPreviewTransformationGizmoSystemRender	(	const struct KzuPreviewTransformationGizmoSystem *	previewTransformationGizmoSystem,
		struct KzuRenderer *	renderer,
		struct KzuRenderContextStack *	renderContextStack,
		const struct KzuTransformedScene *	transformedScene
	)

Renders the preview transformation gizmo system.

struct KzuTransformGizmo* kzuPreviewTransformationGizmoSystemGetTransformGizmo

(

const struct KzuPreviewTransformationGizmoSystem *

previewTransformationGizmoSystem)

Gets the transformation gizmo.