The Project Interface

From KScan3D

Jump to: navigation, search

Contents

Project Interface Overview

The Project interface may be accessed by selecting the Project tab at the top-left corner of the screen:


Kscan3dprojecttab.png


The Project interface consists of a toolbar, left side panels, a thumbnail panel, a 3D viewport, a right side panel, and a status bar:


Projectinterface 2.png


Toolbar

The Toolbar consists of a row of buttons at the top of the screen below the Project, Devices, and Settings tabs. The buttons are grouped by Mode, Project, Scan, Alignment, and Combine:


Kscan3d users guide toolbar.png


Mode

The Mode group consists of the Scan and Mesh Editor buttons:


Kscan3d users guide mode group.png


Scan
Selecting the Scan button will display the Meshing and Scanning panels in the left side panel.
Mesh Editor
Selecting the Mesh Editor button will display the Point Cloud Meshing, Operations, and Decimation panels in the left side panel.


Project

The Project group consists of the New, Open, and Delete buttons:


Kscan3d users guide project group.png


New
Selecting the New button will allow you to create a new project. Enter a name for your new project, choose a different default path for your project if desired, and select OK to create a new project.
Open
Selecting the Open button will allow you to open an existing project. If the project you wish to open is not listed, you can change the current path to locate the project in a different folder. Select the project, then select OK to open the project.
Delete
Selecting the Delete button will allow you to delete an existing project. If the project you wish to delete is not listed, you can change the current path to locate the project in a different folder. Select the project, then select OK to delete the project.


Scan

The Scan group consists of the Save All, Export, and Import buttons:


Kscan3d users guide scan group.png


Save All
Selecting the Save All button will save all meshes/point clouds in their current state, and all thumbnails in the Thumbnail panel will be refreshed to properly represent the current data states.
Export
Selecting the Export button will export the currently loaded (i.e. the checkbox beside the thumbnail is selected) meshes/point clouds.
KScan3D can export files in .fbx, .obj, .ply, .stl, .asc, and .3d3 file formats. To specify the export format, select the arrow on the Export button and choose a format. Each time the Export button is selected, this format will be used.
For more information about the export function, see Exporting Data.
Import
Selecting the Import button will allow you to import .obj, .stl, and .3d3 files into the current project. All meshes/point clouds that are currently in the project will remain available.


Alignment

The Alignment group consists of the Lock, Align, Undo Align, and Repeat Align buttons. If multiple sensors are connected to your computer, the Set Preset button will also be available:


Kscan3d users guide alignment group2.png


Lock
Selecting the Lock button will lock/unlock all selected meshes/point clouds. Locked meshes and point clouds cannot be modified, moved, or rotated.
Align
Selecting the Align button will align loaded and selected meshes. Aligned meshes will be automatically locked after alignment to prevent unintended modification, movement, or rotation. Note that point clouds must be processed into meshes before they can be aligned.
The Align function features two settings: Mesh Geometry and Fine Alignment. To specify the alignment setting, select the arrow on the Align button and choose a setting. Each time the Align button is selected, this alignment setting will be used.
For more information about the align function, see Aligning Data.
Undo Align
Selecting the Undo Align button will undo the previous alignment.
Repeat Align
Selecting the Repeat Align button will apply the previous alignment transform to the selected mesh.
Set Preset (Multi-sensor Setups Only)
If you are using two or more sensors, the Set Preset button will appear as part of the Alignment group.
Selecting the Set Preset button will calculate and save the position and orientation of the sensors relative to one another. All subsequent scans in all projects will now rely upon this preset to determine how generated meshes will be positioned and oriented.
For more information about scanning with multiple sensors, see Using Multiple Sensors.


Combine

The Combine group consists of the Combine, Uncombine, and Finalize buttons:


Kscan3d users guide combine group.png


Combine
Selecting the Combine button will combine the loaded and selected meshes. Combining multiple meshes removes duplicate and overlapping data and generates a single mesh. This step must be performed prior to finalizing a mesh.
Note that point clouds must be processed into meshes before they can be combined. Also note that combined meshes cannot be exported and must be finalized prior to exporting.
The combine function features an Apply Fine Alignment option. To enable or disable fine alignment during the combine process, select the arrow on the Combine button and choose the option. This option will remain as set for each combine until changed.
For more information about the combine function, see Combining Meshes.
Uncombine
Selecting the Uncombine button will unmerge a combined mesh into its original set of meshes. You can select one or more combined meshes to uncombine at the same time.
Finalize
Selecting the Finalize button will finalize a combined mesh. You must finalize a combined mesh before you can export it. You can select one or more combined meshes to finalize at the same time.
The Finalize process features three options that enable you to select and adjust mesh density, hole filling, and decimation parameters.
For more information about the finalize function, see Finalizing a Mesh.


