point_cloud_library / 1.12.1 / classpcl_1_1_o_b_j_reader.html /

#include <pcl/io/obj_io.h>

Public Member Functions

OBJReader ()
empty constructor More...
~OBJReader ()
empty destructor More...
int readHeader (const std::string &file_name, pcl::PCLPointCloud2 &cloud, Eigen::Vector4f &origin, Eigen::Quaternionf &orientation, int &file_version, int &data_type, unsigned int &data_idx, const int offset) override
Read a point cloud data header from a FILE file. More...
int read (const std::string &file_name, pcl::PCLPointCloud2 &cloud, Eigen::Vector4f &origin, Eigen::Quaternionf &orientation, int &file_version, const int offset=0) override
Read a point cloud data from a FILE file and store it into a pcl/PCLPointCloud2. More...
int read (const std::string &file_name, pcl::PCLPointCloud2 &cloud, const int offset=0)
Read a point cloud data from a FILE file and store it into a pcl/PCLPointCloud2. More...
int read (const std::string &file_name, pcl::TextureMesh &mesh, Eigen::Vector4f &origin, Eigen::Quaternionf &orientation, int &file_version, const int offset=0)
Read a point cloud data from a FILE file and store it into a pcl/TextureMesh. More...
int read (const std::string &file_name, pcl::TextureMesh &mesh, const int offset=0)
Read a point cloud data from a FILE file and store it into a pcl/TextureMesh. More...
int read (const std::string &file_name, pcl::PolygonMesh &mesh, Eigen::Vector4f &origin, Eigen::Quaternionf &orientation, int &file_version, const int offset=0)
Read a point cloud data from a FILE file and store it into a pcl/PolygonMesh. More...
int read (const std::string &file_name, pcl::PolygonMesh &mesh, const int offset=0)
Read a point cloud data from a FILE file and store it into a pcl/PolygonMesh. More...
template<typename PointT >
int read (const std::string &file_name, pcl::PointCloud< PointT > &cloud, const int offset=0)
Read a point cloud data from any FILE file, and convert it to the given template format. More...
- Public Member Functions inherited from pcl::FileReader
FileReader ()
empty constructor More...
virtual ~FileReader ()
empty destructor More...
int read (const std::string &file_name, pcl::PCLPointCloud2 &cloud, const int offset=0)
Read a point cloud data from a FILE file (FILE_V6 only!) and store it into a pcl/PCLPointCloud2. More...
template<typename PointT >
int read (const std::string &file_name, pcl::PointCloud< PointT > &cloud, const int offset=0)
Read a point cloud data from any FILE file, and convert it to the given template format. More...

Detailed Description

Definition at line 93 of file obj_io.h.

Constructor & Destructor Documentation

OBJReader()

pcl::OBJReader::OBJReader ( )
inline

empty constructor

Definition at line 97 of file obj_io.h.

~OBJReader()

pcl::OBJReader::~OBJReader ( )
inline

empty destructor

Definition at line 99 of file obj_io.h.

Member Function Documentation

read() [1/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::PCLPointCloud2 & cloud,
const int offset = 0
)

Read a point cloud data from a FILE file and store it into a pcl/PCLPointCloud2.

Parameters
[in] file_name the name of the file containing the actual PointCloud data
[out] cloud the resultant PointCloud message read from disk
[in] offset the offset in the file where to expect the true header to begin. One usage example for setting the offset parameter is for reading data from a TAR "archive containing multiple files: TAR files always add a 512 byte header in front of the actual file, so set the offset to the next byte after the header (e.g., 513).
Returns
0 on success.

read() [2/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::PCLPointCloud2 & cloud,
Eigen::Vector4f & origin,
Eigen::Quaternionf & orientation,
int & file_version,
const int offset = 0
)
overridevirtual

Read a point cloud data from a FILE file and store it into a pcl/PCLPointCloud2.

Parameters
[in] file_name the name of the file containing the actual PointCloud data
[out] cloud the resultant PointCloud message read from disk
[out] origin the sensor acquisition origin always null
[out] orientation the sensor acquisition orientation always identity
[out] file_version always 0
[in] offset the offset in the file where to expect the true header to begin. One usage example for setting the offset parameter is for reading data from a TAR "archive containing multiple files: TAR files always add a 512 byte header in front of the actual file, so set the offset to the next byte after the header (e.g., 513).
Returns
0 on success.

