Constructor for the RenderEngineContext
Unique render engine ID that corresponds to the native rendering engine.
Return the render engine ID associated with this object
Projects the specific array of vectors into the scene and returns a correpsonding array of points
This is an asynchronous method that returns a Promise as follows:
Promise .then(pointList : Array< Point >) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , pointList Point : Array< Point> )
Invokes the native intermediate render() method.
This is a synchronous method and returns ReturnCode.ok on success.
Invokes the native renderFinal() method. It is important that a render() be done before a renderFinal() after the rendeirng state has changed, such as from a setRenderParamters().
This is a synchronous method and returns ReturnCode.ok on success.
Sets the rendering paramters to this rendering engine
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , void)
While this does not provide a return value, it is sometimes useful to wait for it to complete as in:
renderEngineContext.setRenderParams(renderParams).then(function() { renderEngineContext.render(); renderFinal(); });
Sets the rendering paramters using the supplied XML file to this rendering engine
path and filename of the XML file to load. This will be relative to the FoviaWebSDK.EXE directory, or can be an absolute path
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , void)
While this does not provide a return value, it is sometimes useful to wait for it to complete as in:
renderEngineContext.setRenderParamsXML(renderParams).then(function() { renderEngineContext.render(); renderFinal(); });
sets the transfer function on this rendering engine
0-based number for transfer function to set
array of render ranges
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Shoots ray into the screen from an array of points, and returns a correpsonding array of RayStopInfo
This is an asynchronous method that returns a Promise as follows:
Promise .then(rayStopInfoList : Array< RayStopInfo>) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , rayStopInfoList : Array< RayStopInfo> )
Example for creating a complete rendering parameters structure programatically
Generated using TypeDoc
RenderEngineContext is backed by a native renering engine and is typically associated with a Fovia.UI.HTMLViewport . This objectis typically created by a ServerContext.loadDICOMDir or a ServerContext.loadCustomData .