Left Side Panels

The Left Side panels consist of the Meshing, Scanning, Point Cloud Meshing, Operations, and Decimation panels.

In Scan Mode, the Meshing and Scanning panels are displayed:


Kscan3d users guide left side panel scan mode 2.png


In Mesh Editor Mode, the Point Cloud Meshing, Operations, and Decimation panels are displayed:


Kscan3d users guide left side panel mesh editor mode.png


Meshing

The Meshing panel allows you to control how meshes are generated and aligned during the scanning process:


Kscan3d users guide meshing panel.png


Generate
The Generate drop-down list contains three options:
Mesh
Processes captured data as a mesh.
Points
Processes captured data as points.
Capture Only
Captures data and postpones processing until later (see Scanning an Object for more information).
Alignment
The Alignment drop-down list contains two options:
None
KScan3D will not attempt to align captured data with previously-processed data. This setting allows you to capture a set of scans as rapidly as possible.
Mesh Geometry
KScan3D will attempt to automatically align data with previously-processed data immediately after each capture.
Density
The Density slider controls the amount of vertex/face density created during processing. When the slider is positioned to its rightmost setting, KScan3D will generate a mesh with maximum vertex/face density. When the slider is positioned to its leftmost setting, KScan3D will generate a mesh with minimum vertex/face density.


Scanning

The Scanning panel allows you to enable batch scanning, set batch scanning parameters, and capture a scan:


Kscan3d users guide scanning panel 2.png


Enable Batch Scanning
When the "Enable Batch Scanning" checkbox is checked, KScan3D will automatically capture scans according to the two settings listed below:
Number of scans
Allows you to select how many scans you would like to capture as a batch.
Delay between scans
Allows you to set the delay time, in seconds, between each scan.
Delay (in seconds)
Allows you to set an initial delay once the SCAN button is pressed.
The SCAN Button
Press the SCAN button to capture one or more scans (see Scanning an Object for more information).


Point Cloud Meshing

The Point Cloud Meshing panel allows you to create meshes from unprocessed point cloud data:


Kscan3d users guide pcm panel.png


Alignment
The Alignment drop-down list contains two options:
None
KScan3D will not attempt to align all selected point clouds during the Build process.
Mesh Geometry
KScan3D will attempt to automatically align all selected point clouds during the Build process.
Mesh Density
The Mesh Density slider controls the amount of vertex/face density created during processing. When the slider is positioned to its rightmost setting, KScan3D will generate a mesh with maximum vertex/face density. When the slider is positioned to its leftmost setting, KScan3D will generate a mesh with minimum vertex/face density.
The Build Button
Once you have selected an Alignment option and adjusted the Mesh Density slider, select the Build button to process the selected point cloud(s) and generate mesh(es).


Operations

The Operations panel allows you to Smooth and Erode selected meshes:


Kscan3d users guide operations panel.png


Smooth
The Smooth function applies the specified number of smoothing passes to the selected meshes. Each pass smooths a mesh by averaging the angles between individual polygons.
The selected meshes must be loaded (i.e. the checkboxes beside each mesh thumbnail must be checked) for this feature to be active. Note that point clouds and combined scans are not supported.
Once you have entered the number of smoothing passes you wish to apply to the selected meshes, select the Smooth button to process the meshes.
Erode
The Erode function applies the specified number of erosion passes to the selected meshes. Each erosion pass removes one polygon strip from all edges in the mesh. Erosion will also cause all existing holes to grow larger.
The selected meshes must be loaded (i.e. the checkboxes beside each mesh thumbnail must be checked) for this feature to be active. Note that point clouds and combined scans are not supported.
Once you have entered the number of erosion passes you wish to apply to the selected meshes, select the Erode button to process the meshes.


Decimation

The Decimation panel allows you to decimate selected meshes:


Kscan3d users guide decimation panel.png


Decimation simplifies the mesh by reducing the number of vertices and faces used in the surface while preserving the overall shape of the mesh.

The selected meshes must be loaded (i.e. the checkboxes beside each mesh thumbnail must be checked) for this feature to be active. Note that point clouds and combined scans are not supported.

