UGoogleVRControllerFunctionLibrary

GoogleVRController Extensions Function Library

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

GoogleVRController

Header

/Engine/Plugins/Runtime/GoogleVR/GoogleVRController/Source/GoogleVRController/Classes/GoogleVRControllerFunctionLibrary.h

Include

#include "GoogleVRControllerFunctionLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UGoogleVRControllerFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

GoogleVRController Extensions Function Library

Constructors

Name Description

Public function

UGoogleVRControllerFunctionLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetArmModelAddedElbowDepth()

Get the elbow depth used by the arm model in meters.

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetArmModelAddedElbowHeight()

Get the elbow height used by the arm model in meters.

Public function Static UFunction BlueprintCallable, Category, Meta

bool

 

GetArmModelIsLockedToHead()

Get if the Arm Model will be locked to the head Pose.

Public function Static UFunction BlueprintPure, Category, Meta

FVector

 

GetArmModelPointerPositionOffset()

Returns the local position of the pointer in the unreal coordinate system relative to the motion controller.

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetArmModelPointerTiltAngle()

Get the pointer tilt angle.

Public function Static UFunction BlueprintPure, Category, Meta

bool

 

GetBatteryCharging

(
    EControllerHand Hand
)

Get whether the controller battery is currently charging.

Public function Static UFunction BlueprintPure, Category, Meta

EGoogleVRCon...

 

GetBatteryLevel

(
    EControllerHand Hand
)

Get the bucketed controller battery level.

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetControllerAlphaValue()

Get the current desired alpha value of the controller visual.

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetFadeDistanceFromFace()

Controller distance from the face after which the alpha value decreases (meters).

Public function Static UFunction BlueprintPure, Category, Meta

EGoogleVRCon...

 

GetGoogleVRControllerAPIStatus()

Get the GoogleVR Controller API status

Public function Static UFunction BlueprintCallable, Category, Meta

UGoogleVRCon...

 

GetGoogleVRControllerEventManager()

Return a pointer to the UGoogleVRControllerEventManager to hook up GoogleVR Controller specific event.

Public function Static UFunction BlueprintPure, Category, Meta

EGoogleVRCon...

 

GetGoogleVRControllerHandedness()

Get user's handedness preference from GVRSDK

Public function Static UFunction BlueprintPure, Category, Meta

FRotator

 

GetGoogleVRControllerOrientation

(
    EControllerHand Hand
)

This function return the orientation of the controller in unreal space.

Public function Static UFunction BlueprintPure, Category, Meta

FVector

 

GetGoogleVRControllerRawAccel

(
    EControllerHand Hand
)

This function return the controller acceleration in gvr controller space.

Public function Static UFunction BlueprintPure, Category, Meta

FVector

 

GetGoogleVRControllerRawGyro

(
    EControllerHand Hand
)

This function return the controller angular velocity about each axis (positive means clockwise when sighting along axis) in gvr controller space.

Public function Static UFunction BlueprintPure, Category, Meta

EGoogleVRCon...

 

GetGoogleVRControllerState

(
    EControllerHand Hand
)

Get the GoogleVR Controller state

Public function Static

int64_t

 

GetLastBatteryTimestamp

(
    EControllerHand Hand
)

Get the timestamp (nanos) when the last battery event was received.

Public function Static UFunction BlueprintCallable, Category, Meta

float

 

GetTooltipAlphaValue()

Get the current desired alpha value of the tooltip visual.

Public function Static UFunction BlueprintPure, Category, Meta

int

 

GetTooltipMaxAngleFromCamera()

When the angle (degrees) between the controller and the head is larger than this value, the tooltip disappears.

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetTooltipMinDistanceFromFace()

Controller distance from the face after which the tooltips appear (meters).

Public function Static UFunction BlueprintPure, Category, Meta

bool

 

IsArmModelEnabled()

Below are functions for controlling the Arm Model.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetArmModelAddedElbowDepth

(
    float ElbowDepth
)

Set the elbow depth used by the arm model in meters.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetArmModelAddedElbowHeight

(
    float ElbowHeight
)

Set the elbow height used by the arm model in meters.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetArmModelEnabled

(
    bool bArmModelEnabled
)

Set the arm model enabled/disabled

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetArmModelIsLockedToHead

(
    bool IsLockedToHead
)

Set if the Arm Model will be locked to the head Pose.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetArmModelPointerTiltAngle

(
    float TiltAngle
)

Set the pointer tilt angle. Defaults to 15 degrees, which is comfortable for most use cases.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetFadeDistanceFromFace

(
    float DistanceFromFace
)

Controller distance from the face after which the alpha value decreases (meters).

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetTooltipMaxAngleFromCamera

(
    int AngleFromCamera
)

When the angle (degrees) between the controller and the head is larger than this value, the tooltip disappears.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetTooltipMinDistanceFromFace

(
    float DistanceFromFace
)

Controller distance from the face after which the tooltips appear (meters).

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetWillArmModelUseAccelerometer

(
    bool UseAccelerometer
)

Set if the arm model will use accelerometer data If this is turned on, then the arm model will estimate the position of the controller in space using accelerometer data.

Public function Static UFunction BlueprintPure, Category, Meta

bool

 

WillArmModelUseAccelerometer()

Get if the arm model will use accelerometer data If this is turned on, then the arm model will estimate the position of the controller in space using accelerometer data.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss