ScaffoldVuer
A vue component of the scaffold viewer.
Props
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
| url | URL of the zincjs metadata. This value will be ignored if a valid state prop is also provided. If the url needs to be updated with state present, please use the setURL method. | String | false | - |
| showColourPicker | Show the colour control of set to true. | Boolean | false | false |
| displayUI | Flag to show/hide the UI. | Boolean | false | true |
| displayAtStartUp | Display all graphics at start. This setting only works when traditional is set to false. | Boolean | false | true |
| helpMode | Use for toggling the help tooltips. | Boolean | false | false |
| displayWarning | Use for show/display beta warning icon. | Boolean | false | true |
| warningMessage | Warning message for the hovered over text on the warning icon. | String | false | Beta feature - under active development |
| displayLatestChanges | - | Boolean | false | false |
| latestChangesMessage | - | String | false | New feature - Local search is now available |
| displayMarkers | Show/hide pickable markers for regions. | Boolean | false | false |
| markerLabels | - | Array | false | [] |
| displayMinimap | Show/hide minimap. | Boolean | false | false |
| format | Format of the input URL | String | false | metadata |
| minimapSettings | Settings for minimap position, size and alignment. | Object | false | {"x_offset":16,"y_offset":16,"width":128,"height":128,"align":"top-right"} |
| enableOpenMapUI | Flag to determine rather the open map UI icon and popup should be shown or not. | Boolean | false | false |
| openMapOptions | This array populate the the openMapOptions popup. Each entry contains a pair of display and key. | Array | false | [{"display":"Open AC Map","key":"AC"},{"display":"Open FC Map","key":"FC"},{"display":"Open 3D Human Map","key":"3D"}] |
| state | State containing state of the scaffold. | Object | false | undefined |
| region | Optional prop for the name of the region to focus on, this option is ignored if state or viewURL is also provided. | String | false | - |
| viewURL | Optional prop for an URL of containing information of a viewport. This option is ignored if state is also provided. It will use the provided URL as base if a relative parth is provided. | String | false | - |
| render | Settings for turning on/off rendering | Boolean | false | true |
| flatmapAPI | Specify the endpoint of the flatmap server. This is used by annotation service included in third party flatmapvuer library. | String | false | https://mapcore-demo.org/current/flatmap/v3/ |
Events
| Event Name | Description | Parameters |
|---|---|---|
| timeChanged | Emit when time in the current scene has changed | Current time in scene |
| zinc-object-added | Emit when a new object is added to the scene | The object added to the sceene |
| scaffold-selected | Emit when an object is selected | Identifier of selected objects |
| scaffold-highlighted | Emit when an object is highlighted | Identifier of selected objects |
| on-ready | Emit when all objects have been loaded | - |
| scaffold-navigated | Emit when the scene has been transformed due to navigation, only triggered during syncControl mode | Information on the navigation |
| open-map | - | - |
Methods
| Method | Description | Parameters |
|---|---|---|
| addZincObject | Call this to manually add a zinc object into the current scene | Zinc object to be added |
| captureScreenshot | Function for capturing a screenshot of the current rendering. | filename given to the screenshot. |
| clearScene | Function to clear current scene, the tree controls and the search index. | - |
| fitWindow | Function to reset the view to default. Also called when the associated button is pressed. | - |
| zoomIn | Function to zoom in. Also called when the associated button is pressed. | - |
| zoomOut | Function to zoom out. Also called when the associated button is pressed. | - |
| speedChanged | Function to change the current play speed. | - |
| stopFreeSpin | Function used to stop the free spin | - |
| findObjectsWithGroupName | Return a list of obejcts with the provided name. | Group name to search. |
| viewRegion | Find and and zoom into objects with the provided list of names. | List of names |
| getRendererInfo | Return renderer information | - |
| freeSpin | Function used to rotate the scene. Also called when the associated button is pressed. | - |
| getCoordinatesOfSelected | Get the coordinates of the current selected region. | - |
| getDynamicSelectedCoordinates | Return an object containing the window coordinates of the current selected region which will be updated after each render loop. | - |
| play | Start the animation. | flag to turn the animation on/off |
| setHelpMode | Function to toggle on/off overlay help. | - |
| hideRegionTooltip | Hide the tooltip | - |
| setMarkerModeWithAnnotations | Set the marker modes for objects specified by the list of annotations | - |
| search | Search a object and display the tooltip | text to search across toggle the tooltip if this is set |
| fetchSuggestions | Get the list of suggested terms based on the provided term. This can be used for autocomplete. | - |
| getState | Function used for getting the current states of the scene. This exported states can be imported using the importStates method. | - |
| setState | Function used for importing the states of the scene. This exported states can be imported using the read states method. | - |
| exportGLTF | export current scene in GLTF. | Return in binary form when set to true |
| setURLAndState | Function used for reading in new scaffold metadata and a custom viewport. This function will ignore the state prop and read in the new url. | - |
| setURL | Function used for reading in new scaffold metadata. This function will ignore the state prop and read in the new url. | - |
| forceResize | Force the renderer to resize | - |