NDEVR
API Documentation
CaptureRequest

A request to capture the 3D view as a 2D image. More...

Inheritance diagram for CaptureRequest:
[legend]
Collaboration diagram for CaptureRequest:
[legend]

Public Member Functions

 CaptureRequest (UUID id)
 Constructs a capture request with the given UUID.
 CaptureRequest (UUID id, const CaptureInfo &info, const std::function< void(const QImage &image)> &n_callback)
 Constructs a capture request with capture info and a completion callback.
UUID uuid () const
 Gets the UUID of this capture request.

Public Attributes

std::function< void(const QImage &image)> callback = nullptr
 Callback invoked with the captured image.
UUID m_id
 The unique identifier for this capture request.
Public Attributes inherited from CaptureInfo
Vector< 3, Angle< fltp08 > > angle_offsets
 Camera angle offsets around the X, Y, and Z axes.
bool auto_crop = false
 Whether to automatically crop empty space from the captured image.
RGBColor background = { 255, 255, 255, 0}
 The background color for the captured image.
Buffer< UUIDincluded_objects
 Additional objects to include in the capture.
bool orthographic = false
 Whether to use orthographic projection instead of perspective.
fltp08 reference_size = 128.0
 The reference size used for scaling the view.
Vector< 2, uint04size = { 128, 128 }
 The output image dimensions in pixels.
SnapLocation snap = SnapLocation::e_no_snap
 The snap location for camera positioning.
UUID target_object = Constant<UUID>::Invalid
 The UUID of the primary object to focus on.

Detailed Description

A request to capture the 3D view as a 2D image.


Definition at line 77 of file QModelViewCapture.h.

Constructor & Destructor Documentation

◆ CaptureRequest() [1/2]

CaptureRequest::CaptureRequest ( UUID id)
inline

Constructs a capture request with the given UUID.

Parameters
[in]idThe unique identifier for this request.

Definition at line 83 of file QModelViewCapture.h.

References m_id.

◆ CaptureRequest() [2/2]

CaptureRequest::CaptureRequest ( UUID id,
const CaptureInfo & info,
const std::function< void(const QImage &image)> & n_callback )
inline

Constructs a capture request with capture info and a completion callback.

Parameters
[in]idThe unique identifier for this request.
[in]infoThe capture parameters.
[in]n_callbackThe function called with the resulting image when capture is complete.

Definition at line 92 of file QModelViewCapture.h.

References callback, and m_id.

Member Function Documentation

◆ uuid()

UUID CaptureRequest::uuid ( ) const
inline

Gets the UUID of this capture request.

Returns
The request UUID.

Definition at line 101 of file QModelViewCapture.h.

References m_id.


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