Class BcfApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.BcfApi

public class BcfApi
extends SubApi

BCF related API calls

Constructor Summary

Constructors

Constructor	Description
BcfApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
InputStream	augment(UUID versionUuid, Path inputFile)
InputStream	createBcf(Set<UUID> versionUuids, com.fasterxml.jackson.databind.node.ArrayNode topics)	Create a BCF file with one topic per viewpoint.

Methods inherited from class SubApi

getBimWorksClient

Modifier and Type	Method	Description
BimWorksClient	getBimWorksClient()

Methods inherited from class Object

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

Constructor Details

BcfApi

public BcfApi(BimWorksClient bimWorksClient)

Method Details

augment

public InputStream augment(UUID versionUuid,
 Path inputFile)
                    throws BimWorksException

Throws:

BimWorksException

createBcf

public InputStream createBcf(Set<UUID> versionUuids,
 com.fasterxml.jackson.databind.node.ArrayNode topics)
                      throws BimWorksException

Create a BCF file with one topic per viewpoint. Each topic carries visualizationInfo.perspectiveCamera.{position,direction,up}, components with selection and coloring arrays (both may be empty, but must be present), and defaultSnapshot (a base64 PNG) — the server reads all of them unconditionally and answers with an empty response when one is missing. The caller closes the stream.

Throws:

BimWorksException