kzu_object_source.h File Reference

Object source. More...

#include "kzu_object_source_common.h"
#include <user/common/kzu_user.h>
#include <user/resource/kzu_resource_common.h>
#include <core/util/collection/kzc_comparator.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Macros
#define	KZU_OBJECT_SOURCE_RUNTIME_CHANGE_FLAG_LOD_APPLY_REQUIRED
	Change flag specifying the LOD Apply is required. More...

Functions
kzsError	kzuCombinerObjectSourceCreate (const struct KzcMemoryManager *memoryManager, struct KzuUIDomain *uiDomain, kzString name, struct KzuObjectSource **out_objectSource)
	Creates an object source, which combines several object sources together. More...
kzsError	kzuObjectSourceDelete (struct KzuObjectSource *objectSource)
	Deletes an object source. More...
kzsError	kzuCombinerObjectSourceLoadFromKZB (struct KzuObjectSource *objectSource, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads combiner object source from KZB. More...
kzsError	kzuCombinerObjectSourceInitialize (struct KzuObjectSource *objectSource, kzUint inputCount, struct KzuObjectSource *const *inputs)
	Initializes combiner object source. More...
kzsError	kzuObjectSourceFetchGraph (const struct KzuObjectSource *objectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, struct KzcDynamicArray **out_objects)
	Gets transformed object node from object source. More...
kzBool	kzuObjectSourceIsFilter (const struct KzuObjectSource *objectSource)
	Checks if the object source is an object set filter. More...
kzsError	kzuFilterObjectSourceSetInput (const struct KzuObjectSource *objectSource, struct KzuObjectSource *input)
	Sets input data for object source. More...
kzsError	kzuObjectSourceSetInput (const struct KzuObjectSource *objectSource, struct KzuObjectSource *inputObjectSource)
	Sets input for object source. More...
struct KzuObjectSource *	kzuObjectSourceGetInput (const struct KzuObjectSource *objectSource)
	Gets an input from object source, KZ_NULL if not specified. More...
kzsError	kzuObjectSourceRuntimeDataCreate (const struct KzcMemoryManager *memoryManager, struct KzuTransformedScene *transformedScene, struct KzuObjectSourceRuntimeData **out_runtimeData)
	Creates an object for object source reset data. More...
void	kzuObjectSourceRuntimeDataSetChangeFlag (struct KzuObjectSourceRuntimeData *runtimeData, kzU32 flag)
	Sets change flag for the object source runtime data. More...
void	kzuObjectSourceRuntimeDataClearChangeFlag (struct KzuObjectSourceRuntimeData *runtimeData, kzU32 flag)
	Clears object source runtime data change flag. More...
kzBool	kzuObjectSourceRuntimeDataIsChangeFlagSet (const struct KzuObjectSourceRuntimeData *runtimeData, kzU32 flag)
	Returns if specific change flag is set for object source runtime data. More...
kzsError	kzuObjectSourceResetRuntimeOutputData (const struct KzuObjectSource *objectSource, const struct KzuObjectSourceRuntimeData *objectSourceRuntimeData)
	Resets object source's runtime data, i.e. More...
enum KzuObjectSourceType	kzuObjectSourceGetType (const struct KzuObjectSource *objectSource)
	Returns type of object source. More...
struct KzuResource *	kzuObjectSourceToResource (const struct KzuObjectSource *objectSource)
	Converts object source to resource. More...
struct KzuObjectSource *	kzuObjectSourceFromResource (const struct KzuResource *resource)
	Converts object source from resource. More...
struct KzuObjectSource *	kzuObjectSourceCastFromResource (const struct KzuResource *resource)
	Casts object source from resource, KZ_NULL if invalid type. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_OBJECT_SOURCE
	Resource type identifier for object source. More...

Detailed Description

Object source.

Object source that can be coupled with filters.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_OBJECT_SOURCE_RUNTIME_CHANGE_FLAG_LOD_APPLY_REQUIRED

Change flag specifying the LOD Apply is required.

Function Documentation

kzsError kzuCombinerObjectSourceCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuObjectSource **	out_objectSource
	)

Creates an object source, which combines several object sources together.

kzsError kzuObjectSourceDelete

(

struct KzuObjectSource *

objectSource)

Deletes an object source.

kzsError kzuCombinerObjectSourceLoadFromKZB	(	struct KzuObjectSource *	objectSource,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads combiner object source from KZB.

kzsError kzuCombinerObjectSourceInitialize	(	struct KzuObjectSource *	objectSource,
		kzUint	inputCount,
		struct KzuObjectSource *const *	inputs
	)

Initializes combiner object source.

kzsError kzuObjectSourceFetchGraph	(	const struct KzuObjectSource *	objectSource,
		const struct KzuObjectSourceRuntimeData *	runtimeData,
		const struct KzuTransformedObjectNode *	camera,
		struct KzcDynamicArray **	out_objects
	)

Gets transformed object node from object source.

out_objects is filled with transformed object nodes.

kzBool kzuObjectSourceIsFilter

(

const struct KzuObjectSource *

objectSource)

Checks if the object source is an object set filter.

kzsError kzuFilterObjectSourceSetInput	(	const struct KzuObjectSource *	objectSource,
		struct KzuObjectSource *	input
	)

Sets input data for object source.

kzsError kzuObjectSourceSetInput	(	const struct KzuObjectSource *	objectSource,
		struct KzuObjectSource *	inputObjectSource
	)

Sets input for object source.

In case of root object source does nothing. Combiner object source not supported.

struct KzuObjectSource* kzuObjectSourceGetInput

(

const struct KzuObjectSource *

objectSource)

Gets an input from object source, KZ_NULL if not specified.

kzsError kzuObjectSourceRuntimeDataCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuTransformedScene *	transformedScene,
		struct KzuObjectSourceRuntimeData **	out_runtimeData
	)

Creates an object for object source reset data.

void kzuObjectSourceRuntimeDataSetChangeFlag	(	struct KzuObjectSourceRuntimeData *	runtimeData,
		kzU32	flag
	)

Sets change flag for the object source runtime data.

void kzuObjectSourceRuntimeDataClearChangeFlag	(	struct KzuObjectSourceRuntimeData *	runtimeData,
		kzU32	flag
	)

Clears object source runtime data change flag.

kzBool kzuObjectSourceRuntimeDataIsChangeFlagSet	(	const struct KzuObjectSourceRuntimeData *	runtimeData,
		kzU32	flag
	)

Returns if specific change flag is set for object source runtime data.

kzsError kzuObjectSourceResetRuntimeOutputData	(	const struct KzuObjectSource *	objectSource,
		const struct KzuObjectSourceRuntimeData *	objectSourceRuntimeData
	)

Resets object source's runtime data, i.e.

cache is cleaned.

enum KzuObjectSourceType kzuObjectSourceGetType

(

const struct KzuObjectSource *

objectSource)

Returns type of object source.

struct KzuResource* kzuObjectSourceToResource

(

const struct KzuObjectSource *

objectSource)

Converts object source to resource.

struct KzuObjectSource* kzuObjectSourceFromResource

(

const struct KzuResource *

resource)

Converts object source from resource.

struct KzuObjectSource* kzuObjectSourceCastFromResource

(

const struct KzuResource *

resource)

Casts object source from resource, KZ_NULL if invalid type.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_OBJECT_SOURCE

Resource type identifier for object source.