kzu_object_source_base.h File Reference

Object source private members. More...

#include "kzu_object_source_common.h"
#include <user/common/kzu_user.h>
#include <user/resource/kzu_resource_base.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuFilterConfiguration
	Configuration for filter types. More...
struct	KzuSortObjectSourceConfiguration
	Configuration for sort object sources. More...
struct	KzuObjectSource
	Structure for object source. More...
struct	KzuFilterObjectSource
	Structure for filter object source. More...
struct	KzuSortObjectSource
	Sort object source. More...
struct	KzuObjectSourceRuntimeData
	Structure passed as parameter to object source reset. More...

Typedefs
typedef kzsError(*	KzuFilterResetFunction )(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData)
	Function type for per frame filter initialization. More...
typedef kzsError(*	KzuFilterStartFunction )(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzcDynamicArray *inputObjects)
	Function type for filter start function. More...
typedef kzsError(*	KzuFilterDeleteFunction )(struct KzuFilterObjectSource *filterObjectSource)
	Function type for cleaning up filter. More...
typedef kzsError(*	KzuFilterApplyFunction )(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzuTransformedObjectNode *object, kzBool *out_accepted)
	Function type for determining whether to accept given object or not. More...
typedef kzsError(*	KzuSortObjectSourceResetFunction )(struct KzuSortObjectSource *sortObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData)
	Function type for per frame sort object source initialization. More...
typedef kzsError(*	KzuSortObjectSourceStartFunction )(struct KzuSortObjectSource *sortObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzcDynamicArray *inputObjects)
	Function type for sort start function. More...
typedef kzsError(*	KzuSortObjectSourceDeleteFunction )(struct KzuSortObjectSource *sortObjectSource)
	Function type for cleaning up sort object source. More...
typedef kzInt(*	KzuSortObjectSourceComparatorFunction )(const struct KzuTransformedObjectNode *first, const struct KzuTransformedObjectNode *second, const struct KzcMatrix4x4 *cameraMatrix, const struct KzuObjectSourceRuntimeData *runtimeData)
	Function type for sorting transformed object nodes with sort object sources. More...

Functions
kzsError	kzuObjectSourceCreate_protected (enum KzuObjectSourceType type, struct KzuUIDomain *uiDomain, kzString name, struct KzuObjectSource *objectSource)
	Creates an object source. More...
kzsError	kzuFilterObjectSourceCreate_protected (const struct KzuFilterConfiguration *configuration, struct KzuUIDomain *uiDomain, kzString name, struct KzuFilterObjectSource *filterObjectSource)
	Creates a filter object source. More...
kzsError	kzuFilterObjectSourceLoadFromKZB_protected (struct KzuFilterObjectSource *filterObjectSource, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads a filter object source from KZB. More...
kzsError	kzuFilterObjectSourceInitialize_protected (struct KzuFilterObjectSource *filterObjectSource, struct KzuObjectSource *input, kzBool isExclusive)
	Initializes a filter object source. More...
struct KzuFilterObjectSource *	kzuFilterObjectSourceFromObjectSource_protected (const struct KzuObjectSource *objectSource)
	Converts an object source into a filter object source. More...
kzsError	kzuObjectSourceSetRuntimeCacheData_protected (const struct KzuObjectSource *objectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const void *data)
	Store the cache data for an object source. More...
void *	kzuObjectSourceGetRuntimeCacheData_protected (const struct KzuObjectSource *objectSource, const struct KzuObjectSourceRuntimeData *runtimeData)
	Get the cache data of an object source. More...

Detailed Description

Object source private members.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzuFilterResetFunction)(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData)

Function type for per frame filter initialization.

typedef kzsError(* KzuFilterStartFunction)(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzcDynamicArray *inputObjects)

Function type for filter start function.

This is called just before apply, but only once per frame

typedef kzsError(* KzuFilterDeleteFunction)(struct KzuFilterObjectSource *filterObjectSource)

Function type for cleaning up filter.

typedef kzsError(* KzuFilterApplyFunction)(struct KzuFilterObjectSource *filterObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzuTransformedObjectNode *object, kzBool *out_accepted)

Function type for determining whether to accept given object or not.

typedef kzsError(* KzuSortObjectSourceResetFunction)(struct KzuSortObjectSource *sortObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData)

Function type for per frame sort object source initialization.

typedef kzsError(* KzuSortObjectSourceStartFunction)(struct KzuSortObjectSource *sortObjectSource, const struct KzuObjectSourceRuntimeData *runtimeData, const struct KzuTransformedObjectNode *camera, const struct KzcDynamicArray *inputObjects)

Function type for sort start function.

This is called just before sorting.

typedef kzsError(* KzuSortObjectSourceDeleteFunction)(struct KzuSortObjectSource *sortObjectSource)

Function type for cleaning up sort object source.

typedef kzInt(* KzuSortObjectSourceComparatorFunction)(const struct KzuTransformedObjectNode *first, const struct KzuTransformedObjectNode *second, const struct KzcMatrix4x4 *cameraMatrix, const struct KzuObjectSourceRuntimeData *runtimeData)

Function type for sorting transformed object nodes with sort object sources.

Function Documentation

kzsError kzuObjectSourceCreate_protected	(	enum KzuObjectSourceType	type,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuObjectSource *	objectSource
	)

Creates an object source.

kzsError kzuFilterObjectSourceCreate_protected	(	const struct KzuFilterConfiguration *	configuration,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuFilterObjectSource *	filterObjectSource
	)

Creates a filter object source.

kzsError kzuFilterObjectSourceLoadFromKZB_protected	(	struct KzuFilterObjectSource *	filterObjectSource,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads a filter object source from KZB.

kzsError kzuFilterObjectSourceInitialize_protected	(	struct KzuFilterObjectSource *	filterObjectSource,
		struct KzuObjectSource *	input,
		kzBool	isExclusive
	)

Initializes a filter object source.

struct KzuFilterObjectSource* kzuFilterObjectSourceFromObjectSource_protected

(

const struct KzuObjectSource *

objectSource)

Converts an object source into a filter object source.

kzsError kzuObjectSourceSetRuntimeCacheData_protected	(	const struct KzuObjectSource *	objectSource,
		const struct KzuObjectSourceRuntimeData *	runtimeData,
		const void *	data
	)

Store the cache data for an object source.

void* kzuObjectSourceGetRuntimeCacheData_protected	(	const struct KzuObjectSource *	objectSource,
		const struct KzuObjectSourceRuntimeData *	runtimeData
	)

Get the cache data of an object source.