Zivid::Experimental::PointCloudExport::FileFormat::PLY Class Reference

Specification for saving frame in PLY (*.ply) format. More...

#include <Zivid/Experimental/PointCloudExport.h>

Public Types
enum class	Layout { ordered , unordered }
	Layout for saving point cloud. More...

Public Member Functions
ZIVID_CORE_EXPORT	PLY (const std::string &fileName)
	Create PLY specification with file name.
ZIVID_CORE_EXPORT	PLY (const std::string &fileName, Layout layout, ColorSpace colorSpace)
	Create PLY specification with file name, layout and color space.
ZIVID_CORE_EXPORT const std::filesystem::path &	fileName () const
	Get the file name.
ZIVID_CORE_EXPORT Layout	layout () const
	Get the layout of PLY specification.
ZIVID_CORE_EXPORT ColorSpace	colorSpace () const
	Get the color space of PLY specification.
ZIVID_CORE_EXPORT std::string	toString () const
	Get string representation of PLY specification.

Static Public Attributes
static constexpr const char *	description { "PLY File" }
static constexpr const char *	defaultExtension { ".ply" }
static constexpr bool	canLoad { false }

Detailed Description

Specification for saving frame in PLY (*.ply) format.

PLY is a file format developed at Stanford. To learn more about the PLY file format, see https://paulbourke.net/dataformats/ply/.

Member Enumeration Documentation

Layout

enum class Zivid::Experimental::PointCloudExport::FileFormat::PLY::Layout

strong

Layout for saving point cloud.

Enumerator
ordered
unordered

Constructor & Destructor Documentation

PLY() [1/2]

ZIVID_CORE_EXPORT Zivid::Experimental::PointCloudExport::FileFormat::PLY::PLY ( const std::string & fileName )

explicit

Create PLY specification with file name.

Sets layout to ordered and color space to sRGB.

Parameters

fileName

File name

PLY() [2/2]

ZIVID_CORE_EXPORT Zivid::Experimental::PointCloudExport::FileFormat::PLY::PLY	(	const std::string &	fileName,
		Layout	layout,
		ColorSpace	colorSpace )

Create PLY specification with file name, layout and color space.

Parameters

fileName	File name
layout	Layout
colorSpace	Color space

Member Function Documentation

colorSpace()

ZIVID_CORE_EXPORT ColorSpace Zivid::Experimental::PointCloudExport::FileFormat::PLY::colorSpace

(

)

const

Get the color space of PLY specification.

fileName()

ZIVID_CORE_EXPORT const std::filesystem::path & Zivid::Experimental::PointCloudExport::FileFormat::PLY::fileName

(

)

const

Get the file name.

layout()

ZIVID_CORE_EXPORT Layout Zivid::Experimental::PointCloudExport::FileFormat::PLY::layout

(

)

const

Get the layout of PLY specification.

toString()

ZIVID_CORE_EXPORT std::string Zivid::Experimental::PointCloudExport::FileFormat::PLY::toString

(

)

const

Get string representation of PLY specification.

Member Data Documentation

canLoad

bool Zivid::Experimental::PointCloudExport::FileFormat::PLY::canLoad { false }

staticconstexpr

defaultExtension

const char* Zivid::Experimental::PointCloudExport::FileFormat::PLY::defaultExtension { ".ply" }

staticconstexpr

description

const char* Zivid::Experimental::PointCloudExport::FileFormat::PLY::description { "PLY File" }

staticconstexpr

---

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

• Zivid/Experimental/PointCloudExport.h