Vertices
You can enter the estimated amount of vertices you wish the mesh(es) to retain after decimation.
Percent
Alternatively, you can adjust the slider to select an estimated percentage level of decimation. The number of vertices listed above the slider will change to reflect the estimated final vertex count after decimation.
The Decimate Button
Once you have entered the target number of vertices and/or adjusted the percentage slider, select the Decimate button to process the selected meshes.


Thumbnail Panel

The Thumbnail panel is the vertical panel located between the left side panels and the 3D viewport:


Kscan3d users guide thumbnailpanel.png


This panel displays small thumbnail images of each mesh or point cloud that has been scanned and/or imported into the current project.

You can hide or unhide the thumbnail images by selecting the Toggle Thumbnails button Kscan3d users guide thumbnail panel toggle thumbnails.png at the top-left corner of the panel:

Beside each thumbnail is a checkbox and an icon:


Kscan3d users guide thumbnail panel thumbnail.png


When the checkbox is selected, the mesh or point cloud is "loaded" and becomes visible in the 3D viewport. Deselecting the checkbox will "unload" the mesh or point cloud and hide it from the 3D viewport. Note that unloaded/hidden meshes and point clouds cannot be edited.

The icon located between the checkbox and the thumbnail image indicates whether the scan data is a single mesh Kscan3d users guide single mesh icon.png, combined mesh Kscan3d users guide combined mesh icon.png, or a point cloud Kscan3d users guide point cloud icon.png.

You can select a thumbnail by left-clicking it. The border of a selected thumbnail will turn red:


Kscan3d users guide thumbnail panel thumbnailselected.png


To select multiple thumbnails, hold down the CTRL key as you left-click each thumbnail. To select a group of adjacent thumbnails, select a thumbnail, hold down the SHIFT key, and select a different thumbnail:


Kscan3d users guide thumbnail panel multipleselected.png


When multiple thumbnails are selected, you can hide and unhide the thumbnails by selecting one of checkboxes beside any of the selected thumbnails. You can also lock and unlock the selected thumbnails by selecting the Lock button in the Toolbar.


Right-Click Pop-Up Menu

Right-clicking within the Thumbnail panel will display a pop-up menu. This menu consists of Save, Rename, Revert, Delete, Duplicate, Lock, Open Folder, and Show Images options:


Kscan3d users guide thumbnail panel right click pop up.png


Save
If any existing meshes/point clouds have been edited, the Save option will be available. Selecting this option will save all meshes/point clouds in their current state, and all thumbnails will be refreshed to properly represent the current data states.
Rename
If only one thumbnail is selected, the Rename option will be available. Selecting this option will allow you to rename the selected thumbnail/scan.
Revert
Selecting the Revert option will revert all selected meshes/point clouds to their original states. Note that all modifications to each mesh/point cloud will be lost.
Delete
Selecting the Delete option will delete all selected meshes/point clouds.
Duplicate
Selecting the Duplicate option will duplicate all selected meshes/point clouds.
Lock
Selecting the Lock option will lock or unlock all loaded and selected meshes/point clouds.
Open Folder
If only one thumbnail is selected, the Open Folder option will be available. Selecting this option will launch Windows Explorer and open the data directory for the selected thumbnail/scan.
Show Images
If only one thumbnail is selected, selecting the Show Images option will launch an image viewer and display the RGB image that was captured when the original scan was performed.


3D Viewport

The 3D Viewport consists of the 3D Viewport Toolbar, the Viewport, and a Right-Click Pop-Up Menu:


Kscan3d users guide 3d viewport.png


3D Viewport Toolbar

The 3D Viewport Toolbar provides ways to visualize and interact with the data in the 3D viewport. It also lists important information about your scan data:


Kscan3d users guide 3d viewport toolbar.png


Solid

Kscan3d users guide button s.png Select this button to display all meshes as solids. Note that point clouds will not be represented as solids.


Textured

Kscan3d users guide button textured.png Select this button to display all meshes and point clouds with texture data.


Wireframe

Kscan3d users guide button wireframe.png Select this button to display all meshes as wireframes. Note that point clouds will not be represented as wireframes.


Points

Kscan3d users guide button points.png Select this button to display all meshes and point clouds as points.


Enable Specular Highlighting

Kscan3d users guide button enablespecular.png Select this button to display all meshes with specular highlighting. Note that meshes will not be displayed with specular highlighting if the Textured button is selected.


Use Colours

