kzu_preview_camera_system.h File Reference

Preview camera system structure contains free and orbit cameras that are used in the preview application. More...

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

Macros
#define	KZU_PREVIEW_CAMERA_FOCUS_MARGIN
	Preview camera focus margin between camera and selection. More...

Enumerations
enum	KzuPreviewCameraMode { KZU_PREVIEW_CAMERA_MODE_DISABLED, KZU_PREVIEW_CAMERA_MODE_FLY_CAMERA, KZU_PREVIEW_CAMERA_MODE_ORBIT_CAMERA }
	Type of preview camera. More...

Functions
kzsError	kzuPreviewCameraSystemCreate (const struct KzcMemoryManager *memoryManager, struct KzuPreviewSystem *previewSystem, struct KzuPreviewCameraSystem **out_previewCameraSystem)
	Creates a new preview camera system object. More...
kzsError	kzuPreviewCameraSystemDelete (struct KzuPreviewCameraSystem *previewCameraSystem)
	Deletes a preview camera system object. More...
kzsError	kzuPreviewCameraSystemUpdate (struct KzuPreviewCameraSystem *previewCameraSystem, kzUint deltaTime)
	Updates the preview camera system. More...
kzsError	kzuPreviewCameraSystemHandleKeyEvent (struct KzuPreviewCameraSystem *previewCameraSystem, enum KzsInputKey keyCode, enum KzsInputKeyDeviceState keyState)
	Notifies the preview camera system of a key device event. More...
kzsError	kzuPreviewCameraSystemHandlePointingEvent (const struct KzuPreviewCameraSystem *previewCameraSystem, const struct KzsInputEventPointer *inputData, kzBool *out_previewInputHandled)
	Notifies the preview camera system of a pointing device event. More...
kzsError	kzuPreviewCameraSystemHandleWindowEvent (struct KzuPreviewCameraSystem *previewCameraSystem, enum KzsEventType eventType)
	Notifies the preview camera system of a window event. More...
kzsError	kzuPreviewCameraSystemSetCameraMode (struct KzuPreviewCameraSystem *previewCameraSystem, enum KzuPreviewCameraMode cameraMode)
	Sets the current preview camera mode. More...
kzsError	kzuPreviewCameraSystemFocusToSelection (const struct KzuPreviewCameraSystem *previewCameraSystem, const struct KzcDynamicArray *nodePaths)
	Sets focus to selected node on preview camera. More...
kzsError	kzuPreviewCameraSystemRevertFocus (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Revers the focus on preview camera to the point where preview camera was previously located. More...
kzsError	kzuPreviewCameraSystemGetSelectionVolume (const struct KzcDynamicArray *nodePaths, const struct KzuTransformedScene *transformedScene, struct KzcVolume *out_volume)
	Utility to get total volume from selected paths. More...
enum KzuPreviewCameraMode	kzuPreviewCameraSystemGetCameraMode (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Gets the current preview camera mode. More...
kzsError	kzuPreviewCameraSystemSetBindCameraMode (struct KzuPreviewCameraSystem *previewCameraSystem, kzBool bindCamera)
	Sets bind camera mode for preview camera, when the values from virtual camera are saved to actual camera. More...
kzBool	kzuPreviewCameraSystemIsBindCameraMode (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Returns if preview camera is in bind camera mode. More...
void	kzuPreviewCameraSystemSetCameraCallback (struct KzuPreviewCameraSystem *previewCameraSystem, KzuPreviewCameraUpdateStateFunction updateStateFunction, void *userData)
	Sets a callback for free camera. More...
struct KzuViewportLayer *	kzuPreviewCameraSystemGetViewportLayer (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Gets viewport layer from preview camera system. More...
kzBool	kzuPreviewCameraSystemIsPickingEnabled (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Is the picking enabled in the preview camera. More...
kzsError	kzuPreviewCameraSystemRefresh (const struct KzuPreviewCameraSystem *previewCameraSystem, const struct KzcMatrix4x4 *transformation)
	Refreshes the preview camera status on the current root layer. More...
kzsError	kzuPreviewCameraCloneData (const struct KzuObjectNode *originalCameraNode, const struct KzuObjectNode *targetCameraNode)
	Helper function to clone camera specific data (properties) from node to target. More...
struct KzuFreeCamera *	kzuPreviewCameraSystemGetFreeCamera (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Gets the free camera. More...
struct KzuOrbitCamera *	kzuPreviewCameraSystemGetOrbitCamera (const struct KzuPreviewCameraSystem *previewCameraSystem)
	Gets the orbit camera. More...

Detailed Description

Preview camera system structure contains free and orbit cameras that are used in the preview application.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_PREVIEW_CAMERA_FOCUS_MARGIN

Preview camera focus margin between camera and selection.

Enumeration Type Documentation

enum KzuPreviewCameraMode

Type of preview camera.

Enumerator
KZU_PREVIEW_CAMERA_MODE_DISABLED	No preview camera.
KZU_PREVIEW_CAMERA_MODE_FLY_CAMERA	Fly camera.
KZU_PREVIEW_CAMERA_MODE_ORBIT_CAMERA	Orbit camera.

Function Documentation

kzsError kzuPreviewCameraSystemCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPreviewSystem *	previewSystem,
		struct KzuPreviewCameraSystem **	out_previewCameraSystem
	)

Creates a new preview camera system object.

kzsError kzuPreviewCameraSystemDelete

(

struct KzuPreviewCameraSystem *

previewCameraSystem)

Deletes a preview camera system object.

kzsError kzuPreviewCameraSystemUpdate	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		kzUint	deltaTime
	)

Updates the preview camera system.

kzsError kzuPreviewCameraSystemHandleKeyEvent	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		enum KzsInputKey	keyCode,
		enum KzsInputKeyDeviceState	keyState
	)

Notifies the preview camera system of a key device event.

kzsError kzuPreviewCameraSystemHandlePointingEvent	(	const struct KzuPreviewCameraSystem *	previewCameraSystem,
		const struct KzsInputEventPointer *	inputData,
		kzBool *	out_previewInputHandled
	)

Notifies the preview camera system of a pointing device event.

kzsError kzuPreviewCameraSystemHandleWindowEvent	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		enum KzsEventType	eventType
	)

Notifies the preview camera system of a window event.

kzsError kzuPreviewCameraSystemSetCameraMode	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		enum KzuPreviewCameraMode	cameraMode
	)

Sets the current preview camera mode.

kzsError kzuPreviewCameraSystemFocusToSelection	(	const struct KzuPreviewCameraSystem *	previewCameraSystem,
		const struct KzcDynamicArray *	nodePaths
	)

Sets focus to selected node on preview camera.

If KZ_NULL has no effect.

kzsError kzuPreviewCameraSystemRevertFocus

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Revers the focus on preview camera to the point where preview camera was previously located.

kzsError kzuPreviewCameraSystemGetSelectionVolume	(	const struct KzcDynamicArray *	nodePaths,
		const struct KzuTransformedScene *	transformedScene,
		struct KzcVolume *	out_volume
	)

Utility to get total volume from selected paths.

enum KzuPreviewCameraMode kzuPreviewCameraSystemGetCameraMode

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Gets the current preview camera mode.

kzsError kzuPreviewCameraSystemSetBindCameraMode	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		kzBool	bindCamera
	)

Sets bind camera mode for preview camera, when the values from virtual camera are saved to actual camera.

kzBool kzuPreviewCameraSystemIsBindCameraMode

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Returns if preview camera is in bind camera mode.

void kzuPreviewCameraSystemSetCameraCallback	(	struct KzuPreviewCameraSystem *	previewCameraSystem,
		KzuPreviewCameraUpdateStateFunction	updateStateFunction,
		void *	userData
	)

Sets a callback for free camera.

Pass KZ_NULL to disable.

struct KzuViewportLayer* kzuPreviewCameraSystemGetViewportLayer

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Gets viewport layer from preview camera system.

kzBool kzuPreviewCameraSystemIsPickingEnabled

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Is the picking enabled in the preview camera.

kzsError kzuPreviewCameraSystemRefresh	(	const struct KzuPreviewCameraSystem *	previewCameraSystem,
		const struct KzcMatrix4x4 *	transformation
	)

Refreshes the preview camera status on the current root layer.

Modify parameter determines whether to reset the preview camera location or keep the old one.

Parameters

transformation

Transformation to be set for preview camera, KZ_NULL to calculate from scene camera.

kzsError kzuPreviewCameraCloneData	(	const struct KzuObjectNode *	originalCameraNode,
		const struct KzuObjectNode *	targetCameraNode
	)

Helper function to clone camera specific data (properties) from node to target.

struct KzuFreeCamera* kzuPreviewCameraSystemGetFreeCamera

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Gets the free camera.

struct KzuOrbitCamera* kzuPreviewCameraSystemGetOrbitCamera

(

const struct KzuPreviewCameraSystem *

previewCameraSystem)

Gets the orbit camera.