SRWorks Unreal Blueprint Function Library API Guide

In this page, we will show all SRWorks Unreal blueprint C++ API usage.

class USRWorksFunctionLibrary : public UBlueprintFunctionLibrary

Public Static Functions

static FString GetSRWorksVersion()

Get the version of SRWorks.

Return

version of SRWorks

static VRDevice GetDeviceType()

Get Device Type.

Return

one of VRDevice

static bool IsHorus()

Get whether Device is Horus.

Return

true if the Device is Horus.

static int StartModule(ModuleType type)

Start specific module

Return

one of ViveSR::Error

Parameters

  • ModuleType: spcific which module

static int StopModule(ModuleType type)

Stop specific module

Return

one of ViveSR::Error

Parameters

  • ModuleType: spcific which module

static ModuleStatus GetStatus(ModuleType type)

Get the status of the specific SRWorks engine.

Return

The status of the specific engine

Parameters

  • [in] ModuleType: What kind of engine is interested in

static bool GetDepthProcessing()

Get whether the depth process is active.

Return

true if the depth process is active.

static int EnableDepthProcess(bool active)

Eanble or disable the depth process and return the error code of result.

Return

one of ViveSR::Error

Parameters

  • active: set enable or disable.

static bool GetDepthRefinement()

Get whether depth refinement is active.

Return

true if the depth refinement is active.

static int EnableDepthRefinement(bool active)

Eanble or disable the depth refinement.

Return

one of ViveSR::Error

Parameters

  • active: set enable or disable.

static bool GetDepthEdgeEnhance()

Get whether depth edge enhance is active.

Return

true if the depth edge enhance is active.

static int EnableDepthEdgeEnhance(bool active)

Eanble or disable the depth edge enhance.

Return

one of ViveSR::Error

Parameters

  • active: set enable or disable.

static UDepthCase GetDepthCase()

Get the depth case.

Return

one of UDepthCase

static int SetDepthCase(UDepthCase depthCase)

Set the depth case.

Return

one of ViveSR::Error

Parameters

  • depthCase: spcific which case

static float GetDepthConfidenceThreshold()

Get the depth confidence threshold.

Return

depth confidence threshold

static int SetDepthConfidenceThreshold(float value)

Set the depth confidence threshold.

Return

one of ViveSR::Error

Parameters

  • value: set the value of depth confidence threshold

static int GetDepthDenoiseG()

Get the Depth Denoise Guided Filter.

Return

Depth Denoise Guided Filter.

static int SetDepthDenoiseG(int value)

Set the Depth Denoise Guided Filter.

Return

one of ViveSR::Error

Parameters

  • value: set the value of Depth Denoise Guided Filter

static int GetDepthDenoiseM()

Get the Depth Denoise Median Filter.

Return

Depth Denoise Median Filter.

static int SetDepthDenoiseM(int value)

Set the Depth Denoise Median Filter.

Return

one of ViveSR::Error

Parameters

  • value: set the value of Depth Denoise Median Filter.

static int GetCameraSettings(CameraQuality item, FParamInfo &param_info)

Get camera quality information

Return

one of ViveSR::Error

Parameters

  • item: specific camera quality item

  • is: information of camera quality

static int SetCamera(CameraQuality item, FParamInfo param_info)

Set camera quality information

Return

one of ViveSR::Error

Parameters

  • item: specific camera quality item

  • paramInfo: is information of camera quality

static int GetReconstructionResult()

Get the return value of GetRigidReconstructionData.

static int EnableReconstructionProcess(bool active)

Eanble or disable the reconstruction process and return the error code of result.

Return

one of ViveSR::Error

Parameters

  • active: set enable or disable.

static void StartScanning()

Start to scan the real scene.

static void StopScanning()

Stop scaning the real scene.

static int ResetReconstructionEngine()

Reset Reconstruction Engine.

static bool GetIsScanning()

Get whether the rigid reconstruction module is scaning.

Return

true if the rigid reconstruction module is scaning.

static bool GetIsExporting()

Get whether models are being exported.

Return

true if there are models are being exported.

static void ExportReconstructionInfo(FString filename)

Start to export current scene and create an obj file

Parameters

  • filename: set the name of obj file

static int GetExportProgress()

Get the percentage of current export progress.

Return

the percentage of current export progress.

static void ExportSceneUnderstandingInfo(FString filename)

Start to export sceneunderstanding and create an obj and xml file

Parameters

  • filename: set the output folder name of sceneunderstanding object

static int GetSceneUnderstandingExportProgress()

Get the percentage of current export progress of sceneunderstanding.

Return

the percentage of current export progress of sceneunderstanding.

static int CheckChairNum()

Check the number of chair for Chair Segmentation

Return

the number of chair

static TArray<FVector> GetChairLocation()

Get the Location of chairs for Chair Segmentation

Return

the position of chairs from xml file

static TArray<FVector> GetChairForward()

Get the Forward of chairs for Chair Segmentation

Return

the forward of chairs from xml file

static float AngleCalculation(FVector2D positionIni, FVector2D positionCurrent)

Get the angle of two vector for Calibration

Return

the angle between two vector in degree

Parameters

  • positionIni: is initial position at touchpad

  • positionCurrent: is current position at touchpad

static void SaveParameter(FRotator calibrationResult)

save the parameter of Rotator for Calibration

Parameters

  • calibrationResult: is result of calibration

static TArray<float> LoadParameter()

Load the parameter of Rotator for Calibration

Return

the calibration result

static int SetPassThroughMaxFps(int fps)

Set PassThroughFPS

Return

one of ViveSR::Error

Parameters

  • fps: set the fps of PassThrough

static int SetDepthMaxFps(int fps)

Set Depth FPS

Return

one of ViveSR::Error

Parameters

  • fps: set the fps of depth

static int SetDepthMeshMaxFps(int fps)

Set DepthMesh FPS

Return

one of ViveSR::Error

Parameters

  • fps: set the fps of depth mesh

static int SetReconstructionMaxFps(int fps)

Set Reconstruction FPS

Return

one of ViveSR::Error

Parameters

  • fps: set the fps of Reconstruction

static bool FileExists(const FString &InPath)

Check whether the file exists

Return

true if this file was found

static FString ProjectUserDir()

Get the root directory for user-specific game files.

Return

root directory for user-specific game files.

static FString GetSaveFileRootPath()

Get the root directory for saving files.

Return

root directory for saving files.