BCFViewpoint

class Communicator.BCFViewpoint()

Constructors

constructor()

Constructors

constructor

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

Arguments

filename (string()) –
document ({ }()) –
version (Communicator.BCFVersion()) –
modelBounding (Communicator.Box()) –
modelUnits (number()) –
viewer (Communicator.WebViewer()) –

Return type

Communicator.BCFViewpoint

Methods

activate

Communicator.BCFViewpoint.activate()

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

Return type: Promise[void]

export

Communicator.BCFViewpoint.export()

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

getCamera

Communicator.BCFViewpoint.getCamera()

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

Return type: { }

getClippingPlanes

Communicator.BCFViewpoint.getClippingPlanes()

Gets the clipping planes.

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

getColors

Communicator.BCFViewpoint.getColors()

Return type: Map[Communicator.Color, Set[Communicator.GenericId]]
Returns: Map correlating color to components.

getColorsToNodes

Communicator.BCFViewpoint.getColorsToNodes()

Return type: Map[Communicator.Color, Set[Communicator.NodeId]]
Returns: Map correlating color to nodes.

getFilename

Communicator.BCFViewpoint.getFilename()

Gets the viewpoint filename.

Return type: string

getLines

Communicator.BCFViewpoint.getLines()

Gets markup lines.

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

getSelection

Communicator.BCFViewpoint.getSelection()

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

Return type: [Communicator.GenericId]

getSelectionNodes

Communicator.BCFViewpoint.getSelectionNodes()

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

Return type: [Communicator.NodeId]

getViewpointGuid

Communicator.BCFViewpoint.getViewpointGuid()

Gets the GUID associated with the viewpoint.

Return type: { }

getVisibilityExceptionNodes

Communicator.BCFViewpoint.getVisibilityExceptionNodes()

Gets the visibility exception node ids.

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

getVisibilityExceptions

Communicator.BCFViewpoint.getVisibilityExceptions()

Gets the visibility exception generic ids.

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

setCamera

Communicator.BCFViewpoint.setCamera(camera)

Sets the viewpoint camera.

Arguments

camera (Communicator.Camera()) –

Return type

void

setClippingPlanes

Communicator.BCFViewpoint.setClippingPlanes(planes)

Sets the clipping planes.

Arguments

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

Return type

void

setColorNodes

Communicator.BCFViewpoint.setColorNodes(colorNodeMap)

Sets the colors.

Arguments

colorNodeMap (Map[Communicator.Color, Set[Communicator.BcfNode]]()) – Map correlating color to BfcNodes.

Return type

void

setColors

Communicator.BCFViewpoint.setColors(colorGenericIdMap)

Sets the colors.

Arguments

colorGenericIdMap (Map[Communicator.Color, Set[Communicator.GenericId]]()) – Map correlating color to GenericIds.

Return type

void

setDefaultVisibility

Communicator.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

Communicator.BCFViewpoint.setLines(lines)

Sets the markup lines.

Arguments

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

Return type

void

setSelection

Communicator.BCFViewpoint.setSelection(selection)

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

Arguments

selection ([Communicator.GenericId]()) –

Return type

void

setSelectionNodes

Communicator.BCFViewpoint.setSelectionNodes(selection)

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

Arguments

selection ([Communicator.BcfNode]()) –

Return type

void

setVisibilityExceptionNodes

Communicator.BCFViewpoint.setVisibilityExceptionNodes(visibilityExceptions)

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

Arguments

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

Return type

void

setVisibilityExceptions

Communicator.BCFViewpoint.setVisibilityExceptions(visibilityExceptions)

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

Arguments

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

Return type

void

createViewpoint

Communicator.BCFViewpoint.createViewpoint(viewer, viewpointFilename, markupView)

Arguments

viewer (Communicator.WebViewer()) –
viewpointFilename (string()) –
markupView ({ }()) –

Return type

Promise[Communicator.BCFViewpoint]