Package nl.bimbase.bimworks.client.apis

Class RenderApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.RenderApi

public class RenderApi
extends SubApi

The RenderApi provides calls for rendering (parts of) models server-side. These API calls require at least one GPU Node in your BIM.works cluster.

Constructor Summary

Constructors

Constructor	Description
RenderApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
List<RenderedViewPoint>	render(UUID versionUuid, nl.bimbase.bimworks.api.render.ViewPort viewPort, List<nl.bimbase.bimworks.api.render.ViewPoint> viewPoints)	Render one or more viewpoints.

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RenderApi

public RenderApi(BimWorksClient bimWorksClient)

Method Details

render

public List<RenderedViewPoint> render(UUID versionUuid,
 nl.bimbase.bimworks.api.render.ViewPort viewPort,
 List<nl.bimbase.bimworks.api.render.ViewPoint> viewPoints)
                               throws BimWorksException

Render one or more viewpoints. Because loading the IFC model can take some time, the advise is to send as many viewPoints for the same model at once in one render call.

Parameters:

versionUuid - The model to render, for now only one model can be supplied

viewPort - The viewport dictates the dimensions of the output image, this settings is applied to all viewPoints

viewPoints - The viewpoints to render.

Returns:

A List of RenderedViewPoint, the indices within the list are the same as the input indices of viewPoints

Throws:

BimWorksException