Namespaces
	k4a_plugin

	rpc

Data Structures
struct	TextureImages

struct	ArrayAdapter

struct	IntArrayBase

struct	IntArray

struct	ReadTriangleModelOptions

struct	ReadPointCloudOption
	Optional parameters to ReadPointCloud. More...

struct	WritePointCloudOption
	Optional parameters to WritePointCloud. More...

class	AzureKinectRecorder

class	AzureKinectSensor

class	AzureKinectSensorConfig

class	MKVMetadata

class	MKVReader

class	MKVWriter

class	RGBDRecorder

class	RGBDSensor

class	RGBDSensorConfig

struct	ReadTriangleMeshOptions

Enumerations
enum	FileGeometry { CONTENTS_UNKNOWN = 0 , CONTAINS_POINTS = (1 << 0) , CONTAINS_LINES = (1 << 1) , CONTAINS_TRIANGLES = (1 << 2) }

Functions
bool	ReadFeature (const std::string &filename, pipelines::registration::Feature &feature)

bool	WriteFeature (const std::string &filename, const pipelines::registration::Feature &feature)

bool	ReadFeatureFromBIN (const std::string &filename, pipelines::registration::Feature &feature)

bool	WriteFeatureToBIN (const std::string &filename, const pipelines::registration::Feature &feature)

FileGeometry	ReadFileGeometryTypeFBX (const std::string &path)

void	LoadTextures (const std::string &filename, const aiScene scene, const aiMaterial mat, TextureImages &maps)

bool	ReadTriangleMeshUsingASSIMP (const std::string &filename, geometry::TriangleMesh &mesh, const ReadTriangleMeshOptions &params)

bool	ReadModelUsingAssimp (const std::string &filename, visualization::rendering::TriangleMeshModel &model, const ReadTriangleModelOptions &params)

FileGeometry	ReadFileGeometryTypeGLTF (const std::string &path)

bool	ReadTriangleMeshFromGLTF (const std::string &filename, geometry::TriangleMesh &mesh, const ReadTriangleMeshOptions &params)