Kscan3d users guide button usecolours.png Select this button to display all loaded meshes and point clouds with colors. This feature can be helpful when editing meshes and point clouds.


Display Bounding Boxes

Kscan3d users guide button displayboxes.png Select this button to display a bounding box around the selected mesh or point cloud.


Display 3D Control Widget

Kscan3d users guide button display3dwidget.png Select this button to display the 3D Control Widget in the viewport:


Kscan3d users guide 3dcontrolwidget.png


The 3D Control Widget provides an alternative visual method to move and rotate meshes and point clouds.


Perspective

Kscan3d users guide button perspective.png Select this button to display the 3D viewport in perspective view.


Orthographic

Kscan3d users guide button orthographic.png Select this button to display the 3D viewport in orthographic view.


Recenter

Kscan3d users guide button recenter.png Select this button to recenter the view so all visible meshes and point clouds will be displayed within the 3D viewport.


Vertices

This field displays the number of vertices contained in the loaded meshes and/or point clouds.


Faces

This field displays the number of faces contained in the loaded meshes and/or point clouds.


Controls

Kscan3d users guide button controls.png Select this button to display the keyboard/mouse button controls:


Kscan3d users guide controls.png


3D Viewport

The 3D Viewport displays the meshes and point clouds you've captured:


Kscan3d users guide 3d viewport display.png


As you load and unload meshes and point clouds in the Thumbnail panel, they will become visible and invisible in the viewport.


Within the viewport, you can move and rotate your view of the data:

To pan the view
Click and drag while pressing both the left and right mouse buttons.
To zoom the view
Click and drag while pressing the right mouse button. Alternatively, you can scroll the mouse scroll wheel.
To rotate the view
Click and drag while pressing the left mouse button.
To rotate the view around the Z (depth) axis
Press and hold the SHIFT key, then click and drag while pressing the left mouse button.


You can also move and rotate the data itself. This is especially handy for repositioning data to help KScan3D align meshes if the automatic alignment process did not work properly. For more information, see Aligning Data.

To move a mesh
Press and hold the ALT key, then click and drag while pressing both the left and right mouse buttons. Alternatively, you can use the 3D Control Widget (see above): click and drag the yellow sphere in the center of the widget with the left mouse button.
To rotate a mesh
Press and hold the ALT key, then click and drag while pressing the left mouse button. Alternatively, you can click and drag any of the three rotation rings on the 3D Control Widget with the left mouse button.
To rotate a mesh around the Z (depth) axis
Press and hold the SHIFT and ALT keys, then click and drag while pressing the left mouse button. Alternatively, you can click and drag the yellow rotation ring on the 3D Control Widget with the left mouse button.


Finally, you can select points within displayed meshes and point clouds. Selected points may be deleted, and selection sets may be inverted. For more information about editing, see Editing Data.

To select points
Press and hold the CTRL key, then click and drag while pressing the left mouse button to draw a lasso around the points you wish to select. The selected points will become highlighted.
To add more points to the selection
Press and hold the SHIFT and CTRL keys, then click and drag while pressing the left mouse button.

To delete and/or invert point selections, see below.


Right-Click Pop-Up Menu

Right-clicking within the 3D Viewport will display a pop-up menu. This menu consists of Delete Points, Invert Selection, Measure, Recenter, Selection, and Projection options and sub-options:


Kscan3d users guide 3d viewport right click pop up.png


Delete Points
Select this option to delete selected points. For more information about editing, see Editing Data.
Invert Selection
Select this option to invert the selection of points.
Measure
Select this option to measure the distance between two points. Left-click to select the first point, then left-click to select the second point. The distance will be listed in millimeters directly above the viewport.
Recenter
Select this option to recenter the view so all visible meshes and point clouds will be displayed within the 3D viewport. Note that this option provides the same functionality as the Recenter button in the toolbar.
Selection
This feature is unused and will be removed in an upcoming build.
Projection
The two sub-options below this option allow you to choose between perspective and orthographic projections in the 3D viewport. Note that this option provides the same functionality as the Perspective and Orthographic buttons in the toolbar.


Right Side Panel

The right side panel consists of Scanner X/Y/Z Settings, Camera Live Video Feeds, the Expand/Contract Border, and the Hide/Unhide Button:


Kscan3d users guide right side panel.png


Scanner X/Y/Z Settings

The Scanner X/Y/Z Settings consist of X Percent, Y Percent, Z Minimum, and Z Range sliders:


