Artec 3D Scanning SDK: artec::sdk::base::io::Stl Class Reference

Artec 3D Scanning SDK 2.0

Class to save/load STL files (STereoLithography) More...

#include <artec/sdk/base/io/StlIO.h>

Static Public Member Functions
static ErrorCode	save (const wchar_t path, const IMesh surf, bool binary=true, IProgressInfo progr=0, ICancellationToken cncl=0)
	Save IMesh surface to STL file. More...

static ErrorCode	saveAscii (const wchar_t path, const IMesh surf, const char name=NULL, IProgressInfo progr=0, ICancellationToken *cncl=0)
	Save IMesh surface to ASCII STL file. More...

static ErrorCode	saveBinary (const wchar_t path, const IMesh surf, IProgressInfo progr=0, ICancellationToken cncl=0)
	Save IMesh surface to binary STL file. More...

static ErrorCode	save (IBlob *data, const IMesh surf, bool binary=true, IProgressInfo progr=0, ICancellationToken cncl=0)
	Save IMesh surface to STL blob. More...

static ErrorCode	saveAscii (IBlob *data, const IMesh surf, const char name=NULL, IProgressInfo progr=0, ICancellationToken *cncl=0)
	Save IMesh surface to ASCII STL blob. More...

static ErrorCode	saveBinary (IBlob *data, const IMesh surf, IProgressInfo progr=0, ICancellationToken cncl=0)
	Save IMesh surface to binary STL blob. More...

static bool	isBinary (const wchar_t *path)
	Determines format of the saved file. More...


static ErrorCode	load (IMesh *surf, const wchar_t path, bool binary, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	load (IMesh *surf, const wchar_t path, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	loadAscii (IMesh *surf, const wchar_t path, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	loadBinary (IMesh *surf, const wchar_t path, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	load (IMesh *surf, const IBlob data, bool binary, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	loadAscii (IMesh *surf, const IBlob data, IProgressInfo progr=0, ICancellationToken cncl=0)

static ErrorCode	loadBinary (IMesh *surf, const IBlob data, IProgressInfo progr=0, ICancellationToken cncl=0)

Detailed Description

Class to save/load STL files (STereoLithography)

Definition at line 123 of file StlIO.h.

Member Function Documentation

static bool artec::sdk::base::io::Stl::isBinary ( const wchar_t * path )

inlinestatic

Determines format of the saved file.

Definition at line 246 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::load	(	IMesh **	surf,
		const wchar_t *	path,
		bool	binary,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 209 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::load	(	IMesh **	surf,
		const wchar_t *	path,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 214 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::load	(	IMesh **	surf,
		const IBlob *	data,
		bool	binary,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 229 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::loadAscii	(	IMesh **	surf,
		const wchar_t *	path,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 219 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::loadAscii	(	IMesh **	surf,
		const IBlob *	data,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 234 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::loadBinary	(	IMesh **	surf,
		const wchar_t *	path,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 224 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::loadBinary	(	IMesh **	surf,
		const IBlob *	data,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Load IMesh surface from file/blob in STL format

Parameters

stream	- where the surface will be loaded from
path	- file path to load surface from
surf	- loaded surface
binary	- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.

Definition at line 239 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::save	(	const wchar_t *	path,
		const IMesh *	surf,
		bool	binary = `true`,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to STL file.

Parameters

path	- file path where to save mesh
surf	- surface to save (not empty)
binary	- text or binary STL format
progr	- progress interface
cncl	- cancellation interface

Definition at line 135 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::save	(	IBlob **	data,
		const IMesh *	surf,
		bool	binary = `true`,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to STL blob.

Parameters

data	- blob where to save mesh
surf	- surface to save (not empty)
binary	- text or binary STL format
progr	- progress interface
cncl	- cancellation interface

Definition at line 173 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::saveAscii	(	const wchar_t *	path,
		const IMesh *	surf,
		const char *	name = `NULL`,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to ASCII STL file.

Parameters

path	- file path where to save mesh
surf	- surface to save (not empty)
name	- mesh name
progr	- progress interface
cncl	- cancellation interface

Definition at line 148 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::saveAscii	(	IBlob **	data,
		const IMesh *	surf,
		const char *	name = `NULL`,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to ASCII STL blob.

Parameters

data	- blob where to save mesh
surf	- surface to save (not empty)
name	- mesh name
progr	- progress interface
cncl	- cancellation interface

Definition at line 186 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::saveBinary	(	const wchar_t *	path,
		const IMesh *	surf,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to binary STL file.

Parameters

path	- file path where to save mesh
surf	- surface to save (not empty)
progr	- progress interface
cncl	- cancellation interface

Definition at line 160 of file StlIO.h.

static ErrorCode artec::sdk::base::io::Stl::saveBinary	(	IBlob **	data,
		const IMesh *	surf,
		IProgressInfo *	progr = `0`,
		ICancellationToken *	cncl = `0`
	)

inlinestatic

Save IMesh surface to binary STL blob.

Parameters

data	- blob where to save mesh
surf	- surface to save (not empty)
progr	- progress interface
cncl	- cancel interface

Definition at line 197 of file StlIO.h.

The documentation for this class was generated from the following file:

artec/sdk/base/io/StlIO.h