Spatial Mapping classes

Classes

class  MeshFilterParameters
 Defines the behavior of the sl::Mesh::filter function. More...
 
class  Texture
 Contains information about texture image associated to a Mesh. More...
 
class  Chunk
 Represents a sub-mesh, it contains local vertices and triangles. More...
 
class  Mesh
 A mesh contains the geometric (and optionally texture) data of the scene captured by spatial mapping. More...
 
class  SpatialMappingParameters
 Sets the spatial mapping parameters. More...
 

Enumerations

Functions

String toString (const MESH_FILE_FORMAT &mesh_frmt)
 Converts the given enumerated value into readable text. More...
 
String toString (const MESH_TEXTURE_FORMAT &text_frmt)
 Converts the given enumerated value into readable text. More...
 
String toString (const MeshFilterParameters::MESH_FILTER &mesh_filter)
 Converts the given enumerated value into readable text. More...
 
String toString (const SpatialMappingParameters::MAPPING_RESOLUTION &resolution)
 Converts the given enumerated value into readable text. More...
 
String toString (const SpatialMappingParameters::MAPPING_RANGE &range)
 Converts the given enumerated value into readable text. More...
 
String toString (const AREA_EXPORT_STATE &area_export)
 Converts the given enumerated value into readable text. More...
 
String toString (const SPATIAL_MAPPING_STATE &mapping_state)
 Converts the given enumerated value into readable text. More...
 
String spatialMappingState2str (SPATIAL_MAPPING_STATE state)
 Converts the given SPATIAL_MAPPING_STATE into a string. More...
 

Enumeration Type Documentation

enum MESH_FILE_FORMAT

Lists available mesh file formats.

Enumerator
MESH_FILE_PLY 

Contains only vertices and faces.

MESH_FILE_PLY_BIN 

Contains only vertices and faces, encoded in binary.

MESH_FILE_OBJ 

Contains vertices, normals, faces and textures informations if possible.

MESH_FILE_LAST 
enum MESH_TEXTURE_FORMAT

Lists available mesh texture formats.

Enumerator
MESH_TEXTURE_RGB 

The texture has 3 channels.

MESH_TEXTURE_RGBA 

The texture has 4 channels.

MESH_TEXTURE_LAST 
enum MAPPING_RESOLUTION

List the spatial mapping resolution presets.

Enumerator
MAPPING_RESOLUTION_HIGH 

Create a detail geometry, requires lots of memory.

MAPPING_RESOLUTION_MEDIUM 

Smalls variations in the geometry will disappear, useful for big object

MAPPING_RESOLUTION_LOW 

Keeps only huge variations of the geometry , useful outdoor.

enum MAPPING_RANGE

List the spatial mapping depth range presets.

Deprecated:
Since SDK 2.6 range is computed from the requested resolution and inner parameters to best fit the current application
Enumerator
MAPPING_RANGE_NEAR 

Only depth close to the camera will be used during spatial mapping.

MAPPING_RANGE_MEDIUM 

Medium depth range.

MAPPING_RANGE_FAR 

Takes into account objects that are far, useful outdoor.

MAPPING_RANGE_AUTO 

Depth range will be computed based on current Camera states and parameters.

enum AREA_EXPORT_STATE

Lists the different states of spatial memory area export.

Enumerator
AREA_EXPORT_STATE_SUCCESS 

The spatial memory file has been successfully created.

AREA_EXPORT_STATE_RUNNING 

The spatial memory is currently written.

AREA_EXPORT_STATE_NOT_STARTED 

The spatial memory file exportation has not been called.

AREA_EXPORT_STATE_FILE_EMPTY 

The spatial memory contains no data, the file is empty.

AREA_EXPORT_STATE_FILE_ERROR 

The spatial memory file has not been written because of a wrong file name.

AREA_EXPORT_STATE_SPATIAL_MEMORY_DISABLED 

The spatial memory learning is disable, no file can be created.

AREA_EXPORT_STATE_LAST 
enum SPATIAL_MAPPING_STATE

Gives the spatial mapping state.

Enumerator
SPATIAL_MAPPING_STATE_INITIALIZING 

The spatial mapping is initializing.

SPATIAL_MAPPING_STATE_OK 

The depth and tracking data were correctly integrated in the fusion algorithm.

SPATIAL_MAPPING_STATE_NOT_ENOUGH_MEMORY 

The maximum memory dedicated to the scanning has been reach, the mesh will no longer be updated.

SPATIAL_MAPPING_STATE_NOT_ENABLED 

Camera::enableSpatialMapping() wasn't called (or the scanning was stopped and not relaunched).

SPATIAL_MAPPING_STATE_FPS_TOO_LOW 

Effective FPS is too low to give proper results for spatial mapping. Consider using PERFORMANCES parameters (DEPTH_MODE_PERFORMANCE, low camera resolution (VGA,HD720), spatial mapping low resolution)

SPATIAL_MAPPING_STATE_LAST 

Function Documentation

String sl::toString ( const MESH_FILE_FORMAT mesh_frmt)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const MESH_TEXTURE_FORMAT text_frmt)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const MeshFilterParameters::MESH_FILTER mesh_filter)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const SpatialMappingParameters::MAPPING_RESOLUTION resolution)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const SpatialMappingParameters::MAPPING_RANGE range)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const AREA_EXPORT_STATE area_export)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const SPATIAL_MAPPING_STATE mapping_state)

Converts the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::spatialMappingState2str ( SPATIAL_MAPPING_STATE  state)

Converts the given SPATIAL_MAPPING_STATE into a string.

Parameters
state: a specific SPATIAL_MAPPING_STATE
Returns
The corresponding string
Deprecated:
See toString.