Kscan3d users guide scanner xyz settings.png


By adjusting these sliders, you can specify the volume of data you would like to capture and block out unwanted data you don't need.

X Percent
Adjust this slider to narrow and widen the scanning range on the X (left/right) axis.
Y Percent
Adjust this slider to narrow and widen the scanning range on the Y (up/down) axis.
Z Minimum
Adjust this slider to move the scanning depth volume closer to and further from the sensor on the Z (depth) axis. Note that scan data quality is reduced as the distance from the Kinect increases. To capture quality data, it's best to scan at fairly close range.
Z Range
Adjust this slider to narrow and widen the scanning depth volume on the Z (depth) axis.


Camera Live Video Feeds

The Camera Live Video Feeds consist of a Depth + RGB Live Video Feed and a Depth Live Video Feed:


Kscan3d users guide camera live video feeds.png


Depth + RGB Live Video Feed
This video feed displays a combination of RGB sensor data and depth sensor data.
Depth Live Video Feed
This video feed displays depth sensor data in grayscale. Closer data is lighter, further data is darker.

You can select the camera icons Kscan3d users guide button live.png above each feed to turn each live video feed on or off, if desired.


Pure black areas within the live video feeds indicate data that will not be captured during a scan. Areas may be black for the following reasons:

The volume of data is out of range
Either the X/Y/Z sliders are limiting the scanning range or the sensor cannot register the data because the object is too close or too far away. Check the X/Y/Z sliders and/or reposition the sensor and/or object as needed.
The surface(s) cannot be scanned
The surface of the object may be too dark, reflective, and/or transparent/translucent. Try repositioning the sensor and/or object, as that may help the sensor capture the data. See Scanning Basics for more information about surface qualities and preparation.
Lighting conditions are not optimal
It may be too bright or too dark to capture the data. Try repositioning the sensor and/or object to help the sensor capture the data. Note that scanning outdoors in the sunlight is usually difficult if not impossible. See Scanning Basics for more information about lighting conditions.


Red areas indicate overexposed areas. This may be due to lighting conditions and/or the surface qualities of the object. Depending on the level of overexposure, mesh/point cloud data may or may not be captured, and vertex color data will be captured as pure white.

Note that the sensors feature built-in aperture control. You may be able to reposition the sensor and/or the object in order to provide better scanning conditions.


If you hover your mouse cursor over a feed, an icon will appear in the top-left corner of the feed and a window will appear beside the feed. If you click the icon, four options will appear:


Zoom

Kscan3d users guide button zoom.png If this option is selected, the window beside the live feeds will display zoomed-in images of the feeds.


Lines

Kscan3d users guide button lines.png If this option is selected, the window beside the live feeds will display histograms of the feeds. The histogram represents the grayscale values in the feed. If you vertically drag the mouse cursor over the live feed, you will notice the histogram change. The histogram represents the grayscale values for each horizontal line in the feed. Lighter values are charted higher on the histogram, darker values are charted lower.


None

Kscan3d users guide button n.png If this option is selected, no windows will appear beside the live feeds.


Large Window

Select this option to make the windows beside the live feeds larger.


Expand/Contract Border

Left-clicking and dragging the border separating the 3D Viewport and the right side panel will expand and contract the viewport and panel:


Kscan3d users guide expand contract border.png


Hide/Unhide Button

Selecting the "gear" icon on the far right-side of the screen will hide and unhide the right side panel:


Kscan3d users guide hide unhide button.png


Status Bar

The Status Bar consists of a row of fields and buttons at the bottom of the screen:


Kscan3d users guide status bar.png


Project
This field displays the name of the current project.
Number of Scans
This field displays the number of scans in the current project.
Status
This button displays the current status of KScan3D. Select the status message to display a list of previous status messages.
Show Script Editor
This button launches the Script Editor. For more information, see Automation and Script Commands.
System Check
This field indicates the status of the scanner system.


NEXT: The Devices Interface



Site Map

APIAbout KScan3DAligning Data
AutomationCombining MeshesCopyright Notice
Creating A Multi-Sensor Setup For Full Body ScanningEditing DataEnd User License Agreement
Exporting DataFAQFinalizing a Mesh
First StepsHardware RequirementsInstallation
KScan3D Driver SwitcherMain PageRelease Notes
Scanning BasicsScanning an ObjectThe Devices Interface
The Project InterfaceThe Settings InterfaceTroubleshooting
Tutorial VideosUsing Multiple Sensors
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox