Azure Kinect Body Tracking SDK  0.9.5
k4abt::frame Class Reference

Wrapper for k4abt_frame_t. More...

#include <k4a/k4abt.hpp>

Public Member Functions

 frame (k4abt_frame_t handle=nullptr) noexcept
 Creates a k4abt frame from a k4abt_frame_t. More...
 
 frame (const frame &other) noexcept
 Creates a shallow copy of another k4abt frame.
 
 frame (frame &&other) noexcept
 Moves another k4abt frame into a new frame.
 
frameoperator= (const frame &other) noexcept
 Sets frame to a shallow copy of other.
 
frameoperator= (frame &&other) noexcept
 Moves another frame into this frame; other is set to invalid.
 
frameoperator= (std::nullptr_t) noexcept
 Invalidates this frame.
 
bool operator== (const frame &other) const noexcept
 Returns true if two frames refer to the same k4abt_frame_t, false otherwise.
 
bool operator== (std::nullptr_t) const noexcept
 Returns false if the frame is valid, true otherwise.
 
bool operator!= (const frame &other) const noexcept
 Returns true if two frames wrap different k4abt_frame_t instances, false otherwise.
 
bool operator!= (std::nullptr_t) const noexcept
 Returns true if the frame is valid, false otherwise.
 
 operator bool () const noexcept
 Returns true if the frame is valid, false otherwise.
 
k4abt_frame_t handle () const noexcept
 Returns the underlying k4abt_frame_t handle. More...
 
void reset () noexcept
 Releases the underlying k4abt_frame_t; the frame is set to invalid.
 
uint32_t get_num_bodies () noexcept
 Get the number of people detected from the k4abt frame. More...
 
k4abt_skeleton_t get_body_skeleton (uint32_t index)
 Get the joint information for a particular person index from the k4abt_frame_t. More...
 
void get_body_skeleton (uint32_t index, k4abt_skeleton_t &skeleton)
 Get the joint information for a particular person index from the k4abt_frame_t. More...
 
uint32_t get_body_id (uint32_t index) noexcept
 Get the body id for a particular person index from the k4abt frame. More...
 
k4abt_body_t get_body (uint32_t index) noexcept
 Get the full body struct for a particular person index from the k4abt frame. More...
 
std::chrono::microseconds get_device_timestamp () const noexcept
 Get the k4abt frame's device timestamp in microseconds. More...
 
k4a::image get_body_index_map () const noexcept
 Get the body index map associated with the k4abt frame. More...
 
k4a::capture get_capture () const noexcept
 Get the original capture that is used to calculate the k4abt frame. More...
 

Detailed Description

Wrapper for k4abt_frame_t.

Wraps a handle for a k4abt frame. Copying/moving is cheap, copies are shallow.

See also
k4abt_frame_t

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