ShapeDiver 3D Viewer Class: ViewportApi

Add a callback to be invoked when a certain event occurs

Parameters:

Name	Type	Description
`type`	ApiEventType	Type of event to subscribe to
`callback`	EventListenerCallback	Function to be called when the event fires

Inherited From:

addEventListener

Overrides:

addEventListener

Returns:

Type	Description
APIResponse	APIResponse with an EventListenerToken object. The event listener token can be used to remove the event listener by calling removeEventListener.

applyTransformation(matrix)

Applies a 4x4 transformation matrix or an array of transformation matrices to this viewport.

Parameters:

Name	Type	Description
`matrix`	ApiSceneInterface#Transformation \| Array.<ApiSceneInterface#Transformation>	The transformation matrix or an array of matrices

Inherited From:

applyTransformation

Overrides:

applyTransformation

Returns:

Type	Description
Promise.<APIResponse>	API response with a data array of type boolean.

convertTo2D(position)

Converts the given 3D coordinates into various 2D coordinates

See:

ApiSceneInterface#2DCoordinateSummary

Parameters:

Name	Type	Description
`position`	Point3d	The 3D point to convert

Inherited From:

convertTo2D

Overrides:

convertTo2D

Returns:

Type	Description
ApiSceneInterface#2DCoordinateSummary	A summary of the different 2D coordinates

destroy()

Destroys the current viewport. This api will be invalid after this operation.

Inherited From:

destroy

Overrides:

destroy

getContainer()

Returns the container in which the viewer is.

Inherited From:

getContainer

Overrides:

getContainer

Returns:

Type	Description
HTMLElement	the container of the viewer

| Object

getRuntimeId()

Get the runtime id used for this API object. The runtime id can optionally be specified as a setting when creating the API object, otherwise a random one will be created.

Inherited From:

getRuntimeId

Overrides:

getRuntimeId

Returns:

Type	Description
String	runtime id used for API instance, should be unique

getScreenshot()

Get screenshot as a png data URI. Returns a screenshot of the viewer canvas without any control elements as a data URI using the png image format.

Inherited From:

getScreenshot

Overrides:

getScreenshot

Returns:

Type	Description
String	Data URI representing the png screeshot image (data:image/png;base64,...).

getSelected()

Get scene paths of selected objects.

See:

ApiSceneInterface#getSelected

Inherited From:

getSelected

Overrides:

getSelected

getSetting(key)

Provides a copy of an individual setting

Parameters:

Name	Type	Description
`key`	String	name of setting (e.g. 'scene.render.shadows')

Inherited From:

getSetting

Overrides:

getSetting

Returns:

Type	Description
*	a copy of the setting, undefined if not found

getSettingDefinitions()

Provides an object describing all available settings

Inherited From:

getSettingDefinitions

Overrides:

getSettingDefinitions

Returns:

Type	Description
Object	object describing all available settings, their type, and constraints

getSettings( [keys])

Provides a copy of all or multiple settings

Parameters:

Name	Type	Argument	Description
`keys`	Array.<String>	<optional>	optional array of keys, keys which don't exist are ignored, if omitted all settings will be returned

Inherited From:

getSettings

Overrides:

getSettings

Returns:

Type	Description
Object	object containing a copy of the settings

getSize()

Return the current size of the viewport.

Inherited From:

getSize

Overrides:

getSize

Returns:

Type	Description
Object	API response with a data array of type matrix or an array of matrices.

getTransformation()

Returns the 4x4 transformation matrix or an array of them for this viewport.

Inherited From:

getTransformation

Overrides:

getTransformation

Returns:

Type	Description
Promise.<APIResponse>	API response with a data array of type matrix or an array of matrices.

onResize(width, height)

The viewer was resized, resize the viewport.

Parameters:

Name	Type	Description
`width`	Number
`height`	Number

Inherited From:

onResize

Overrides:

onResize

pause()

Pause the rendering.

Inherited From:

pause

Overrides:

pause

reload()

Destroys the current viewport and reloads it directly afterwars.

Inherited From:

reload

Overrides:

reload

removeEventListener(token)

Remove an event listener

Parameters:

Name	Type	Description
`token`	EventListenerToken	event listener token for event listener to be removed

Inherited From:

removeEventListener

Overrides:

removeEventListener

Returns:

Type	Description
APIResponse	APIResponse with a Boolean data, indicating whether the event listener could be removed.

render()

Render the scene.

Inherited From:

render

Overrides:

render

resetTransformation()

Resets the 4x4 transformation matrix or the array of transformation matrices for this viewport.

Inherited From:

resetTransformation

Overrides:

resetTransformation

Returns:

Type	Description
Promise.<APIResponse>	API response with a data array of type boolean.

resume()

Resume the rendering.

Inherited From:

resume

Overrides:

resume

<abstract> setLiveTransformation()

Set a live transformation for this viewport.

See:

ApiSceneInterface#setLiveTransformation

Inherited From:

setLiveTransformation

Overrides:

setLiveTransformation

setTransformation(matrix)

Sets a 4x4 transformation matrix for this viewport.

Parameters:

Name	Type	Description
`matrix`	ApiSceneInterface#Transformation \| Array.<ApiSceneInterface#Transformation>	The transformation matrix or an array of transformation matrices

Inherited From:

setTransformation

Overrides:

setTransformation

Returns:

Type	Description
Promise.<APIResponse>	API response with a data array of type boolean.

updateSelected()

Update selection status of objects.

See:

ApiSceneInterface#updateSelected

Inherited From:

updateSelected

Overrides:

updateSelected

updateSettingAsync(key, val)

Update an individual setting, if allowed.

See:

getSettingDefinitions

Parameters:

Name	Type	Description
`key`	String	name of setting
`val`	Object	new value of setting

Inherited From:

updateSettingAsync

Overrides:

updateSettingAsync

Returns:

Type	Description
Promise.<APIResponse>	APIResponse whose data property will be true if setting could be changed, false if not.

updateSettingsAsync(settings)

Update a bunch of settings according to the enumerable properties of an object, if allowed.

Parameters:

Name	Type	Description
`settings`	Object	object whose own properties should be used as settings

Inherited From:

updateSettingsAsync

Overrides:

updateSettingsAsync

Returns:

Type	Description
Promise.<APIResponse>	APIResponse whose data property will be set to a copy of the input object, whose property values are replaced by true or false depending on whether the corresponding setting could be updated.