SpatialMappingParameters Class Reference

Sets the spatial mapping parameters. More...

Functions

 SpatialMappingParameters (float resolutionMeter=0.05f, float rangeMeter=0.0f, bool saveTexture=false, SPATIAL_MAP_TYPE map_type=SPATIAL_MAP_TYPE.MESH, bool useChunkOnly=false, int maxMemoryUsage=2048, bool reverseVertexOrder=false)
 Constructor More...
 
void set (MAPPING_RESOLUTION mappingResolution=MAPPING_RESOLUTION.MEDIUM)
 Sets the resolution corresponding to the given MAPPING_RESOLUTION preset. More...
 
void set (MAPPING_RANGE mappingRange=MAPPING_RANGE.MEDIUM)
 Sets the maximum value of the depth corresponding to the given MAPPING_RANGE preset. More...
 

Static Functions

static float get (MAPPING_RESOLUTION mappingResolution=MAPPING_RESOLUTION.MEDIUM)
 Returns the resolution corresponding to the given MAPPING_RESOLUTION preset. More...
 
static float get (MAPPING_RANGE mappingRange=MAPPING_RANGE.MEDIUM)
 Returns the resolution corresponding to the given MAPPING_RANGE preset. More...
 

Attributes

float resolutionMeter
 Spatial mapping resolution in meters. More...
 
float rangeMeter
 Depth range in meters. More...
 
bool saveTexture = false
 Set to true if you want to be able to apply the texture to your mesh after its creation. More...
 
bool useChunkOnly = false
 Set to false if you want to ensure consistency between the mesh and its inner chunk data (default is false). More...
 
int maxMemoryUsage = 2048
 
bool reverseVertexOrder = false
 Specify if the order of the vertices of the triangles needs to be inverted. If your display process does not handle front and back face culling, you can use this to correct it. More...
 
SPATIAL_MAP_TYPE map_type
 The type of spatial map to be created. This dictates the format that will be used for the mapping(e.g. mesh, point cloud). See SPATIAL_MAP_TYPE More...
 

Detailed Description

Sets the spatial mapping parameters.

Constructor and Destructor

◆ SpatialMappingParameters()

SpatialMappingParameters ( float  resolutionMeter = 0.05f,
float  rangeMeter = 0.0f,
bool  saveTexture = false,
SPATIAL_MAP_TYPE  map_type = SPATIAL_MAP_TYPE.MESH,
bool  useChunkOnly = false,
int  maxMemoryUsage = 2048,
bool  reverseVertexOrder = false 
)
inline

Constructor

Functions

◆ get() [1/2]

static float get ( MAPPING_RESOLUTION  mappingResolution = MAPPING_RESOLUTION.MEDIUM)
inlinestatic

Returns the resolution corresponding to the given MAPPING_RESOLUTION preset.

Parameters
mappingResolutionThe desired MAPPING_RESOLUTION.
Returns
The resolution in meters.

◆ get() [2/2]

static float get ( MAPPING_RANGE  mappingRange = MAPPING_RANGE.MEDIUM)
inlinestatic

Returns the resolution corresponding to the given MAPPING_RANGE preset.

Parameters
mappingRangeThe desired MAPPING_RANGE. Default: MAPPING_RANGE::MEDIUM.
Returns
The range in meters.

◆ set() [1/2]

void set ( MAPPING_RESOLUTION  mappingResolution = MAPPING_RESOLUTION.MEDIUM)
inline

Sets the resolution corresponding to the given MAPPING_RESOLUTION preset.

Parameters
mappingResolutionThe desired MAPPING_RESOLUTION.

◆ set() [2/2]

void set ( MAPPING_RANGE  mappingRange = MAPPING_RANGE.MEDIUM)
inline

Sets the maximum value of the depth corresponding to the given MAPPING_RANGE preset.

Parameters
mappingRangeThe desired MAPPING_RANGE. Default: MAPPING_RANGE::MEDIUM.

Variables

◆ resolutionMeter

float resolutionMeter

◆ rangeMeter

float rangeMeter

◆ saveTexture

bool saveTexture = false

Set to true if you want to be able to apply the texture to your mesh after its creation.

Referenced by SpatialMappingParameters.SpatialMappingParameters().

◆ useChunkOnly

bool useChunkOnly = false

Set to false if you want to ensure consistency between the mesh and its inner chunk data (default is false).

Referenced by SpatialMappingParameters.SpatialMappingParameters().

◆ maxMemoryUsage

int maxMemoryUsage = 2048

◆ reverseVertexOrder

bool reverseVertexOrder = false

Specify if the order of the vertices of the triangles needs to be inverted. If your display process does not handle front and back face culling, you can use this to correct it.

Referenced by SpatialMappingParameters.SpatialMappingParameters().

◆ map_type

SPATIAL_MAP_TYPE map_type

The type of spatial map to be created. This dictates the format that will be used for the mapping(e.g. mesh, point cloud). See SPATIAL_MAP_TYPE

Referenced by SpatialMappingParameters.SpatialMappingParameters().