MAK Legion 1.1 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
c_database.h
Go to the documentation of this file.
1 /*********************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************************/
5 
9 #pragma once
10 
11 
15 
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 
27 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_createSimulationDatabase(const ConfigHandle config, DatabaseHandle *dbHandle);
28 
34 
40 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_viewManager(DatabaseHandle db, ViewManagerHandle *viewManagerHandle);
41 
47 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_eventManager(DatabaseHandle db, EventManagerHandle *eventManagerHandle);
48 
54 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_controlManager(DatabaseHandle db, ControlManagerHandle *controlManagerHandle);
55 
56 
57 
59 typedef void(*C_BeginFrameCallback)(void* usr, double simTime);
60 
62 typedef void(*C_EndFrameCallback)(void* usr);
63 
70 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_reserve(DatabaseHandle db, AttributeSetId setType, UInt32 count);
71 
78 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_capacity(DatabaseHandle db, AttributeSetId setType, UInt32* count);
79 
85 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_beginFrame(DatabaseHandle db, double simTime);
86 
92 
98 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_inFrame(DatabaseHandle db, LEG_Bool* inFrame);
99 
105 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_simTime(DatabaseHandle db, double* simTime);
106 
112 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_currentFrame(DatabaseHandle db, UInt64* frameCount);
113 
119 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_clientId(DatabaseHandle db, ClientId* clientId);
120 
126 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_setClientId(DatabaseHandle db, ClientId clientId);
127 
136 
145 
153 
161 
170 
177 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_findAttributeSetId(DatabaseHandle db, const char* setName, AttributeSetId* setId);
178 
188 
196 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_findAttributeIndexByName(DatabaseHandle db, AttributeSetId setId, const char* attributeName, AttributeIndex* index);
197 
206 
214 
220 
221 
227 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_setTypeForInstance(InstanceHandle inst, UInt32* setType);
228 
234 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getGlobalId(InstanceHandle inst, GlobalId* gidPtr);
235 
241 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getClientId(InstanceHandle inst, ClientId* clientIdPtr);
242 
248 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_isValid(InstanceHandle inst, LEG_Bool* isValid);
249 
256 LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getInstanceId(DatabaseHandle db, GlobalId globalId, InstanceHandle* handlePtr);
257 
264 
265 
266 #ifdef __cplusplus
267 }
268 #endif
269 
unsigned int AttributeSetId
Definition: c_api.h:46
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getClientId(InstanceHandle inst, ClientId *clientIdPtr)
LEG_ReturnCode
Definition: c_api.h:62
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_viewManager(DatabaseHandle db, ViewManagerHandle *viewManagerHandle)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_capacity(DatabaseHandle db, AttributeSetId setType, UInt32 *count)
unsigned long long DatabaseHandle
Definition: c_api.h:19
unsigned long long EventManagerHandle
Definition: c_api.h:24
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getGlobalId(InstanceHandle inst, GlobalId *gidPtr)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_registerAttributeSet(DatabaseHandle db, const LEG_AttributeSetDescriptor *setDesc, AttributeSetId *setId)
unsigned long long GlobalId
Definition: c_api.h:39
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_findAttributeIndexById(DatabaseHandle db, AttributeSetId setId, UInt32 attrId, AttributeIndex *index)
unsigned int UInt32
Definition: c_api.h:54
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_destroySimulationDatabase(DatabaseHandle db)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_clientId(DatabaseHandle db, ClientId *clientId)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_removeEndFrameCallback(DatabaseHandle db, C_EndFrameCallback func, void *usr)
unsigned long long ControlManagerHandle
Definition: c_api.h:25
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_endFrame(DatabaseHandle db)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_simTime(DatabaseHandle db, double *simTime)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_reserve(DatabaseHandle db, AttributeSetId setType, UInt32 count)
void(* C_BeginFrameCallback)(void *usr, double simTime)
Definition: c_database.h:59
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_beginFrame(DatabaseHandle db, double simTime)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_createSimulationDatabase(const ConfigHandle config, DatabaseHandle *dbHandle)
unsigned int AttributeIndex
Definition: c_api.h:42
unsigned long long ConfigHandle
Definition: c_api.h:22
LEG_Bool
Definition: c_api.h:111
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_registerAttribute(DatabaseHandle db, AttributeSetId setId, const LEG_AttributeDescriptor *descriptor, AttributeIndex *index)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_setTypeForInstance(InstanceHandle inst, UInt32 *setType)
A structure to represent Legion descriptor registry of an attribute set It describes a group of attri...
Definition: c_attributes.h:47
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getInstanceId(DatabaseHandle db, GlobalId globalId, InstanceHandle *handlePtr)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_removeBeginFrameCallback(DatabaseHandle db, C_BeginFrameCallback func, void *usr)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_createInstance(DatabaseHandle db, AttributeSetId setId, InstanceHandle *handle)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_findAttributeIndexByName(DatabaseHandle db, AttributeSetId setId, const char *attributeName, AttributeIndex *index)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_currentFrame(DatabaseHandle db, UInt64 *frameCount)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_controlManager(DatabaseHandle db, ControlManagerHandle *controlManagerHandle)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_destroyInstance(InstanceHandle inst)
unsigned int ClientId
Definition: c_api.h:40
A structure to represent Legion descriptor registry of an attribute.
Definition: c_attributes.h:35
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_addBeginFrameCallback(DatabaseHandle db, C_BeginFrameCallback func, void *usr)
unsigned long long InstanceHandle
Definition: c_api.h:32
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_inFrame(DatabaseHandle db, LEG_Bool *inFrame)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_isValid(InstanceHandle inst, LEG_Bool *isValid)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_addEndFrameCallback(DatabaseHandle db, C_EndFrameCallback func, void *usr)
unsigned long long ViewManagerHandle
Definition: c_api.h:21
void(* C_EndFrameCallback)(void *usr)
Definition: c_database.h:62
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_setClientId(DatabaseHandle db, ClientId clientId)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_findAttributeSetId(DatabaseHandle db, const char *setName, AttributeSetId *setId)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_getDatabaseHandleForInstance(InstanceHandle inst, DatabaseHandle *dbHandle)
unsigned long long UInt64
Definition: c_api.h:56
LEGIONRUNTIME_DLL LEG_ReturnCode legion_db_eventManager(DatabaseHandle db, EventManagerHandle *eventManagerHandle)

Document ID: Generated on Wed May 26 15:17:05 EDT 2021 from SVN revision 229676
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)