JSDoc: Class: Display

new Display(container, options)

Create Display

Parameters:

Name	Type	Description
`container`	DOMElement	the DOM element, e.g. div, that should contain the Display
`options`		display options

Source:

display.js, line 34

Members

showAnglePanel

Show or hide the angle measurement panel

Source:

display.js, line 1179

showDistancePanel

Show or hide the distance measurement panel

Source:

display.js, line 1163

showMeasureTools

Show or hides measurement tools, measurement tools needs a backend to be used.

Source:

display.js, line 760

showPropertiesPanel

Show or hide the properties measurement panel

Source:

display.js, line 1171

Methods

_getElement(name) → {DOMElement}

Parameters:

Name	Type	Description
`name`	string	Name of the DOM element

Source:

display.js, line 313

Returns:

Type: DOMElement

addCadTree(cadTree)

Add the Cad tree and other UI elements like Clipping

Parameters:

Name	Type	Description
`cadTree`	DOMElement	the DOM element that contains the cadTree

Source:

display.js, line 514

addCadView(cadView)

Add the Cad View (the canvas for threejs)

Parameters:

Name	Type	Description
`cadView`	DOMElement	the DOM element that contains the cadView

Source:

display.js, line 499

animationChange(e)

Handler for the animation slider

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 1116

autoCollapse(flag)

Auto collapse tree nodes, when cad width < 600

Parameters:

Name	Type	Description
`flag`	boolean	whether to enable/disable glass mode

Source:

display.js, line 1215

checkElement(name, flag)

Check or uncheck a checkbox

Parameters:

Name	Type	Description
`name`	string	name of the check box, see getElement
`flag`	boolean	whether to check or uncheck

Source:

display.js, line 491

clearCadTree()

Clear the Cad tree

Source:

display.js, line 506

clearHighlights()

Clear all highlights of navigation tree entries

Source:

display.js, line 826

collapseNodes(value)

Collapse nodes handler

Parameters:

Name	Type	Description
`value`	string	1: collapse all leaf nodes, "R": expand root level only, "C": collapse all nodes, "E": expand all nodes

Source:

display.js, line 1035

controlAnimation(e)

Handler for the animation control

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 1106

controlAnimationByName(btn)

Handle animation control

Parameters:

Name	Type	Description
`btn`	string	animation control button name

Source:

display.js, line 1084

glassMode(flag)

Enable/disable glass mode

Parameters:

Name	Type	Description
`flag`	boolean	whether to enable/disable glass mode

Source:

display.js, line 1227

handleCollapseNodes(e)

Collapse nodes handler

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 1027

handleMaterialReset(e)

Reset material values to original values

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 949

handleMoreButton(fullWidth)

Use More fropdown if overall width < 970px else just check boxes

Parameters:

Name	Type	Description
`fullWidth`	number	overall width of tree and cad view (taking glass mode into account)

Source:

display.js, line 337

highlightButton(name)

Highlight the selected button

Parameters:

Name	Type	Description
`name`	string	A CAD object id (path)

Source:

display.js, line 838

pinAsPng(e)

Pin screenshot of canvas as PNG

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 871

refreshPlane(index, value)

Refresh clipping plane

Parameters:

Name	Type	Description
`index`	number	index of the plane: 0,1,2
`value`	number	distance on the clipping normal from the center

Source:

display.js, line 1066

reset()

Handler to reset position, zoom and up of the camera

Source:

display.js, line 810

resetAnimationSlider()

Reset animation slider to 0

Source:

display.js, line 1135

resize()

Handler to reset zoom of the camera

Source:

display.js, line 819

selectTab(e)

Handler to activate a UI tab (tree / clipping)

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 902

selectTabByName(tab)

Activate the UI tab given the name of the tab

Parameters:

Name	Type	Description
`tab`	string	name of the tab "tree" or "clip"

Source:

display.js, line 957

setAmbientLight(val)

Set the ambient light intensity in the UI

Parameters:

Name	Type	Description
`val`	number	a float between 0 and 4

Source:

display.js, line 912

setAnimationLabel(label)

Set label text of animation control

Parameters:

Name	Type	Description
`label`	string	"A" for animation and "E" for Explode control

Source:

display.js, line 1127

setAxes(flag)

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 525

setAxes0(flag)

Checkbox Handler for setting the axes0 parameter

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 561

setAxes0Check(flag)

Check/uncheck the Axes0 checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Axes0 checkbox

Source:

display.js, line 570

setAxesCheck(flag)

Check/uncheck the axes checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the axes checkbox

Source:

display.js, line 534

setBlackEdges(flag)

Checkbox Handler for setting the black edges parameter

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 615

setBlackEdgesCheck(flag)

Check or uncheck the Black Edges checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Black Edges checkbox

Source:

display.js, line 624

setClipIntersection(e)

Checkbox Handler for setting the clip intersection parameter

Parameters:

Name	Type	Description
`e`	*

Source:

display.js, line 771

setClipIntersectionCheck(flag)

Check or uncheck the Intersection checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Intersection checkbox

Source:

display.js, line 781

setClipNormalFromPosition(e)

Set the normal at index to the current viewing direction

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 892

setClipObjectColorsCheck(flag)

Check or uncheck the Intersection checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the object colors checkbox

Source:

display.js, line 801

setClipPlaneHelpers(e)

Checkbox Handler for setting the clip planes parameter

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 716

setClipPlaneHelpersCheck(flag)

Check or uncheck the Plane Helpers checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Plane Helpers checkbox

Source:

display.js, line 727

setDirectLight(val)

Set the direct light intensity in the UI

Parameters:

Name	Type	Description
`val`	number	a float between 0 and 4

Source:

display.js, line 921

setExplode(flag)

Checkbox Handler for setting the explode mode

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 633

setExplodeCheck(flag)

Check or uncheck the Explode checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Black Edges checkbox

Source:

display.js, line 658

setGrid(flag)

Checkbox Handler for setting the grid parameter

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 543

setGridCheck(flag)

Check/uncheck the main grid UI element

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the main grid checkbox

Source:

display.js, line 552

setMetalness(val)

Set material metalness in the UI

Parameters:

Name	Type	Description
`val`	number	a float between 0 and 1

Source:

display.js, line 930

setNormalLabel(index, normal)

Handler to set the label of a clipping normal widget

Parameters:

Name	Type	Description
`index`	number	index of the normal widget
`normal`	Vector3	the normal

Source:

display.js, line 881

setObjectColorCaps(e)

Checkbox Handler for toggling the clip caps

Parameters:

Name	Type	Description
`e`	*

Source:

display.js, line 791

setOrtho(flag)

Checkbox Handler for setting the ortho parameter

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 579

setOrthoCheck(flag)

Check or uncheck the Ortho checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the ortho checkbox

Source:

display.js, line 588

setRoughness(val)

Set material roughness in the UI

Parameters:

Name	Type	Description
`val`	number	a float between 0 and 1

Source:

display.js, line 939

setSizes(options)

Set the width and height of the different UI elements (tree, canvas and info box)

Parameters:

Name	Type	Description
`options`	DisplayOptions

Source:

display.js, line 355

setSliderLimits(index, limit)

Set minimum and maximum of the sliders

Parameters:

Name	Type	Description
`index`	number	index of the plane: 0,1,2
`limit`	number	the value for both minimum and maximum value of the slider

Source:

display.js, line 1054

setTool(flag)

Checkbox Handler for setting the tools mode

Parameters:

Name	Type	Description
`flag`	boolean	whether to start or stop measure context

Source:

display.js, line 677

setTransparent(flag)

Checkbox Handler for setting the transparent parameter

Parameters:

Name	Type	Description
`flag`	boolean	to set or not

Source:

display.js, line 597

setTransparentCheck(flag)

Check or uncheck the Transparent checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Transparent checkbox

Source:

display.js, line 606

setView(e)

Handler to set camera to a predefined position

Parameters:

Name	Type	Description
`e`	Event	a DOM click event

Source:

display.js, line 850

setupUI(viewer)

Set up the UI

Parameters:

Name	Type	Description
`viewer`	Viewer	the viewer for this UI

Source:

display.js, line 398

showAnimationControl(flag)

Show or hide the Animation control widget

Parameters:

Name	Type	Description
`flag`	boolean	whether to show or hide the Animation control widget

Source:

display.js, line 1075

showExplode(flag)

Show or hide the Explode checkbox

Parameters:

Name	Type	Description
`flag`	boolean	whether to check or uncheck the Black Edges checkbox

Source:

display.js, line 667

showHelp(flag)

Show or hide help dialog

Parameters:

Name	Type	Description
`flag`	boolean	whether to show or hide help dialog

Source:

display.js, line 1144

showInfo(flag)

Show or hide info dialog

Parameters:

Name	Type	Description
`flag`	boolean	whether to show or hide info dialog

Source:

display.js, line 1196

showPinning(flag)

Show/hide pinning button

Parameters:

Name	Type	Description
`flag`	boolean	Whether to show/hide the pinning button

Source:

display.js, line 861

showTools(flag)

Show or hide the CAD tools

Parameters:

Name	Type	Description
`flag`	boolean	whether to show or hide the CAD tools

Source:

display.js, line 737

toggleHelp()

Show help dialog

Source:

display.js, line 1187

toggleInfo()

Show info dialog

Source:

display.js, line 1206

updateUI()

Check or uncheck a checkbox

Properties:

Name	Type	Attributes	Default	Description
`axes`	boolean	<optional>	false	show X-, Y-, Z-axes.
`axes0`	boolean	<optional>	false	show axes at [0,0,0] ot at object center (target).
`ortho`	boolean	<optional>	true	use an orthographic (true) or perspective camera (false)
`transparent`	boolean	<optional>	false	show CAD object transparent.
`blackEdges`	boolean	<optional>	false	show edges in black and not in edgeColor.
`tools`	boolean	<optional>	true	show CAD tools.
`glass`	boolean	<optional>	false	use glass mode, i.e. CAD navigation as overlay.

Source:

display.js, line 474