SBSDK3 Namespace Reference

Classes
class	ISBScanner
	Interface with Scan Box Scanner instances. More...
class	SBCalib
	Stores and manages information related to the scanner calibration. More...
class	SBCaptureParams
struct	SBColor
	RGBA color structure. More...
class	SBDeviceEventMessage
	SBEventMessage derived class to implement event based behavior based on the scanner's events or status. Under development. More...
class	SBDeviceInfo
	Used to store information about a scanner. More...
class	SBDeviceList
	Used to store information about the detected devices. More...
class	SBErrorEventMessage
	SBEventMessage derived class to implement behavior based on an error message. Under development. More...
class	SBEventHandler
	Parent to implement event based behavior using the GPIO ports of the scanner. More...
class	SBEventMessage
	SBEventMessage base class. More...
struct	SBFace
	Contains vector indexes defining a mesh face. More...
class	SBFactory
	Instantiating class for ISBScanner Objects. More...
class	SBImage
	Contains Image and properties. More...
class	SBImageList
	SBImage Container. More...
class	SBInputEventMessage
	SBEventMessage derived class to implement event based behavior using the GPIO ports of the scanner. More...
class	SBMesh
	Mesh Class Definition. SBMesh contains the information related to the vertices and vaces, as well as functions to access the data. More...
class	SBProcessParams
class	SBScan
	Class containing scan Images and accessing functions. More...
class	SBScanHandler
	Parent class to implement onScanCaptured callback function. More...
class	SBTransform
	Transform Class Definition. SBTransform contains the transformation matrix. More...
struct	SBUv
struct	SBVector
	3 Dimensional Vector More...

Typedefs
typedef enum SBSDK3::SBStatus	SBStatus
typedef enum SBSDK3::SBScannerModelEnums	SBScannerModelEnums
typedef enum SBSDK3::SBCameraIDEnums	SBCameraIDEnums
typedef enum SBSDK3::SBProjectorPatternEnums	SBProjectorPatternEnums
typedef enum SBSDK3::SBProjectorColorEnums	SBProjectorColorEnums
typedef enum SBSDK3::SBTriggerModeEnums	SBTriggerModeEnums
typedef enum SBSDK3::SBEventEnums	SBEventEnums
typedef enum SBSDK3::SBScanTypeEnums	SBScanTypeEnums
typedef enum SBSDK3::SBScanCleanupEnums	SBScanCleanupEnums

Enumerations
enum class	SBStatus {   OK = 0 , FAILED = 1 , DEVICE_NOT_FOUND = 100 , DEVICE_BUSY = 101 ,   DEVICE_NOT_CONNECTED = 102 , FEATURE_NOT_SUPPORTED = 110 , NO_CALIBRATION = 111 , SERIAL_DEVICE_FIRMWARE_VERSION_NOT_COMPATIBLE = 112 ,   CONNECT_FAILED = 120 , PROJECTOR_CONNECT_FAILED = 121 , CAMERA_CONNECT_FAILED = 122 , EEPROM_WRITE_FAILED = 200 ,   EEPROM_READ_FAILED = 201 , CAMERA_CAPTURE_FAILED = 210 , PROJECTOR_PATTERN_SEQ_START_FAILED = 211 , ABNORMAL_NUMBER_OF_SCAN_IMAGES = 212 ,   INVALID_PARAMETER = 300 , SET_PARAMETER_FAILED = 301 , GET_PARAMETER_FAILED = 302 , CAMERA_SET_PARAMETER_FAILED = 303 ,   CAMERA_GET_PARAMETER_FAILED = 304 , PROJECTOR_SET_PARAMETER_FAILED = 305 , PROJECTOR_GET_PARAMETER_FAILED = 306 , PROJECTOR_PATTERN_IMAGE_RESOLUTION_MISMATCH = 307 ,   DATA_PROCESSING_FAILED = 400 , GIGE_DEVICE_INITIALIZATION_FAILED = 501 , GIGE_COMMUNICATION_ERROR = 502 , GIGE_COMMAND_ERROR = 503 ,   GIGE_COMMAND_WRITE_FAILED = 504 , GIGE_COMMAND_RECEIVE_FAILED = 505 , GIGE_DATA_SEND_FAILED = 506 , GIGE_DATA_RECEIVE_FAILED = 507 ,   PROJECTOR_PATTERN_IMAGE_READ_FAILED = 600 }
	Scanner Status. More...
enum class	SBScannerModelEnums {   POLYGA_SCANNER = -1 , L6 = 0 , S1 , S5 ,   H3 , Carbon , EVM , V1 ,   C210 = 10 , C506 , C504 }
	Scanner Model. More...