Implements pcl::FileReader.

Referenced by pcl::io::loadOBJFile().

read() [3/7]

template<typename PointT >
int pcl::OBJReader::read ( const std::string & file_name,
pcl::PointCloud< PointT > & cloud,
const int offset = 0
)
inline

Read a point cloud data from any FILE file, and convert it to the given template format.

Parameters
[in] file_name the name of the file containing the actual PointCloud data
[out] cloud the resultant PointCloud message read from disk
[in] offset the offset in the file where to expect the true header to begin. One usage example for setting the offset parameter is for reading data from a TAR "archive containing multiple files: TAR files always add a 512 byte header in front of the actual file, so set the offset to the next byte after the header (e.g., 513).

Definition at line 232 of file obj_io.h.

References pcl::fromPCLPointCloud2(), pcl::read(), pcl::PointCloud< PointT >::sensor_orientation_, and pcl::PointCloud< PointT >::sensor_origin_.

read() [4/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::PolygonMesh & mesh,
const int offset = 0
)

Read a point cloud data from a FILE file and store it into a pcl/PolygonMesh.

Parameters
[in] file_name the name of the file containing data
[out] mesh the resultant PolygonMesh read from disk
[in] offset the offset in the file where to expect the true header to begin.
Returns
0 on success.

read() [5/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::PolygonMesh & mesh,
Eigen::Vector4f & origin,
Eigen::Quaternionf & orientation,
int & file_version,
const int offset = 0
)

Read a point cloud data from a FILE file and store it into a pcl/PolygonMesh.

Parameters
[in] file_name the name of the file containing data
[out] mesh the resultant PolygonMesh read from disk
[out] origin the sensor origin always null
[out] orientation the sensor orientation always identity
[out] file_version always 0
[in] offset the offset in the file where to expect the true header to begin.
Returns
0 on success.

read() [6/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::TextureMesh & mesh,
const int offset = 0
)

Read a point cloud data from a FILE file and store it into a pcl/TextureMesh.

Parameters
[in] file_name the name of the file containing data
[out] mesh the resultant TextureMesh read from disk
[in] offset the offset in the file where to expect the true header to begin.
Returns
0 on success.

read() [7/7]

int pcl::OBJReader::read ( const std::string & file_name,
pcl::TextureMesh & mesh,
Eigen::Vector4f & origin,
Eigen::Quaternionf & orientation,
int & file_version,
const int offset = 0
)

Read a point cloud data from a FILE file and store it into a pcl/TextureMesh.

Parameters
[in] file_name the name of the file containing data
[out] mesh the resultant TextureMesh read from disk
[out] origin the sensor origin always null
[out] orientation the sensor orientation always identity
[out] file_version always 0
[in] offset the offset in the file where to expect the true header to begin.
Returns
0 on success.

readHeader()

int pcl::OBJReader::readHeader ( const std::string & file_name,
pcl::PCLPointCloud2 & cloud,
Eigen::Vector4f & origin,
Eigen::Quaternionf & orientation,
int & file_version,
int & data_type,
unsigned int & data_idx,
const int offset
)
overridevirtual

Read a point cloud data header from a FILE file.

Load only the meta information (number of points, their types, etc), and not the points themselves, from a given FILE file. Useful for fast evaluation of the underlying data structure.

Parameters
[in] file_name the name of the file containing the actual PointCloud data
[out] cloud the resultant PointCloud message read from disk
[out] origin the sensor acquisition origin always null
[out] orientation the sensor acquisition orientation always identity
[out] file_version always 0
data_type
data_idx
[in] offset the offset in the file where to expect the true header to begin. One usage example for setting the offset parameter is for reading data from a TAR "archive containing multiple files: TAR files always add a 512 byte header in front of the actual file, so set the offset to the next byte after the header (e.g., 513).
Returns
0 on success.

Implements pcl::FileReader.


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

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1_o_b_j_reader.html