kzu_debug_composer.h File Reference

Grid debug object composer. More...

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

Functions
kzsError	kzuDebugComposerCreate (const struct KzcMemoryManager *memoryManager, struct KzuPropertyManager *propertyManager, const struct KzuUIDomain *uiDomain, struct KzuDebugComposer **out_debugComposer)
	Creates new debug composer. More...
struct KzuComposer *	kzuDebugComposerToComposer (const struct KzuDebugComposer *debugComposer)
	Casts a debug composer to composer. More...
struct KzuDebugComposer *	kzuDebugComposerFromComposer (const struct KzuComposer *composer)
	Casts composer to a debug composer. More...
void	kzuDebugComposerSetBoundingBoxesEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set bounding box display status. More...
kzBool	kzuDebugComposerIsBoundingBoxesEnabled (const struct KzuDebugComposer *debugComposer)
	Tell if bounding boxes are displayed. More...
void	kzuDebugComposerSetGridEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set grid display status. More...
kzBool	kzuDebugComposerIsGridEnabled (const struct KzuDebugComposer *debugComposer)
	Tell if grid is displayed. More...
void	kzuDebugComposerSetDebugObjectsEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set debug objects display status. More...
kzBool	kzuDebugComposerIsDebugObjectsEnabled (const struct KzuDebugComposer *debugComposer)
	Tell if debug objects are displayed. More...
void	kzuDebugComposerSetAllocatedSizeEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set allocated size display status. More...
kzBool	kzuDebugComposerIsAllocatedSizeEnabled (const struct KzuDebugComposer *debugComposer)
	Get allocated size display status. More...
void	kzuDebugComposerSetActualSizeEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set actual size display status. More...
kzBool	kzuDebugComposerIsActualSizeEnabled (const struct KzuDebugComposer *debugComposer)
	Get actual size display status. More...
void	kzuDebugComposerSetSelectionEnabled (struct KzuDebugComposer *debugComposer, kzBool enabled)
	Set selection display status. More...
kzBool	kzuDebugComposerIsSelectionEnabled (const struct KzuDebugComposer *debugComposer)
	Get selection display status. More...
kzBool	kzuDebugComposerIsTransformGizmoEnabled (const struct KzuDebugComposer *debugComposer)
	Tell if transform gizmo exists and is enabled. More...
void	kzuDebugComposerSetPreviewSystem (struct KzuDebugComposer *debugComposer, struct KzuPreviewSystem *previewSystem)
	Set the preview system. More...

Detailed Description

Grid debug object composer.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuDebugComposerCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPropertyManager *	propertyManager,
		const struct KzuUIDomain *	uiDomain,
		struct KzuDebugComposer **	out_debugComposer
	)

Creates new debug composer.

struct KzuComposer* kzuDebugComposerToComposer

(

const struct KzuDebugComposer *

debugComposer)

Casts a debug composer to composer.

struct KzuDebugComposer* kzuDebugComposerFromComposer

(

const struct KzuComposer *

composer)

Casts composer to a debug composer.

void kzuDebugComposerSetBoundingBoxesEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set bounding box display status.

kzBool kzuDebugComposerIsBoundingBoxesEnabled

(

const struct KzuDebugComposer *

debugComposer)

Tell if bounding boxes are displayed.

void kzuDebugComposerSetGridEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set grid display status.

kzBool kzuDebugComposerIsGridEnabled

(

const struct KzuDebugComposer *

debugComposer)

Tell if grid is displayed.

void kzuDebugComposerSetDebugObjectsEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set debug objects display status.

kzBool kzuDebugComposerIsDebugObjectsEnabled

(

const struct KzuDebugComposer *

debugComposer)

Tell if debug objects are displayed.

void kzuDebugComposerSetAllocatedSizeEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set allocated size display status.

kzBool kzuDebugComposerIsAllocatedSizeEnabled

(

const struct KzuDebugComposer *

debugComposer)

Get allocated size display status.

void kzuDebugComposerSetActualSizeEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set actual size display status.

kzBool kzuDebugComposerIsActualSizeEnabled

(

const struct KzuDebugComposer *

debugComposer)

Get actual size display status.

void kzuDebugComposerSetSelectionEnabled	(	struct KzuDebugComposer *	debugComposer,
		kzBool	enabled
	)

Set selection display status.

kzBool kzuDebugComposerIsSelectionEnabled

(

const struct KzuDebugComposer *

debugComposer)

Get selection display status.

kzBool kzuDebugComposerIsTransformGizmoEnabled

(

const struct KzuDebugComposer *

debugComposer)

Tell if transform gizmo exists and is enabled.

void kzuDebugComposerSetPreviewSystem	(	struct KzuDebugComposer *	debugComposer,
		struct KzuPreviewSystem *	previewSystem
	)

Set the preview system.