BCFViewpoint

class Communicator.BCFViewpoint()

Constructors

constructor()

Constructors

BCFViewpoint.constructor(filename, document, version, modelBounding, modelUnits, viewer)

Arguments

filename (string()) –
document (Document | null()) –
version (BCFVersion) –
modelBounding (Box()) –
modelUnits (number()) –
viewer (WebViewer()) –

Return type

BCFViewpoint()

Methods

activate

BCFViewpoint.activate()

Activates viewpoint. Sets the camera, visibility, cutting planes, colors, and markup.

Return type: Promise <void>

export

BCFViewpoint.export()

Return type: XMLDocument
Returns: XML document containing the viewpoint data.

getCamera

BCFViewpoint.getCamera()

Gets the viewpoint camera, or null if none is set.

Return type: Camera() | null

getClippingPlanes

BCFViewpoint.getClippingPlanes()

Gets the clipping planes.

Return type: [(Point3(), Point3())]
Returns: Array containing position and direction pairs.

getColors

BCFViewpoint.getColors()

Return type: Map <Color(), Set <GenericId>>
Returns: Map correlating color to components.

getColorsToNodes

BCFViewpoint.getColorsToNodes()

Return type: Map <Color(), Set <NodeId>>
Returns: Map correlating color to nodes.

getFilename

BCFViewpoint.getFilename()

Gets the viewpoint filename.

Return type: string

getLines

BCFViewpoint.getLines()

Gets markup lines.

Return type: [(Point3(), Point3())]
Returns: Array containing start point and end point line pairs.

getSelection

BCFViewpoint.getSelection()

Gets a list of generic IDs that are in the selection set.

Return type: [GenericId]

getSelectionNodes

BCFViewpoint.getSelectionNodes()

Gets a list of node IDs that are in the selection set.

Return type: [NodeId]

getViewpointGuid

BCFViewpoint.getViewpointGuid()

Gets the GUID associated with the viewpoint.

Return type: string | null

getVisibilityExceptionNodes

BCFViewpoint.getVisibilityExceptionNodes()

Gets the visibility exception node ids.

Return type: [NodeId]
Returns: Array of NodeIds corresponding to components.

getVisibilityExceptions

BCFViewpoint.getVisibilityExceptions()

Gets the visibility exception generic ids.

Return type: [GenericId]
Returns: Array of GenericIds corresponding to components.

setCamera

BCFViewpoint.setCamera(camera)

Sets the viewpoint camera.

Arguments

camera (Camera()) –

Return type

void

setClippingPlanes

BCFViewpoint.setClippingPlanes(planes)

Sets the clipping planes.

Arguments

planes ([(Point3(), Point3())]) – array containing position and direction pairs.

Return type

void

setColorNodes

BCFViewpoint.setColorNodes(colorNodeMap)

Sets the colors.

Arguments

colorNodeMap (Map <Color(), Set <BcfNode()>>) – Map correlating color to BfcNodes.

Return type

void

setColors

BCFViewpoint.setColors(colorGenericIdMap)

Sets the colors.

Arguments

colorGenericIdMap (Map <Color(), Set <GenericId>>) – Map correlating color to GenericIds.

Return type

void

setDefaultVisibility

BCFViewpoint.setDefaultVisibility(defaultVisibility)

Sets the default visibility. If true, visibility exceptions are hidden. If false, visibility exceptions are shown.

Arguments

defaultVisibility (boolean()) –

Return type

void

setLines

BCFViewpoint.setLines(lines)

Sets the markup lines.

Arguments

lines ([(Point3(), Point3())]) – array of start point and end point line pairs.

Return type

void

setSelection

BCFViewpoint.setSelection(selection)

Sets a list of items to be added to the selection set.

Arguments

selection ([GenericId]) –

Return type

void

setSelectionNodes

BCFViewpoint.setSelectionNodes(selection)

Sets a list of items to be added to the selection set.

Arguments

selection ([BcfNode()]) –

Return type

void

setVisibilityExceptionNodes

BCFViewpoint.setVisibilityExceptionNodes(visibilityExceptions)

Sets the visibility exceptions. These nodes will be shown or hidden based on the default visibility setting.

Arguments

visibilityExceptions ([BcfNode()]) – Array of BcfNodes corresponding to components.

Return type

void

setVisibilityExceptions

BCFViewpoint.setVisibilityExceptions(visibilityExceptions)

Sets the visibility exceptions. These nodes will be shown or hidden based on the default visibility setting.

Arguments

visibilityExceptions ([GenericId]) – Array of GenericIds corresponding to components.

Return type

void

static createViewpoint

BCFViewpoint.createViewpoint(viewer, viewpointFilename[, markupView])

Arguments

viewer (WebViewer()) –
viewpointFilename (string()) –
markupView (MarkupView() | null) – optional

Return type

Promise <BCFViewpoint()>