kzu_lod_selector.h File Reference

Level of detail selector node and data. More...

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

Enumerations
enum	KzuLODType { KZU_LOD_TYPE_INVALID, KZU_LOD_TYPE_DISTANCE, KZU_LOD_TYPE_SCREEN_AREA }
	List of available LOD types. More...

Functions
kzsError	kzuLODSelectorNodeRegisterToFactory (const struct KzuFactory *factory)
	Registers LOD selector node type to factory. More...
kzsError	kzuLODSelectorNodeCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuLODSelectorNode **out_lodNode)
	Creates a new level of detail selector node. More...
struct KzuLODSelectorNode *	kzuLODSelectorNodeFromObjectNode (const struct KzuObjectNode *objectNode)
	Returns LOD selector node from object node. More...
struct KzuObjectNode *	kzuLODSelectorNodeToObjectNode (const struct KzuLODSelectorNode *lodNode)
	Returns an object node from LOD selector node. More...
enum KzuLODType	kzuLODSelectorGetLODType (const struct KzuLODSelectorNode *lodSelectorNode)
	Gets LOD type from LOD selector object. More...
void	kzuLODSelectorSetLODType (struct KzuLODSelectorNode *lodSelectorNode, enum KzuLODType lodType)
	Sets LOD type for LOD selector object. More...
kzUint	kzuLODSelectorNodeGetLevelCount (const struct KzuLODSelectorNode *lodSelectorNode)
	Gets number of LOD levels in this object. More...
struct KzuObjectNode *	kzuLODSelectorNodeGetObjectAtConstraint (const struct KzuLODSelectorNode *lodSelectorNode, kzFloat constraint)
	Gets LOD level object with given constraint (distance, perspective size). More...
struct KzuObjectNode *	kzuLODSelectorGetObjectNodeAtLevel (const struct KzuLODSelectorNode *lodSelectorNode, kzUint index)
	Gets object node at given index from LOD selector node. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_LOD_SELECTOR
	Object type identifier for LOD selector objects. More...

Detailed Description

Level of detail selector node and data.

Node inherited from KzuObjectNode. LOD selector node is pipeline element for selecting level of detail depending on camera distance / perspective size.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuLODType

List of available LOD types.

Enumerator
KZU_LOD_TYPE_INVALID	Invalid LOD type.
KZU_LOD_TYPE_DISTANCE	Distance LOD, z distance from camera.
KZU_LOD_TYPE_SCREEN_AREA	Screen area LOD, size in screen space in percentages.

Function Documentation

kzsError kzuLODSelectorNodeRegisterToFactory

(

const struct KzuFactory *

factory)

Registers LOD selector node type to factory.

kzsError kzuLODSelectorNodeCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuLODSelectorNode **	out_lodNode
	)

Creates a new level of detail selector node.

struct KzuLODSelectorNode* kzuLODSelectorNodeFromObjectNode

(

const struct KzuObjectNode *

objectNode)

Returns LOD selector node from object node.

struct KzuObjectNode* kzuLODSelectorNodeToObjectNode

(

const struct KzuLODSelectorNode *

lodNode)

Returns an object node from LOD selector node.

enum KzuLODType kzuLODSelectorGetLODType

(

const struct KzuLODSelectorNode *

lodSelectorNode)

Gets LOD type from LOD selector object.

void kzuLODSelectorSetLODType	(	struct KzuLODSelectorNode *	lodSelectorNode,
		enum KzuLODType	lodType
	)

Sets LOD type for LOD selector object.

kzUint kzuLODSelectorNodeGetLevelCount

(

const struct KzuLODSelectorNode *

lodSelectorNode)

Gets number of LOD levels in this object.

struct KzuObjectNode* kzuLODSelectorNodeGetObjectAtConstraint	(	const struct KzuLODSelectorNode *	lodSelectorNode,
		kzFloat	constraint
	)

Gets LOD level object with given constraint (distance, perspective size).

struct KzuObjectNode* kzuLODSelectorGetObjectNodeAtLevel	(	const struct KzuLODSelectorNode *	lodSelectorNode,
		kzUint	index
	)

Gets object node at given index from LOD selector node.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_LOD_SELECTOR

Object type identifier for LOD selector objects.