JSDoc: Global

Members

(constant) bboxLayer

Source:

utilities/drawBoundingBoxes.js, line 22

(constant) buildMateMap

Builds a map that indexes potential connection mates per connector type

Source:

lib.js, line 238

(constant) checkPropTypes

Source:

lib.js, line 144

(constant) copyProps

Source:

lib.js, line 89

(constant) omit

Source:

lib.js, line 49

(constant) pause

Source:

lib.js, line 10

(constant) pick

Source:

lib.js, line 62

(constant) sum

Source:

lib.js, line 18

Methods

analyse(scene)

Analyses a scene and returns the placement of its objects in the camera's view

Parameters:

Name	Type	Description
`scene`	THREE.Scene

Source:

scene/scene_analyser.js, line 6

calculatePlacement(configuration) → {Object}

Calculate the position of the blockInstances and their connectors

Parameters:

Name	Type	Description
`configuration`	Configuration

Source:

utilities/calculatePlacement.js, line 74

Returns:

Type: Object

createDefaultEnvironment(reporter) → {Environment}

Parameters:

Name	Type	Description
`reporter`	Reporter

Source:

scene/deprecated/environment_default.js, line 12

Returns:

Type: Environment

decodeDracoFile()

Deprecated:

Kept for backward-compatibility with previous DRACOLoader versions.

Source:

package/loader/draco_loader.js, line 107

drawDimensionsLine(configuration, points, offset, side)

Parameters:

Name	Type	Description
`configuration`	Group
`points`	Array	- array with vectors
`offset`	Number
`side`	String

Source:

utilities/drawDimensionsLine.js, line 34

findConnection(blockInstanceSetA, blockInstanceSetB, connections) → {Object|null}

Find a connection between block instance sets

Parameters:

Name	Type	Description
`blockInstanceSetA`	Array.<BlockInstance>
`blockInstanceSetB`	Array.<BlockInstance>
`connections`	Array.<Connection>

Source:

utilities/calculatePlacement.js, line 13

Returns:

connectionData

Type: Object | null

findExtendOptions(configuration) → {Array.<ExtendOption>}

Parameters:

Name	Type	Description
`configuration`	Configuration

Source:

utilities/findConfigOptions.js, line 35

Returns:

Type: Array.<ExtendOption>

findInsertOptions(configuration) → {Array.<InsertOption>}

Find insert options for a configuration (every connection offers a potential insert opportunity)

Parameters:

Name	Type	Description
`configuration`	Configuration

Source:

utilities/findConfigOptions.js, line 113

Returns:

Type: Array.<InsertOption>

getDimensions(configuration)

Parameters:

Name	Type	Description
`configuration`	Configuration	source object

Source:

utilities/getDimensions.js, line 21

isConstructor(obj)

Parameters:

Name	Type	Description
`obj`	Object

Source:

lib.js, line 132

KeyboardShortcuts(scene, camera, renderer)

Parameters:

Name	Type	Description
`scene`	Scene
`camera`	PerspectiveCamera	- array with vectors
`renderer`	WebGLRenderer

Source:

utilities/keyboardShortcuts.js, line 25

report(log)

Report a message

Parameters:

Name	Type	Description
`log`	LogObject

Source:

reporter/reporter.js, line 83

setDrawMode()

Deprecated:

Source:

package/loader/draco_loader.js, line 68

setSkipDequantization()

Deprecated:

Source:

package/loader/draco_loader.js, line 75

setVerbosity()

Deprecated:

Source:

package/loader/draco_loader.js, line 61

Type Definitions

ArrayParseType

Type:

'integral' | 'alternatives'

Source:

package/component/buildable_component.js, line 17

BaseLoadTracker

Type:

Object

Properties:

Name	Type	Description
`base`	LoadingBase
`loads`	Object.<UUID, Promise.<null>>	When the promise resolves it returns a call to this._loadNext()
`maxConcurrentLoads`	number

Source:

package/loader/component_loader.js, line 20

BlockInstanceString

A stringified simple object representing a configuration body

Type:

string

Source:

typedef.js, line 67

BlockSetOption

Type:

Object

Properties:

Name	Type	Description
`blockSet`	'all' \| string	name of the block set

Source:

typedef.js, line 217

BodyString

A stringified simple object representing a configuration body

Type:

string

Source:

typedef.js, line 132

BuildRequest

Type:

Object

Properties:

Name	Type	Description
`component`	BuildableComponent
`part`	ComponentPart
`quality`	LoadingQuality

Source:

package/loader/component_loader.js, line 12

CommonInformationSourceData

Type:

