kzu_object_source.h File Reference

Object source. More...

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

Namespaces
	kanzi

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

Functions
kzsError	kzuCombinerObjectSourceCreate (kanzi::Domain *domain, kanzi::string_view name, struct KzuObjectSource **out_objectSource)
	Creates an object source, which combines several object sources together. More...
kzsError	kzuCombinerObjectSourceLoadFromKZB (struct KzuObjectSource *objectSource, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads combiner object source from KZB. 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...
void	kzuObjectSourceSetInput (KzuObjectSource *objectSource, kanzi::ObjectSourceSharedPtr 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, kanzi::TransformedScene3D *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...

Detailed Description

Object source.

Object source that can be coupled with filters.

Copyright 2008-2020 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	(	kanzi::Domain *	domain,
		kanzi::string_view	name,
		struct KzuObjectSource **	out_objectSource
	)

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

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

Loads combiner object source from KZB.

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.

void kzuObjectSourceSetInput	(	KzuObjectSource *	objectSource,
		kanzi::ObjectSourceSharedPtr	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,
		kanzi::TransformedScene3D *	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.