SAP 3D Visual Enterprise applications SDK
DVLClient.h
Go to the documentation of this file.
1 /*
2  (C) 2013 SAP AG or an SAP affiliate company. All rights reserved.
3 */
9 #pragma once
10 
11 
12 //
13 //DVLCLIENTLOGTYPE
14 //
17 {
20 
23 
26 
29 };
30 
31 
32 
33 //
34 //DVLSTEPEVENT
35 //
38 {
41 
44 
47 };
48 
49 
50 
52 #define DVLLOGSOURCE_OPENGL "OpenGL"
53 
55 #define DVLLOGSOURCE_MEMORY "Memory"
56 
58 #define DVLLOGSOURCE_LOCALFILESYSTEM "LocalFileSystem"
59 
61 #define DVLLOGSOURCE_HTTPFILESYSTEM "HTTPFileSystem"
62 
64 #define DVLLOGSOURCE_REMOTEFILESYSTEM "RemoteFileSystem"
65 
67 #define DVLLOGSOURCE_VDS "VDS"
68 
70 #define DVLLOGSOURCE_SCENE "Scene"
71 
72 
73 
81 {
82 public:
83  virtual ~IDVLClient() {}
84 
94  virtual void OnNodeSelectionChanged(IDVLScene *pScene, size_t uNumberOfSelectedNodes, DVLID idFirstSelectedNode) {}
95 
101  virtual void OnNodeVisibilityChanged(IDVLScene *pScene, DVLID id, bool bNewVisibility) {}
102 
112  virtual void LogMessage(DVLCLIENTLOGTYPE type, const char *szSource, const char *szText) {}
113 
122  virtual void OnStepEvent(DVLSTEPEVENT type, DVLID stepId) {}
123 
132  virtual void OnURLClick(const char *url, DVLID nodeId) {}
133 
134 
145  virtual bool NotifyFileLoadProgress(float fProgress) {return true;}
146 
152  virtual void NotifyFrameStarted() {}
153 
159  virtual void NotifyFrameFinished() {}
160 
167  virtual const char *GetDebugInfoString() {return NULL;}
168 
176  virtual bool RequestCallback(void *pCallbackParam) { return false; }
177 
183  virtual void NotifySceneGeometryLoaded(IDVLScene *pScene) {}
184 };
virtual void OnNodeSelectionChanged(IDVLScene *pScene, size_t uNumberOfSelectedNodes, DVLID idFirstSelectedNode)
Definition: DVLClient.h:94
Information message, like name of the loading file or ID of the activated step.
Definition: DVLClient.h:22
virtual bool RequestCallback(void *pCallbackParam)
Definition: DVLClient.h:176
Warning message, usually means that something went wrong but you can proceed.
Definition: DVLClient.h:25
Error message, means that something has failed.
Definition: DVLClient.h:28
virtual void NotifyFrameStarted()
Definition: DVLClient.h:152
virtual void OnNodeVisibilityChanged(IDVLScene *pScene, DVLID id, bool bNewVisibility)
Definition: DVLClient.h:101
step has started (stepId is a new step)
Definition: DVLClient.h:40
Definition: DVLScene.h:586
uint64_t DVLID
DVLID is the main identifier for all items inside a DVL scene. Materials, nodes, meshes, lights, cameras, animations - they all have unique DVLID.
Definition: DVLTypes.h:12
the step has finished playing and no more steps are to be played (stepId is the old step) ...
Definition: DVLClient.h:46
virtual bool NotifyFileLoadProgress(float fProgress)
Definition: DVLClient.h:145
Debugging information, usually can be ignored.
Definition: DVLClient.h:19
virtual void OnURLClick(const char *url, DVLID nodeId)
Definition: DVLClient.h:132
DVLCLIENTLOGTYPE
Defines the type of the logged information.
Definition: DVLClient.h:16
virtual const char * GetDebugInfoString()
Definition: DVLClient.h:167
the previous step has finished and the new one is started (stepId is a new step)
Definition: DVLClient.h:43
virtual void OnStepEvent(DVLSTEPEVENT type, DVLID stepId)
Definition: DVLClient.h:122
virtual void NotifyFrameFinished()
Definition: DVLClient.h:159
DVLSTEPEVENT
Defines the type of a step event.
Definition: DVLClient.h:37
virtual void LogMessage(DVLCLIENTLOGTYPE type, const char *szSource, const char *szText)
Definition: DVLClient.h:112
Definition: DVLClient.h:80
virtual void NotifySceneGeometryLoaded(IDVLScene *pScene)
Definition: DVLClient.h:183