OrbbecSDK 1.10.18
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ob::PointsFrame Class Reference

#include <Frame.hpp>

+ Inheritance diagram for ob::PointsFrame:

Public Member Functions

 PointsFrame (Frame &frame)
 
 PointsFrame (std::unique_ptr< FrameImpl > impl)
 
 ~PointsFrame () noexcept override=default
 
float getPositionValueScale ()
 Get the point position value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if 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.
 
- 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.
 
virtual OBFormat format ()
 Get the format of the frame.
 
virtual uint64_t index ()
 Get the sequence number of the frame.
 
virtual void * data ()
 Get the frame data.
 
virtual uint32_t dataSize ()
 Get the size of the frame data.
 
uint64_t timeStamp ()
 Get the hardware timestamp of the frame in milliseconds.
 
uint64_t timeStampUs ()
 Get the hardware timestamp of the frame in microseconds.
 
uint64_t systemTimeStamp ()
 Get the system timestamp of the frame in milliseconds.
 
uint64_t systemTimeStampUs ()
 Get the system timestamp of the frame in microseconds.
 
uint64_t globalTimeStampUs ()
 Get the global timestamp of the frame in microseconds.
 
void * metadata ()
 Get the metadata of the frame.
 
uint32_t metadataSize ()
 Get the size of the metadata of the frame.
 
bool hasMetadata (OBFrameMetadataType type)
 Check if the frame object has metadata of a given type.
 
int64_t getMetadataValue (OBFrameMetadataType type)
 Get the metadata value.
 
std::shared_ptr< StreamProfilegetStreamProfile ()
 get StreamProfile of the frame
 
std::shared_ptr< SensorgetSensor ()
 get owner sensor of the frame
 
std::shared_ptr< DevicegetDevice ()
 get owner device of the frame
 
template<typename T >
bool is ()
 Check if the runtime type of the frame object is compatible with a given type.
 
template<typename T >
std::shared_ptr< T > as ()
 Convert the frame object to a target type.
 

Additional Inherited Members

- Protected Attributes inherited from ob::Frame
std::unique_ptr< FrameImpl > impl_
 

Detailed Description

Definition at line 283 of file Frame.hpp.

Constructor & Destructor Documentation

◆ PointsFrame() [1/2]

ob::PointsFrame::PointsFrame ( Frame frame)
explicit

◆ PointsFrame() [2/2]

ob::PointsFrame::PointsFrame ( std::unique_ptr< FrameImpl >  impl)
explicit

◆ ~PointsFrame()

ob::PointsFrame::~PointsFrame ( )
overridedefaultnoexcept

Member Function Documentation

◆ getPositionValueScale()

float ob::PointsFrame::getPositionValueScale ( )

Get the point position value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if 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.

Returns
float The position value scale.

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