enum class	SBCameraIDEnums { LEFT = 0 , RIGHT = 1 , TEXTURE = 2 , NONE = 9 }
enum class	SBProjectorPatternEnums { WHITE = 0 , BLACK = 1 , PHASE = 2 , FOCUS = 3 }
	Projector Pattern. More...
enum class	SBProjectorColorEnums {   OFF = 0 , RED = 1 , GREEN = 2 , BLUE = 4 ,   WHITE = 7 }
	Projector Color. More...
enum class	SBTriggerModeEnums { OFF = 0 , SOFTWARE = 1 }
	Trigger mode. More...
enum class	SBEventEnums { INPUT_EVENT = 0 , DEVICE_EVENT , ERROR_EVENT }
	Event Type. More...
enum class	SBScanTypeEnums {   POINT_CLOUD_RAW = 0 , POINT_CLOUD , MESH , MESH_DECIMATED ,   CAPTURE_ONLY }
	Scan Type options: [POINT_CLOUD_RAW, POINT_CLOUD, MESH, MESH_DECIMATED, CAPTURE_ONLY]. More...
enum class	SBScanCleanupEnums { NONE = 0 , LOW = 1 , STANDARD = 2 , HIGH = 3 }
	Cleanup Settings. More...

Functions
SBSDK_API SBStatus	ProcessScan (SBMesh &mesh_out, SBScan &scan_in, SBProcessParams processParams=SBProcessParams())

Typedef Documentation

SBStatus

typedef enum SBSDK3::SBStatus SBSDK3::SBStatus

SBScannerModelEnums

typedef enum SBSDK3::SBScannerModelEnums SBSDK3::SBScannerModelEnums

SBCameraIDEnums

typedef enum SBSDK3::SBCameraIDEnums SBSDK3::SBCameraIDEnums

SBProjectorPatternEnums

typedef enum SBSDK3::SBProjectorPatternEnums SBSDK3::SBProjectorPatternEnums

SBProjectorColorEnums

typedef enum SBSDK3::SBProjectorColorEnums SBSDK3::SBProjectorColorEnums

SBTriggerModeEnums

typedef enum SBSDK3::SBTriggerModeEnums SBSDK3::SBTriggerModeEnums

SBEventEnums

typedef enum SBSDK3::SBEventEnums SBSDK3::SBEventEnums

SBScanTypeEnums

typedef enum SBSDK3::SBScanTypeEnums SBSDK3::SBScanTypeEnums

SBScanCleanupEnums

typedef enum SBSDK3::SBScanCleanupEnums SBSDK3::SBScanCleanupEnums

Enumeration Type Documentation

SBStatus

enum class SBSDK3::SBStatus

strong

Scanner Status.

SBStatus	Enum Value	Description
OK	0	Scanner working properly
FAILED	1	Failed to operate the function
DEVICE_NOT_FOUND	100	Device is not detected
DEVICE_BUSY	101	Device is busy
DEVICE_NOT_CONNECTED	102	Device is not connected
FEATURE_NOT_SUPPORTED	110	Scanner does not support the desired feature
NO_CALIBRATION	111	Uncalibrated scanner
SERIAL_DEVICE_FIRMWARE_VERSION_NOT_COMPATIBLE	112	Serial device (e.g., Teensy) firmware version is not compatible
CONNECT_FAILED	120	Failed connection
PROJECTOR_CONNECT_FAILED	121	Failed connection with projector
CAMERA_CONNECT_FAILED	122	Camera connection failure
EEPROM_WRITE_FAILED	200	Failing to write to EEPROM
EEPROM_READ_FAILED	201	EEPROM Read failure
CAMERA_CAPTURE_FAILED	210	Failing capturing an image
PROJECTOR_PATTERN_SEQ_START_FAILED	211	Start of sequence pattern failed
ABNORMAL_NUMBER_OF_SCAN_IMAGES	212	Abnormal number of scan images
INVALID_PARAMETER	300	Input parameters invalid
SET_PARAMETER_FAILED	301	Failed to set parameters
GET_PARAMETER_FAILED	302	Failed to get parameters
CAMERA_SET_PARAMETER_FAILED	303	Camera set parameters failed
CAMERA_GET_PARAMETER_FAILED	304	Camera get parameters failed
PROJECTOR_SET_PARAMETER_FAILED	305	Projector set parameters failed
PROJECTOR_GET_PARAMETER_FAILED	306	Projector get parameters failed
PROJECTOR_PATTERN_IMAGE_RESOLUTION_MISMATCH	307	Mismatch between projector pattern images' resolution and projector
DATA_PROCESSING_FAILED	400	Data processing failed
GIGE_DEVICE_INITIALIZATION_FAILED	501	GigE device initialization failed
GIGE_COMMUNICATION_ERROR	502	GigE device communication error
GIGE_COMMAND_ERROR	503	GigE device command error
GIGE_COMMAND_WRITE_FAILED	504	GigE device command write failed
GIGE_COMMAND_RECEIVE_FAILED	505	GigE device command receive failed
GIGE_DATA_SEND_FAILED	506	GigE device data send failed
GIGE_DATA_RECEIVE_FAILED	507	GigE device data receive failed
PROJECTOR_PATTERN_IMAGE_READ_FAILED	600	Projector pattern image file read failed

Enumerator
OK
FAILED
DEVICE_NOT_FOUND
DEVICE_BUSY
DEVICE_NOT_CONNECTED
FEATURE_NOT_SUPPORTED
NO_CALIBRATION
SERIAL_DEVICE_FIRMWARE_VERSION_NOT_COMPATIBLE
CONNECT_FAILED
PROJECTOR_CONNECT_FAILED
CAMERA_CONNECT_FAILED
EEPROM_WRITE_FAILED
EEPROM_READ_FAILED
CAMERA_CAPTURE_FAILED
PROJECTOR_PATTERN_SEQ_START_FAILED
ABNORMAL_NUMBER_OF_SCAN_IMAGES
INVALID_PARAMETER
SET_PARAMETER_FAILED
GET_PARAMETER_FAILED
CAMERA_SET_PARAMETER_FAILED
CAMERA_GET_PARAMETER_FAILED
PROJECTOR_SET_PARAMETER_FAILED
PROJECTOR_GET_PARAMETER_FAILED
PROJECTOR_PATTERN_IMAGE_RESOLUTION_MISMATCH
DATA_PROCESSING_FAILED
GIGE_DEVICE_INITIALIZATION_FAILED
GIGE_COMMUNICATION_ERROR
GIGE_COMMAND_ERROR
GIGE_COMMAND_WRITE_FAILED
GIGE_COMMAND_RECEIVE_FAILED
GIGE_DATA_SEND_FAILED
GIGE_DATA_RECEIVE_FAILED
PROJECTOR_PATTERN_IMAGE_READ_FAILED

SBScannerModelEnums

enum class SBSDK3::SBScannerModelEnums

strong

Scanner Model.

Enumerator
POLYGA_SCANNER
L6
S1
S5
H3
Carbon
EVM
V1
C210
C506
C504

SBCameraIDEnums

enum class SBSDK3::SBCameraIDEnums

strong

Enumerator
LEFT
RIGHT
TEXTURE
NONE

SBProjectorPatternEnums

enum class SBSDK3::SBProjectorPatternEnums

strong

Projector Pattern.

Enumerator
WHITE
BLACK
PHASE
FOCUS

SBProjectorColorEnums

enum class SBSDK3::SBProjectorColorEnums

strong

Projector Color.

Enumerator
OFF
RED
GREEN
BLUE
WHITE

SBTriggerModeEnums

enum class SBSDK3::SBTriggerModeEnums

strong

Trigger mode.

Enumerator
OFF
SOFTWARE

SBEventEnums

enum class SBSDK3::SBEventEnums

strong

Event Type.

Enumerator
INPUT_EVENT
DEVICE_EVENT
ERROR_EVENT

SBScanTypeEnums

enum class SBSDK3::SBScanTypeEnums

strong

Scan Type options: [POINT_CLOUD_RAW, POINT_CLOUD, MESH, MESH_DECIMATED, CAPTURE_ONLY].

Enumerator
POINT_CLOUD_RAW	Raw Point Cloud w/o any processing
POINT_CLOUD	Point Cloud
MESH	Mesh
MESH_DECIMATED	Mesh decimated by curvature weighed algorithm
CAPTURE_ONLY	Capture only without generating Mesh or Point Cloud. Only works on startScanStream

SBScanCleanupEnums

enum class SBSDK3::SBScanCleanupEnums

strong

Cleanup Settings.

Enumerator
NONE
LOW
STANDARD
HIGH

Function Documentation

ProcessScan()

SBSDK_API SBStatus SBSDK3::ProcessScan	(	SBMesh &	mesh_out,
		SBScan &	scan_in,
		SBProcessParams	processParams = SBProcessParams()
	)