Object

Properties:

Name	Type	Attributes
`data.id`	UUID	<optional>
`data.name`	string	<optional>
`data.url`	URL	<optional>

Source:

typedef.js, line 240

ComponentClass

Type:

Class.<Component>

Source:

component/component_tree.js, line 17

ComponentContent

Type:

Object

Properties:

Name	Type	Description
`UI`	QualityContent
`main`	QualityContent
`specs`	QualityContent

Source:

typedef.js, line 293

ComponentOrComponentArray

Type:

Component | Array.<Component>

Source:

package/component/buildable_component.js, line 502

ComponentPart

Type:

'main' | 'UI' | 'specs'

Source:

typedef.js, line 262

ComponentPartQualityStatus

Type:

'not-loaded' | 'partially-loaded' | 'loading' | 'ready' | 'error'

Source:

typedef.js, line 267

ComponentPartStatus

Type:

Object

Properties:

Name	Type	Description
`high`	ComponentPartQualityStatus
`medium`	ComponentPartQualityStatus
`low`	ComponentPartQualityStatus

Source:

typedef.js, line 271

ComponentStatus

Type:

Object

Properties:

Name	Type	Description
`UI`	ComponentPartStatus
`main`	ComponentPartStatus
`specs`	ComponentPartStatus

Source:

typedef.js, line 278

ConfigString

Type:

string

Source:

typedef.js, line 148

ConfigurationOptions

Type:

Object

Properties:

Name	Type	Description
`blockInsert`	Boolean
`blockExtend`	Boolean
`blockReplace`	Boolean

Source:

typedef.js, line 210

ConfigurationSummary

A summarized version of a configuration that can be used by external apps (i.e. a parent window hosting a configurator in an iFrame adding a configured product to a shopping cart).

Type:

Object

Properties:

Name	Type	Description
`products`	Array.<Object>	configuration id, price

Source:

typedef.js, line 79

ConfiguratorState

Type:

Object

Properties:

Name	Type	Attributes
`configuration`	Configuration
`position`	Vector3
`quaternion`	Quaternion
`description`	string	<optional>

Source:

configurator/configurator.js, line 79

ConnectInstruction

Type:

Object

Properties:

Name Type Description

from

Object

Properties

Name	Type	Description
`connectable`	Connectable \| string
`connector`	Connector

to

Object

Properties

Name	Type	Description
`connectable`	Connectable \| string
`connector`	Connector

Source:

configurator/configuration.js, line 74

ConnectionRole

Type:

'parent' | 'child' | 'none'

Source:

typedef.js, line 306

ConnectionString

A stringified simple object representing a configuration connection

Type:

string

Source:

typedef.js, line 115

ConnectorInstanceString

A stringified simple object representing a configuration connector instance

Type:

string

Source:

typedef.js, line 100

ConnectorSummary

Type:

Object

Properties:

Name	Type	Attributes
`connector`	Connector
`block`	Block
`blockInstance`	BlockInstance
`connected`	boolean
`connection`	Connection	<optional>
`role`	ConnectionRole	<optional>
`allowedMateTypes`	Array.<ConnectorType>
`allowedMates`	Array.<Connector>

Source:

configurator/configuration.js, line 50

ConnectorTypeMates

Type:

Object

Properties:

Name	Type	Description
`connectionTypes`	Array.<ConnectionType>	ConnectionTypes in which this connector type is a mate
`mateConnectorTypes`	Array.<ConnectorType>	ConnectorTypes that can mate with this connector type
`mateConnectors`	Array.<Connector>	Connectors that can mate with this connector type

Source:

package/package.js, line 212

CutOption

Type:

Object

Properties:

Name	Type	Attributes
`blockInstance`	BlockInstance
`oldConnections`	Array.<Connection>
`newConnection`	Connection	<optional>
`placement`	Placement

Source:

configurator/configuration.js, line 101

CutResult

Type:

Object

Properties:

Name	Type	Description
`main`	ConfiguratorState	current configuration wo the cut part
`cut`	ConfiguratorState	new configuration with the cut block instance

Source:

configurator/configurator.js, line 206

DependencyList

Type:

Object.<string, ComponentOrComponentArray>

Source:

package/component/buildable_component.js, line 504

ExportLevel

Type:

'root' | 'inline'

Source:

typedef.js, line 310

ExtendOption

Type:

Object

Properties:

Name	Type	Attributes
`block`	Block
`connection`	ConnectInstruction	<optional>
`placement`	Placement

Source:

configurator/configuration.js, line 94

GenericUpdateResult

Type:

Object

Properties:

Name	Type	Description
`configuration`	Configuration	the current configuration
`position`	Vector3	current body position
`quaternion`	Quaternion	current body quaternion
`placement`	module:configurator/configuration~Placement

Source:

configurator/configurator.js, line 162

InsertOption

Type:

Object

Properties:

Name	Type	Description
`block`	Block
`newConnection1`	ConnectInstruction
`newConnection2`	ConnectInstruction
`oldConnection`	Connection
`placement`	Placement

Source:

configurator/configuration.js, line 85

Instruction

Type:

Object

Properties:

Name Type Attributes Description

remove

Object

Properties

Name	Type	Attributes
`blockInstance`	BlockInstance	<optional>
`blockInstanceChildren`	Array.<BlockInstance>	<optional>
`materialAssignments`	Array.<MaterialAssignment>	<optional>
`connections`	Array.<Connection>	<optional>

cut Object <optional>

remove.blockInstances Array.<BlockInstance> <optional>

remove.materialAssignments Array.<MaterialAssignment> <optional>

remove.connections Array.<Connection> <optional>

add

Object

Properties

Name	Type	Attributes	Description
`block`	Block	<optional>
`materialAssignments`	Array.<Object>	<optional>
`configurations`	Array.<Object>	<optional>
`splitChainConfigurations`	Array.<Object>	<optional>
`connections`	Array.<Array.<Connector>>	<optional>	Array of arrays with two connectors that should be connected

Source:

configurator/configuration.js, line 30

LibraryNavigationItem

Type:

Object

Properties:

Name	Type	Description
`label`	string
`show`	'presets' \| BlockSetOption \| MaterialSetOption

Source:

typedef.js, line 227

LoadingQuality

Type:

'medium'

Source:

typedef.js, line 50

LogObject

Type:

Object

Properties:

Name Type Attributes Default Description

msg string

level SyslogLevel <optional> debug

time number <optional>

source

Object

Properties

Name	Type	Attributes
`id`	UUID	<optional>
`name`	string	<optional>
`type`	string	<optional>

Source:

typedef.js, line 14

LogObjectString

Stringified LogObject

Type:

string

Source:

typedef.js, line 33

MaterialSetOption

Type:

Object

Properties:

Name	Type	Description
`materialSet`	'all' \| string	name of the material set

Source:

typedef.js, line 222

MaterialType

Type:

'LineBasicMaterial' | 'LineDashedMaterial' | 'MeshBasicMaterial' | 'MeshDepthMaterial' | 'MeshDistanceMaterial' | 'MeshLambertMaterial' | 'MeshMatcapMaterial' | 'MeshNormalMaterial' | 'MeshPhongMaterial' | 'MeshPhysicalMaterial' | 'MeshStandardMaterial' | 'MeshToonMaterial' | 'PointsMaterial' | 'RawShaderMaterial' | 'ShaderMaterial' | 'ShadowMaterial' | 'SpriteMaterial'

Source:

typedef.js, line 249

NavigationOptions

Type:

Object

Properties:

Name	Type	Description
`library`	Array.<LibraryNavigationItem>

Source:

typedef.js, line 234

NotificationHandler(notification)

Parameters:

Name	Type	Description
`notification`	YoctopusNotification

Source:

server/server_connection.js, line 6

PackageLicense

Type:

'GPL'

Source:

typedef.js, line 194

PackageMetadata

Type:

Object

Properties:

Name	Type	Attributes
`id`	UUID
`name`	string
`description`	string	<optional>
`author`	string
`license`	PackageLicense
`generator`	string
`repository`	string

Source:

typedef.js, line 199

ParsedBlockInstanceString

A simple object representing a configuration body

Type:

object

Properties:

Name	Type	Description
`uuid`	UUID
`templateBlock`	UUID
`position`	Array.<number>
`rotation`	Array.<number>	LETS TURN THIS INTO QUATERNIONS

Source:

typedef.js, line 89

ParsedBodyString

A simple object representing a configuration body

Type:

object

Properties:

Name	Type	Description
`blockInstances`	Array.<ParsedBlockInstanceString>
`connections`	Array.<ParsedConnectionString>

Source:

typedef.js, line 138

ParsedConfigString

Type:

object

Properties:

Name	Type	Description
`bodies`	Array.<ParsedBodyString>
`materials`	object

Source:

typedef.js, line 152

ParsedConnectionString

A simple object representing a configuration connection

Type:

object

Properties:

Name	Type	Description
`UUID`	UUID
`from`	ParsedConnectorInstanceString
`to`	ParsedConnectorInstanceString

Source:

typedef.js, line 121

ParsedConnectorInstanceString

A simple object representing a configuration connector instance

Type:

object

Properties:

Name	Type	Description
`UUID`	UUID
`connector`	UUID
`blockInstance`	UUID

Source:

typedef.js, line 106

ParseInstruction

Type:

Object

Properties:

Name	Type	Attributes	Description
`autoLinkDependencies`	Boolean	<optional>
`parse`	Object.<string, ArrayParseType>	<optional>	Specification of whether setting arrays should be parsed as lists or alternative options. Default is list.

Source:

package/component/buildable_component.js, line 21

Placement

Type:

Object

Properties:

Name	Type	Description
`position`	Vector3
`quaternion`	Quaternion

Source:

configurator/configuration.js, line 68

ProductSummary

A summarized version of a configured product with relevant manufacturer ids, selected fabrics

Type:

Object

Properties:

Name	Type	Description
`configuration_id`	UUID
`products`	Object

Source:

typedef.js, line 72

QualityContent

Type:

Object

Properties:

Name	Type	Description
`high`	Object \| null
`medium`	Object \| null
`low`	Object \| null

Source:

typedef.js, line 286

QualitySource

Type:

Object

Properties:

Name	Type	Description
`sizeBytes`	number
`path`	string	path to file in the package

Source:

typedef.js, line 54

QualitySourceMap

Type:

Object

Properties:

Name	Type	Attributes
`high`	QualitySource	<optional>
`medium`	QualitySource
`low`	QualitySource	<optional>

Source:

typedef.js, line 60

ReportInstruction

Type:

Object

Properties:

Name	Type	Description
`sendTo`	function \| 'console' \| URL
`fromLevel`	SyslogLevel

Source:

typedef.js, line 26

Semver

Type:

String

Source:

typedef.js, line 46

SourceFile

Type:

Object

Properties:

Name	Type	Description
`inPackageURL`	string
`fileSize`	number

Source:

typedef.js, line 254

SplitOption

Type:

Object

Properties:

Name	Type	Description
`blockInstance`	BlockInstance
`oldConnections`	Array.<Connection>
`siblingChains`	Array.<Connectable>
`placement`	Placement

Source:

configurator/configuration.js, line 109

SplitResult

Type:

Object

Properties:

Name	Type	Description
`cut`	ConfiguratorState	new configurator with the cut block instance
`split`	Array.<ConfiguratorState>	new configurator for each of the split sibling chains

Source:

configurator/configurator.js, line 247

state

Type:

string

Source:

atom.js, line 10

StatesAndTransitions

Type:

Object.<state, Array.<state>>

Source:

atom.js, line 12

SubAssignable

Type:

Object

Properties:

Name	Type	Attributes
`positionedMesh`	PositionedMesh	<optional>
`positionedMeshGroup`	PositionedMeshGroup	<optional>
`materialVariantGroups`	Array.<MaterialSet>	<optional>
`assigningComponent`	BuildableComponent	<optional>

Source:

package/block/block.js, line 20

SyslogLevel

Linux syslog level 0 - 7

Type:

'emergency' | 'critical' | 'alert' | 'error' | 'warning' | 'notice' | 'info' | 'debug'

Source:

typedef.js, line 3

SyslogLevelNum

Linux syslog level 0 - 7

Type:

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

Source:

typedef.js, line 8

UUID

Universally unique identifier. 128 bit number of the form "xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx", where x is one of [0-9, a-f] and M is one of [1-5] and N is [8, 9, a, or b]

Type:

string

Source:

typedef.js, line 38

ViewPoint

Type:

Object

Properties:

Name	Type	Description
`x`	'left' \| 'center' \| 'right'
`y`	'lower' \| 'middle' \| 'upper'
`z`	'front' \| 'center' \| 'back'

Source:

typedef.js, line 187

ViewType

Type:

'dimensions' | '3D'

Source:

typedef.js, line 302

YoctopusNotification

Type:

Object

Properties:

Name Type Attributes Description

meta

object

Properties

Name	Type	Description
`id`	UUID
`type`	string
`method`	string

data object <optional>

Source:

typedef.js, line 178

YoctopusRequest

Type:

Object

Properties:

Name	Type	Attributes
`method`	string
`endpoint`	string
`id`	UUID	<optional>
`data`	object	<optional>

Source:

typedef.js, line 161

YoctopusResponse

Type:

Object

Properties:

Name Type Attributes Description

meta

object

Properties

Name	Type	Description
`id`	UUID
`method`	string
`endpoint`	string

data object <optional>

Source:

typedef.js, line 169