bool	WriteTriangleMeshToGLTF (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

bool	ReadImageFromJPG (const std::string &filename, geometry::Image &image)

bool	WriteImageToJPG (const std::string &filename, const geometry::Image &image, int quality)

bool	ReadJPGFromMemory (const unsigned char *image_data_ptr, size_t image_data_size, geometry::Image &image)

bool	ReadIJsonConvertibleFromJSON (const std::string &filename, utility::IJsonConvertible &object)

bool	WriteIJsonConvertibleToJSON (const std::string &filename, const utility::IJsonConvertible &object)

bool	ReadIJsonConvertibleFromJSONString (const std::string &json_string, utility::IJsonConvertible &object)

bool	WriteIJsonConvertibleToJSONString (std::string &json_string, const utility::IJsonConvertible &object)

bool	ReadPinholeCameraTrajectoryFromLOG (const std::string &filename, camera::PinholeCameraTrajectory &trajectory)

bool	WritePinholeCameraTrajectoryToLOG (const std::string &filename, const camera::PinholeCameraTrajectory &trajectory)

FileGeometry	ReadFileGeometryTypeOBJ (const std::string &path)

bool	ReadTriangleMeshFromOBJ (const std::string &filename, geometry::TriangleMesh &mesh, const ReadTriangleMeshOptions &)

bool	WriteTriangleMeshToOBJ (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

FileGeometry	ReadFileGeometryTypeOFF (const std::string &path)

bool	ReadTriangleMeshFromOFF (const std::string &filename, geometry::TriangleMesh &mesh, const ReadTriangleMeshOptions &params)

bool	WriteTriangleMeshToOFF (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

FileGeometry	ReadFileGeometryTypePCD (const std::string &path)

bool	ReadPointCloudFromPCD (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToPCD (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

FileGeometry	ReadFileGeometryTypePLY (const std::string &path)

bool	ReadPointCloudFromPLY (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToPLY (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

bool	ReadTriangleMeshFromPLY (const std::string &filename, geometry::TriangleMesh &mesh, const ReadTriangleMeshOptions &params)

bool	WriteTriangleMeshToPLY (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

bool	ReadLineSetFromPLY (const std::string &filename, geometry::LineSet &lineset, bool print_progress)

bool	WriteLineSetToPLY (const std::string &filename, const geometry::LineSet &lineset, bool write_ascii, bool compressed, bool print_progress)

bool	ReadVoxelGridFromPLY (const std::string &filename, geometry::VoxelGrid &voxelgrid, bool print_progress)

bool	WriteVoxelGridToPLY (const std::string &filename, const geometry::VoxelGrid &voxelgrid, bool write_ascii, bool compressed, bool print_progress)

bool	ReadImageFromPNG (const std::string &filename, geometry::Image &image)

bool	WriteImageToPNG (const std::string &filename, const geometry::Image &image, int quality)

bool	ReadPNGFromMemory (const unsigned char *image_data_ptr, size_t image_data_size, geometry::Image &image)
	The general entrance for reading an Image from memory. More...

FileGeometry	ReadFileGeometryTypePTS (const std::string &path)

bool	ReadPointCloudFromPTS (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToPTS (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

FileGeometry	ReadFileGeometryTypeSTL (const std::string &path)

bool	WriteTriangleMeshToSTL (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

bool	ReadPinholeCameraTrajectoryFromTUM (const std::string &filename, camera::PinholeCameraTrajectory &trajectory)

bool	WritePinholeCameraTrajectoryToTUM (const std::string &filename, const camera::PinholeCameraTrajectory &trajectory)

FileGeometry	ReadFileGeometryTypeXYZ (const std::string &path)

bool	ReadPointCloudFromXYZ (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToXYZ (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

FileGeometry	ReadFileGeometryTypeXYZN (const std::string &path)

bool	ReadPointCloudFromXYZN (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToXYZN (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

FileGeometry	ReadFileGeometryTypeXYZRGB (const std::string &path)

bool	ReadPointCloudFromXYZRGB (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	WritePointCloudToXYZRGB (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

FileGeometry	ReadFileGeometryType (const std::string &path)

bool	ReadIJsonConvertible (const std::string &filename, utility::IJsonConvertible &object)

bool	WriteIJsonConvertible (const std::string &filename, const utility::IJsonConvertible &object)

std::shared_ptr< geometry::Image >	CreateImageFromFile (const std::string &filename)

bool	ReadImage (const std::string &filename, geometry::Image &image)

bool	WriteImage (const std::string &filename, const geometry::Image &image, int quality)

std::shared_ptr< geometry::Image >	CreateImageFromMemory (const std::string &image_format, const unsigned char *image_data_ptr, size_t image_data_size)
	Factory function to create an image from memory. More...

bool	ReadImageFromMemory (const std::string &image_format, const unsigned char *image_data_ptr, size_t image_data_size, geometry::Image &image)

std::shared_ptr< pipelines::color_map::ImageWarpingField >	CreateImageWarpingFieldFromFile (const std::string &filename)

bool	ReadImageWarpingField (const std::string &filename, pipelines::color_map::ImageWarpingField &warping_field)

bool	WriteImageWarpingField (const std::string &filename, const pipelines::color_map::ImageWarpingField &trajectory)

std::shared_ptr< geometry::LineSet >	CreateLineSetFromFile (const std::string &filename, const std::string &format, bool print_progress)

bool	ReadLineSet (const std::string &filename, geometry::LineSet &lineset, const std::string &format, bool print_progress)

bool	WriteLineSet (const std::string &filename, const geometry::LineSet &lineset, bool write_ascii, bool compressed, bool print_progress)

bool	ReadTriangleModel (const std::string &filename, visualization::rendering::TriangleMeshModel &model, ReadTriangleModelOptions params)

std::shared_ptr< geometry::Octree >	CreateOctreeFromFile (const std::string &filename, const std::string &format)

bool	ReadOctree (const std::string &filename, geometry::Octree &octree, const std::string &format)

bool	WriteOctree (const std::string &filename, const geometry::Octree &octree)

bool	ReadOctreeFromJson (const std::string &filename, geometry::Octree &octree)

bool	WriteOctreeToJson (const std::string &filename, const geometry::Octree &octree)

std::shared_ptr< camera::PinholeCameraTrajectory >	CreatePinholeCameraTrajectoryFromFile (const std::string &filename)

bool	ReadPinholeCameraTrajectory (const std::string &filename, camera::PinholeCameraTrajectory &trajectory)

bool	WritePinholeCameraTrajectory (const std::string &filename, const camera::PinholeCameraTrajectory &trajectory)

std::shared_ptr< geometry::PointCloud >	CreatePointCloudFromFile (const std::string &filename, const std::string &format, bool print_progress)

bool	ReadPointCloud (const std::string &filename, geometry::PointCloud &pointcloud, const ReadPointCloudOption &params)

bool	ReadPointCloud (const std::string &filename, geometry::PointCloud &pointcloud, const std::string &file_format, bool remove_nan_points, bool remove_infinite_points, bool print_progress)

bool	WritePointCloud (const std::string &filename, const geometry::PointCloud &pointcloud, const WritePointCloudOption &params)

bool	WritePointCloud (const std::string &filename, const geometry::PointCloud &pointcloud, bool write_ascii, bool compressed, bool print_progress)

std::shared_ptr< pipelines::registration::PoseGraph >	CreatePoseGraphFromFile (const std::string &filename)

bool	ReadPoseGraph (const std::string &filename, pipelines::registration::PoseGraph &pose_graph)

bool	WritePoseGraph (const std::string &filename, const pipelines::registration::PoseGraph &pose_graph)

void	ConvertBGRAToRGB (geometry::Image &bgra, geometry::Image &rgb)

std::shared_ptr< geometry::TriangleMesh >	CreateMeshFromFile (const std::string &filename, bool print_progress)

bool	ReadTriangleMesh (const std::string &filename, geometry::TriangleMesh &mesh, ReadTriangleMeshOptions params)

bool	WriteTriangleMesh (const std::string &filename, const geometry::TriangleMesh &mesh, bool write_ascii, bool compressed, bool write_vertex_normals, bool write_vertex_colors, bool write_triangle_uvs, bool print_progress)

bool	IsPointInsidePolygon (const Eigen::MatrixX2d &polygon, double x, double y)

bool	AddTrianglesByEarClipping (geometry::TriangleMesh &mesh, std::vector< unsigned int > &indices)

std::shared_ptr< geometry::VoxelGrid >	CreateVoxelGridFromFile (const std::string &filename, const std::string &format, bool print_progress)

bool	ReadVoxelGrid (const std::string &filename, geometry::VoxelGrid &voxelgrid, const std::string &format, bool print_progress)

bool	WriteVoxelGrid (const std::string &filename, const geometry::VoxelGrid &voxelgrid, bool write_ascii, bool compressed, bool print_progress)

Variables
const unsigned int	kPostProcessFlags_compulsory

const unsigned int	kPostProcessFlags_fast

constexpr int	kOpen3DImageIODefaultQuality = -1

Enumeration Type Documentation

◆ FileGeometry

enum open3d::io::FileGeometry

Enumerator
CONTENTS_UNKNOWN
CONTAINS_POINTS
CONTAINS_LINES
CONTAINS_TRIANGLES

Function Documentation

◆ AddTrianglesByEarClipping()

bool open3d::io::AddTrianglesByEarClipping	(	geometry::TriangleMesh &	mesh,
		std::vector< unsigned int > &	indices
	)

Function to convert a polygon into a collection of triangles whose vertices are only those of the polygon. Assume that the vertices are connected by edges based on their order, and the final vertex connected to the first. The triangles are added to the mesh that is passed as reference. The mesh should contain all vertices prior to calling this function.

Returns: return true if triangulation is successful, false otherwise.

◆ ConvertBGRAToRGB()

void open3d::io::ConvertBGRAToRGB	(	geometry::Image &	bgra,
		geometry::Image &	rgb
	)

◆ CreateImageFromFile()

std::shared_ptr< geometry::Image > open3d::io::CreateImageFromFile ( const std::string & filename )

Factory function to create an image from a file (ImageFactory.cpp) Return an empty image if fail to read the file.

◆ CreateImageFromMemory()

std::shared_ptr< geometry::Image > open3d::io::CreateImageFromMemory	(	const std::string &	image_format,
		const unsigned char *	image_data_ptr,
		size_t	image_data_size
	)

Factory function to create an image from memory.

◆ CreateImageWarpingFieldFromFile()

std::shared_ptr< pipelines::color_map::ImageWarpingField > open3d::io::CreateImageWarpingFieldFromFile ( const std::string & filename )

Factory function to create a ImageWarpingField from a file Return an empty PinholeCameraTrajectory if fail to read the file.

◆ CreateLineSetFromFile()

std::shared_ptr< geometry::LineSet > open3d::io::CreateLineSetFromFile	(	const std::string &	filename,
		const std::string &	format = `"auto"`,
		bool	print_progress = `false`
	)

Factory function to create a lineset from a file.

Returns: return an empty lineset if fail to read the file.

◆ CreateMeshFromFile()

std::shared_ptr< geometry::TriangleMesh > open3d::io::CreateMeshFromFile	(	const std::string &	filename,
		bool	print_progress = `false`
	)

Factory function to create a mesh from a file (TriangleMeshFactory.cpp) Return an empty mesh if fail to read the file.

◆ CreateOctreeFromFile()

std::shared_ptr< geometry::Octree > open3d::io::CreateOctreeFromFile	(	const std::string &	filename,
		const std::string &	format = `"auto"`
	)

Factory function to create a octree from a file.

Returns: return an empty octree if fail to read the file.

◆ CreatePinholeCameraTrajectoryFromFile()

std::shared_ptr< camera::PinholeCameraTrajectory > open3d::io::CreatePinholeCameraTrajectoryFromFile ( const std::string & filename )

Factory function to create a PinholeCameraTrajectory from a file (PinholeCameraTrajectoryFactory.cpp) Return an empty PinholeCameraTrajectory if fail to read the file.

◆ CreatePointCloudFromFile()

std::shared_ptr< geometry::PointCloud > open3d::io::CreatePointCloudFromFile	(	const std::string &	filename,
		const std::string &	format = `"auto"`,
		bool	print_progress = `false`
	)

Factory function to create a pointcloud from a file Return an empty pointcloud if fail to read the file.

◆ CreatePoseGraphFromFile()

std::shared_ptr< pipelines::registration::PoseGraph > open3d::io::CreatePoseGraphFromFile ( const std::string & filename )

Factory function to create a PoseGraph from a file (PinholeCameraTrajectoryFactory.cpp) Return an empty PinholeCameraTrajectory if fail to read the file.

◆ CreateVoxelGridFromFile()

std::shared_ptr< geometry::VoxelGrid > open3d::io::CreateVoxelGridFromFile	(	const std::string &	filename,
		const std::string &	format = `"auto"`,
		bool	print_progress = `false`
	)

Factory function to create a voxelgrid from a file.

Returns: return an empty voxelgrid if fail to read the file.

◆ IsPointInsidePolygon()

bool open3d::io::IsPointInsidePolygon	(	const Eigen::MatrixX2d &	polygon,
		double	x,
		double	y
	)

◆ LoadTextures()

void open3d::io::LoadTextures	(	const std::string &	filename,
		const aiScene *	scene,
		const aiMaterial *	mat,
		TextureImages &	maps
	)

◆ ReadFeature()

bool open3d::io::ReadFeature	(	const std::string &	filename,
		pipelines::registration::Feature &	feature
	)

The general entrance for reading a Feature from a file

Returns: If the read function is successful.

◆ ReadFeatureFromBIN()

bool open3d::io::ReadFeatureFromBIN	(	const std::string &	filename,
		pipelines::registration::Feature &	feature
	)

◆ ReadFileGeometryType()

FileGeometry open3d::io::ReadFileGeometryType ( const std::string & path )

Returns the kind of geometry that the file contains. This is a quick function designed to query the file in order to determine whether to call ReadTriangleMesh(), ReadLineSet(), or ReadPointCloud()

◆ ReadFileGeometryTypeFBX()

FileGeometry open3d::io::ReadFileGeometryTypeFBX ( const std::string & path )

◆ ReadFileGeometryTypeGLTF()

FileGeometry open3d::io::ReadFileGeometryTypeGLTF ( const std::string & path )

◆ ReadFileGeometryTypeOBJ()

FileGeometry open3d::io::ReadFileGeometryTypeOBJ ( const std::string & path )

◆ ReadFileGeometryTypeOFF()

FileGeometry open3d::io::ReadFileGeometryTypeOFF ( const std::string & path )

◆ ReadFileGeometryTypePCD()

FileGeometry open3d::io::ReadFileGeometryTypePCD ( const std::string & path )

◆ ReadFileGeometryTypePLY()

FileGeometry open3d::io::ReadFileGeometryTypePLY ( const std::string & path )

◆ ReadFileGeometryTypePTS()

FileGeometry open3d::io::ReadFileGeometryTypePTS ( const std::string & path )

◆ ReadFileGeometryTypeSTL()

FileGeometry open3d::io::ReadFileGeometryTypeSTL ( const std::string & path )

◆ ReadFileGeometryTypeXYZ()

FileGeometry open3d::io::ReadFileGeometryTypeXYZ ( const std::string & path )

◆ ReadFileGeometryTypeXYZN()

FileGeometry open3d::io::ReadFileGeometryTypeXYZN ( const std::string & path )

◆ ReadFileGeometryTypeXYZRGB()

FileGeometry open3d::io::ReadFileGeometryTypeXYZRGB ( const std::string & path )

◆ ReadIJsonConvertible()

bool open3d::io::ReadIJsonConvertible	(	const std::string &	filename,
		utility::IJsonConvertible &	object
	)

The general entrance for reading an IJsonConvertible from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadIJsonConvertibleFromJSON()

bool open3d::io::ReadIJsonConvertibleFromJSON	(	const std::string &	filename,
		utility::IJsonConvertible &	object
	)

◆ ReadIJsonConvertibleFromJSONString()

bool open3d::io::ReadIJsonConvertibleFromJSONString	(	const std::string &	json_string,
		utility::IJsonConvertible &	object
	)

◆ ReadImage()

bool open3d::io::ReadImage	(	const std::string &	filename,
		geometry::Image &	image
	)

The general entrance for reading an Image from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadImageFromJPG()

bool open3d::io::ReadImageFromJPG	(	const std::string &	filename,
		geometry::Image &	image
	)

◆ ReadImageFromMemory()

bool open3d::io::ReadImageFromMemory	(	const std::string &	image_format,
		const unsigned char *	image_data_ptr,
		size_t	image_data_size,
		geometry::Image &	image
	)

The general entrance for reading an Image from memory The function calls read functions based on format of image.

Parameters

image_format	the format of image, "png" or "jpg".
image_data_ptr	the pointer to image data in memory.
image_data_size	the size of image data in memory.

Returns: return true if the read function is successful, false otherwise.

◆ ReadImageFromPNG()

bool open3d::io::ReadImageFromPNG	(	const std::string &	filename,
		geometry::Image &	image
	)

◆ ReadImageWarpingField()

bool open3d::io::ReadImageWarpingField	(	const std::string &	filename,
		pipelines::color_map::ImageWarpingField &	warping_field
	)

The general entrance for reading a ImageWarpingField from a file

Returns: If the read function is successful.

◆ ReadJPGFromMemory()

bool open3d::io::ReadJPGFromMemory	(	const unsigned char *	image_data_ptr,
		size_t	image_data_size,
		geometry::Image &	image
	)

◆ ReadLineSet()

bool open3d::io::ReadLineSet	(	const std::string &	filename,
		geometry::LineSet &	lineset,
		const std::string &	format = `"auto"`,
		bool	print_progress = `false`
	)

The general entrance for reading a LineSet from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadLineSetFromPLY()

bool open3d::io::ReadLineSetFromPLY	(	const std::string &	filename,
		geometry::LineSet &	lineset,
		bool	print_progress
	)

◆ ReadModelUsingAssimp()

bool open3d::io::ReadModelUsingAssimp	(	const std::string &	filename,
		visualization::rendering::TriangleMeshModel &	model,
		const ReadTriangleModelOptions &	params
	)

◆ ReadOctree()

bool open3d::io::ReadOctree	(	const std::string &	filename,
		geometry::Octree &	octree,
		const std::string &	format = `"auto"`
	)

The general entrance for reading a Octree from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadOctreeFromJson()

bool open3d::io::ReadOctreeFromJson	(	const std::string &	filename,
		geometry::Octree &	octree
	)

◆ ReadPinholeCameraTrajectory()

bool open3d::io::ReadPinholeCameraTrajectory	(	const std::string &	filename,
		camera::PinholeCameraTrajectory &	trajectory
	)

The general entrance for reading a PinholeCameraTrajectory from a file The function calls read functions based on the extension name of filename.

Returns: If the read function is successful.

◆ ReadPinholeCameraTrajectoryFromLOG()

bool open3d::io::ReadPinholeCameraTrajectoryFromLOG	(	const std::string &	filename,
		camera::PinholeCameraTrajectory &	trajectory
	)

◆ ReadPinholeCameraTrajectoryFromTUM()

bool open3d::io::ReadPinholeCameraTrajectoryFromTUM	(	const std::string &	filename,
		camera::PinholeCameraTrajectory &	trajectory
	)

◆ ReadPNGFromMemory()

bool open3d::io::ReadPNGFromMemory	(	const unsigned char *	image_data_ptr,
		size_t	image_data_size,
		geometry::Image &	image
	)

The general entrance for reading an Image from memory.

◆ ReadPointCloud() [1/2]

bool open3d::io::ReadPointCloud	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params = `{}`
	)

The general entrance for reading a PointCloud from a file The function calls read functions based on the extension name of filename. See ReadPointCloudOption for additional options you can pass.

Returns: return true if the read function is successful, false otherwise.

◆ ReadPointCloud() [2/2]

bool open3d::io::ReadPointCloud	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const std::string &	file_format,
		bool	remove_nan_points,
		bool	remove_infinite_points,
		bool	print_progress
	)

◆ ReadPointCloudFromPCD()

bool open3d::io::ReadPointCloudFromPCD	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPointCloudFromPLY()

bool open3d::io::ReadPointCloudFromPLY	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPointCloudFromPTS()

bool open3d::io::ReadPointCloudFromPTS	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPointCloudFromXYZ()

bool open3d::io::ReadPointCloudFromXYZ	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPointCloudFromXYZN()

bool open3d::io::ReadPointCloudFromXYZN	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPointCloudFromXYZRGB()

bool open3d::io::ReadPointCloudFromXYZRGB	(	const std::string &	filename,
		geometry::PointCloud &	pointcloud,
		const ReadPointCloudOption &	params
	)

◆ ReadPoseGraph()

bool open3d::io::ReadPoseGraph	(	const std::string &	filename,
		pipelines::registration::PoseGraph &	pose_graph
	)

The general entrance for reading a PoseGraph from a file. The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadTriangleMesh()

bool open3d::io::ReadTriangleMesh	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		ReadTriangleMeshOptions	params = `{}`
	)

The general entrance for reading a TriangleMesh from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadTriangleMeshFromGLTF()

bool open3d::io::ReadTriangleMeshFromGLTF	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		const ReadTriangleMeshOptions &	params
	)

◆ ReadTriangleMeshFromOBJ()

bool open3d::io::ReadTriangleMeshFromOBJ	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		const ReadTriangleMeshOptions &
	)

◆ ReadTriangleMeshFromOFF()

bool open3d::io::ReadTriangleMeshFromOFF	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		const ReadTriangleMeshOptions &	params
	)

◆ ReadTriangleMeshFromPLY()

bool open3d::io::ReadTriangleMeshFromPLY	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		const ReadTriangleMeshOptions &	params
	)

◆ ReadTriangleMeshUsingASSIMP()

bool open3d::io::ReadTriangleMeshUsingASSIMP	(	const std::string &	filename,
		geometry::TriangleMesh &	mesh,
		const ReadTriangleMeshOptions &	params
	)

◆ ReadTriangleModel()

bool open3d::io::ReadTriangleModel	(	const std::string &	filename,
		visualization::rendering::TriangleMeshModel &	model,
		ReadTriangleModelOptions	params
	)

◆ ReadVoxelGrid()

bool open3d::io::ReadVoxelGrid	(	const std::string &	filename,
		geometry::VoxelGrid &	voxelgrid,
		const std::string &	format = `"auto"`,
		bool	print_progress = `false`
	)

The general entrance for reading a VoxelGrid from a file The function calls read functions based on the extension name of filename.

Returns: return true if the read function is successful, false otherwise.

◆ ReadVoxelGridFromPLY()

bool open3d::io::ReadVoxelGridFromPLY	(	const std::string &	filename,
		geometry::VoxelGrid &	voxelgrid,
		bool	print_progress
	)

◆ WriteFeature()

bool open3d::io::WriteFeature	(	const std::string &	filename,
		const pipelines::registration::Feature &	feature
	)

The general entrance for writing a Feature to a file

Returns: If the write function is successful.

◆ WriteFeatureToBIN()

bool open3d::io::WriteFeatureToBIN	(	const std::string &	filename,
		const pipelines::registration::Feature &	feature
	)

◆ WriteIJsonConvertible()

bool open3d::io::WriteIJsonConvertible	(	const std::string &	filename,
		const utility::IJsonConvertible &	object
	)

The general entrance for writing an IJsonConvertible to a file The function calls write functions based on the extension name of filename.

Returns: return true if the write function is successful, false otherwise.

◆ WriteIJsonConvertibleToJSON()

bool open3d::io::WriteIJsonConvertibleToJSON	(	const std::string &	filename,
		const utility::IJsonConvertible &	object
	)

◆ WriteIJsonConvertibleToJSONString()

bool open3d::io::WriteIJsonConvertibleToJSONString	(	std::string &	json_string,
		const utility::IJsonConvertible &	object
	)

◆ WriteImage()

bool open3d::io::WriteImage	(	const std::string &	filename,
		const geometry::Image &	image,
		int	quality = `kOpen3DImageIODefaultQuality`
	)

The general entrance for writing an Image to a file The function calls write functions based on the extension name of filename. If the write function supports quality, the parameter will be used. Otherwise it will be ignored.

Parameters

quality PNG: [0-9] <=2 fast write for storing intermediate data >=3 (default) normal write for balanced speed and file size JPEG: [0-100] Typically in [70,95]. 90 is default (good quality).

Returns: return true if the write function is successful, false otherwise.

◆ WriteImageToJPG()

bool open3d::io::WriteImageToJPG	(	const std::string &	filename,
		const geometry::Image &	image,
		int	quality
	)

◆ WriteImageToPNG()

bool open3d::io::WriteImageToPNG	(	const std::string &	filename,
		const geometry::Image &	image,
		int	quality
	)

◆ WriteImageWarpingField()

bool open3d::io::WriteImageWarpingField	(	const std::string &	filename,
		const pipelines::color_map::ImageWarpingField &	warping_field
	)

The general entrance for writing a ImageWarpingField to a file

Returns: If the write function is successful.

◆ WriteLineSet()

bool open3d::io::WriteLineSet	(	const std::string &	filename,
		const geometry::LineSet &	lineset,
		bool	write_ascii = `false`,
		bool	compressed = `false`,
		bool	print_progress = `false`
	)

The general entrance for writing a LineSet to a file The function calls write functions based on the extension name of filename. If the write function supports binary encoding and compression, the later two parameters will be used. Otherwise they will be ignored.

Returns: return true if the write function is successful, false otherwise.

◆ WriteLineSetToPLY()

bool open3d::io::WriteLineSetToPLY	(	const std::string &	filename,
		const geometry::LineSet &	lineset,
		bool	write_ascii,
		bool	compressed,
		bool	print_progress
	)

◆ WriteOctree()

bool open3d::io::WriteOctree	(	const std::string &	filename,
		const geometry::Octree &	octree
	)

The general entrance for writing a Octree to a file The function calls write functions based on the extension name of filename. If the write function supports binary encoding and compression, the later two parameters will be used. Otherwise they will be ignored.

Returns: return true if the write function is successful, false otherwise.

◆ WriteOctreeToJson()

bool open3d::io::WriteOctreeToJson	(	const std::string &	filename,
		const geometry::Octree &	octree
	)

◆ WritePinholeCameraTrajectory()

bool open3d::io::WritePinholeCameraTrajectory	(	const std::string &	filename,
		const camera::PinholeCameraTrajectory &	trajectory
	)

The general entrance for writing a PinholeCameraTrajectory to a file The function calls write functions based on the extension name of filename.

Returns: If the write function is successful.

◆ WritePinholeCameraTrajectoryToLOG()

bool open3d::io::WritePinholeCameraTrajectoryToLOG	(	const std::string &	filename,
		const camera::PinholeCameraTrajectory &	trajectory
	)

◆ WritePinholeCameraTrajectoryToTUM()

bool open3d::io::WritePinholeCameraTrajectoryToTUM	(	const std::string &	filename,
		const camera::PinholeCameraTrajectory &	trajectory
	)

◆ WritePointCloud() [1/2]

bool open3d::io::WritePointCloud	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		bool	write_ascii,
		bool	compressed,
		bool	print_progress
	)

◆ WritePointCloud() [2/2]

bool open3d::io::WritePointCloud	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params = `{}`
	)

The general entrance for writing a PointCloud to a file The function calls write functions based on the extension name of filename. See WritePointCloudOption for additional options you can pass.

Returns: return true if the write function is successful, false otherwise.

◆ WritePointCloudToPCD()

bool open3d::io::WritePointCloudToPCD	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePointCloudToPLY()

bool open3d::io::WritePointCloudToPLY	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePointCloudToPTS()

bool open3d::io::WritePointCloudToPTS	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePointCloudToXYZ()

bool open3d::io::WritePointCloudToXYZ	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePointCloudToXYZN()

bool open3d::io::WritePointCloudToXYZN	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePointCloudToXYZRGB()

bool open3d::io::WritePointCloudToXYZRGB	(	const std::string &	filename,
		const geometry::PointCloud &	pointcloud,
		const WritePointCloudOption &	params
	)

◆ WritePoseGraph()

bool open3d::io::WritePoseGraph	(	const std::string &	filename,
		const pipelines::registration::PoseGraph &	pose_graph
	)

The general entrance for writing a PoseGraph to a file. The function calls write functions based on the extension name of filename.

Returns: return true if the write function is successful, false otherwise.

◆ WriteTriangleMesh()

bool open3d::io::WriteTriangleMesh	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii = `false`,
		bool	compressed = `false`,
		bool	write_vertex_normals = `true`,
		bool	write_vertex_colors = `true`,
		bool	write_triangle_uvs = `true`,
		bool	print_progress = `false`
	)

The general entrance for writing a TriangleMesh to a file The function calls write functions based on the extension name of filename. If the write function supports binary encoding and compression, the later two parameters will be used. Otherwise they will be ignored. At current only .obj format supports uv coordinates (triangle_uvs) and textures.

Returns: return true if the write function is successful, false otherwise.

◆ WriteTriangleMeshToGLTF()

bool open3d::io::WriteTriangleMeshToGLTF	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii,
		bool	compressed,
		bool	write_vertex_normals,
		bool	write_vertex_colors,
		bool	write_triangle_uvs,
		bool	print_progress
	)

◆ WriteTriangleMeshToOBJ()

bool open3d::io::WriteTriangleMeshToOBJ	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii,
		bool	compressed,
		bool	write_vertex_normals,
		bool	write_vertex_colors,
		bool	write_triangle_uvs,
		bool	print_progress
	)

◆ WriteTriangleMeshToOFF()

bool open3d::io::WriteTriangleMeshToOFF	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii,
		bool	compressed,
		bool	write_vertex_normals,
		bool	write_vertex_colors,
		bool	write_triangle_uvs,
		bool	print_progress
	)

◆ WriteTriangleMeshToPLY()

bool open3d::io::WriteTriangleMeshToPLY	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii,
		bool	compressed,
		bool	write_vertex_normals,
		bool	write_vertex_colors,
		bool	write_triangle_uvs,
		bool	print_progress
	)

◆ WriteTriangleMeshToSTL()

bool open3d::io::WriteTriangleMeshToSTL	(	const std::string &	filename,
		const geometry::TriangleMesh &	mesh,
		bool	write_ascii,
		bool	compressed,
		bool	write_vertex_normals,
		bool	write_vertex_colors,
		bool	write_triangle_uvs,
		bool	print_progress
	)

◆ WriteVoxelGrid()

bool open3d::io::WriteVoxelGrid	(	const std::string &	filename,
		const geometry::VoxelGrid &	voxelgrid,
		bool	write_ascii = `false`,
		bool	compressed = `false`,
		bool	print_progress = `false`
	)

The general entrance for writing a VoxelGrid to a file The function calls write functions based on the extension name of filename. If the write function supports binary encoding and compression, the later two parameters will be used. Otherwise they will be ignored.

Returns: return true if the write function is successful, false otherwise.

◆ WriteVoxelGridToPLY()

bool open3d::io::WriteVoxelGridToPLY	(	const std::string &	filename,
		const geometry::VoxelGrid &	voxelgrid,
		bool	write_ascii,
		bool	compressed,
		bool	print_progress
	)

Variable Documentation

◆ kOpen3DImageIODefaultQuality

constexpr int open3d::io::kOpen3DImageIODefaultQuality = -1

constexpr

◆ kPostProcessFlags_compulsory

const unsigned int open3d::io::kPostProcessFlags_compulsory

Initial value:

=

aiProcess_JoinIdenticalVertices

◆ kPostProcessFlags_fast

const unsigned int open3d::io::kPostProcessFlags_fast