ob::PointsFrame Class Reference

#include <Frame.hpp>

Inheritance diagram for ob::PointsFrame:

Public Member Functions
	PointsFrame (Frame &frame)
	~PointsFrame () noexcept
float	getPositionValueScale ()
	Get the point position value scale of the points frame. the point position value of points frame is multiplied by the scale to give a position value in millimeter. such as scale=0.1, The x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm. More...
Public Member Functions inherited from ob::Frame
	Frame (std::unique_ptr< FrameImpl > impl)
	Frame (Frame &frame)
virtual	~Frame () noexcept
virtual OBFrameType	type ()
	Get the type of frame. More...
virtual OBFormat	format ()
	Get the format of the frame. More...
virtual uint64_t	index ()
	Get the sequence number of the frame. More...
virtual void *	data ()
	Get frame data. More...
virtual uint32_t	dataSize ()
	Get the frame data size. More...
uint64_t	timeStamp ()
	Get the hardware timestamp of the frame. More...
uint64_t	timeStampUs ()
	Get the hardware timestamp of the frame us. More...
uint64_t	systemTimeStamp ()
	Get frame system timestamp. More...
template<typename T >
bool	is ()
	Check if the runtime type of the frame object is compatible with a given type. More...
template<typename T >
std::shared_ptr< T >	as ()
	Frame object type conversion. More...

Additional Inherited Members
Protected Attributes inherited from ob::Frame
std::unique_ptr< FrameImpl >	impl_

Detailed Description

Definition at line 310 of file Frame.hpp.

Constructor & Destructor Documentation

ob::PointsFrame::PointsFrame

(

Frame &

frame

)

ob::PointsFrame::~PointsFrame ( )

inlinenoexcept

Definition at line 313 of file Frame.hpp.

Member Function Documentation

float ob::PointsFrame::getPositionValueScale

(

)

Get the point position value scale of the points frame. the point position value of points frame is multiplied by the scale to give a position value in millimeter. such as scale=0.1, The x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm.

Parameters

[in]	frame	Frame object
[out]	error	Log error messages

Returns

float position value scale

---

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

• /root/libobsensor/include/libobsensor/hpp/Frame.hpp