IOculusHMDModule

[IOculusHMDModule](API\Plugins\OculusHMD\IOculusHMDModule).

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

OculusHMD

Header

/Engine/Plugins/Runtime/Oculus/OculusVR/Source/OculusHMD/Public/IOculusHMDModule.h

Include

#include "IOculusHMDModule.h"

Syntax

class IOculusHMDModule : public IHeadMountedDisplayModule

Remarks

The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

Functions

Name Description

Public function Static

IOculusHMDMo...

 

Get()

Singleton-like access to this module's interface.

Public function

void

 

GetBaseRotationAndBaseOffsetInMeters

(
    FRotator& OutRotation,
    FVector& OutBaseOffsetInMeters
)

Returns current base rotation and base offset.

Public function

void

 

GetBaseRotationAndPositionOffset

(
    FRotator& OutRot,
    FVector& OutPosOffset
)

Returns current base rotation and position offset.

Public function

void

 

GetPose

(
    FRotator& DeviceRotation,
    FVector& DevicePosition,
    FVector& NeckPosition,
    bool bUseOrienationForPlayerCamera,
    bool bUsePositionForPlayerCamera,
    const FVector PositionScale
)

Grabs the current orientation and position for the HMD.

Public function

void

 

GetRawSensorData

(
    FVector& AngularAcceleration,
    FVector& LinearAcceleration,
    FVector& AngularVelocity,
    FVector& LinearVelocity,
    float& TimeInSeconds
)

Reports raw sensor data. If HMD doesn't support any of the parameters then it will be set to zero.

Public function

IStereoLayer...

 

GetStereoLayers()

Returns IStereoLayers interface to work with overlays.

Public function

bool

 

GetUserProfile

(
    FHmdUserProfile& Profile
)

Returns current user profile.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function

void

 

SetBaseRotationAndBaseOffsetInMeters

(
    FRotator Rotation,
    FVector BaseOffsetInMeters,
    EOrientPositionSelector::Type Optio...
)

Sets 'base rotation' - the rotation that will be subtracted from the actual HMD orientation.

Public function

void

 

SetBaseRotationAndPositionOffset

(
    FRotator BaseRot,
    FVector PosOffset,
    EOrientPositionSelector::Type Optio...
)

Sets 'base rotation' - the rotation that will be subtracted from the actual HMD orientation.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback