com.jme3.input.vr

Interface VRViewManager

All Known Implementing Classes:

AbstractVRViewManager, LWJGLOpenVRViewManager, OculusViewManager, OpenVRViewManager, OSVRViewManager

public interface VRViewManager

A VR view manager. This interface describes methods that enable to submit 3D views to the VR compositor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEFT_VIEW_NAME The name of the left view.
static java.lang.String	RIGHT_VIEW_NAME The name of the right view.

Method Summary

Modifier and Type	Method and Description
float	getHeightAdjustment() Get the height adjustment to apply to the cameras before rendering.
Camera	getLeftCamera() Get the camera attached to the left eye.
Texture2D	getLeftDepth() Get the depth texture attached to the left eye.
FilterPostProcessor	getLeftPostProcessor() Get the filter post processor attached to the left eye.
Texture2D	getLeftTexture() Get the texture attached to the left eye.
ViewPort	getLeftViewPort() Get the viewport attached to the left eye.
ViewPort	getMirrorViewPort() Get the view port attached to the mirror display.
float	getResolutionMuliplier() Get the resolution multiplier.
Camera	getRightCamera() Get the camera attached to the right eye.
Texture2D	getRightDepth() Get the depth texture attached to the right eye.
FilterPostProcessor	getRightPostProcessor() Get the filter post processor attached to the right eye.
Texture2D	getRightTexture() Get the texture attached to the right eye.
ViewPort	getRightViewPort() Get the viewport attached to the right eye.
VREnvironment	getVREnvironment() Get the VR environment to which the view manager is attached.
void	initialize() Initialize the VR view manager.
void	moveScreenProcessingToEyes() Handles moving filters from the main view to each eye.
void	postRender() Send the rendering result as textures to the two eyes.
void	render() This method contains action to be done during the rendering phase.
void	setHeightAdjustment(float amount) Set the height adjustment to apply to the cameras before rendering.
void	setResolutionMultiplier(float resMult) Set the resolution multiplier.
void	update(float tpf) Update the VR view manager.

Field Detail

LEFT_VIEW_NAME

static final java.lang.String LEFT_VIEW_NAME

The name of the left view.

See Also:

Constant Field Values

RIGHT_VIEW_NAME

static final java.lang.String RIGHT_VIEW_NAME

The name of the right view.

See Also:

Constant Field Values

Method Detail

getLeftCamera

Camera getLeftCamera()

Get the camera attached to the left eye.

Returns:

the camera attached to the left eye.

See Also:

getRightCamera()

getRightCamera

Camera getRightCamera()

Get the camera attached to the right eye.

Returns:

the camera attached to the right eye.

See Also:

getLeftCamera()

getLeftViewPort

ViewPort getLeftViewPort()

Get the viewport attached to the left eye.

Returns:

the viewport attached to the left eye.

See Also:

getRightViewPort()

getRightViewPort

ViewPort getRightViewPort()

Get the viewport attached to the right eye.

Returns:

the viewport attached to the right eye.

See Also:

getLeftViewPort()

getMirrorViewPort

ViewPort getMirrorViewPort()

Get the view port attached to the mirror display.

Returns:

the view port attached to the mirror display.

See Also:

getLeftViewPort(), getRightViewPort()

getLeftTexture

Texture2D getLeftTexture()

Get the texture attached to the left eye.

Returns:

the texture attached to the left eye.

See Also:

getRightTexture()

getRightTexture

Texture2D getRightTexture()

Get the texture attached to the right eye.

Returns:

the texture attached to the right eye.

See Also:

getLeftTexture()

getLeftDepth

Texture2D getLeftDepth()

Get the depth texture attached to the left eye.

Returns:

the texture attached to the left eye.

See Also:

getRightTexture()

getRightDepth

Texture2D getRightDepth()

Get the depth texture attached to the right eye.

Returns:

the texture attached to the right eye.

See Also:

getLeftTexture()

getLeftPostProcessor

FilterPostProcessor getLeftPostProcessor()

Get the filter post processor attached to the left eye.

Returns:

the filter post processor attached to the left eye.

See Also:

getRightPostProcessor()

getRightPostProcessor

FilterPostProcessor getRightPostProcessor()

Get the filter post processor attached to the right eye.

Returns:

the filter post processor attached to the right eye.

See Also:

getLeftPostProcessor()

getResolutionMuliplier

float getResolutionMuliplier()

Get the resolution multiplier.

Returns:

the resolution multiplier.

See Also:

setResolutionMultiplier(float)

setResolutionMultiplier

void setResolutionMultiplier(float resMult)

Set the resolution multiplier.

Parameters:

resMult - the resolution multiplier.

See Also:

getResolutionMuliplier()

getHeightAdjustment

float getHeightAdjustment()

Get the height adjustment to apply to the cameras before rendering.

Returns:

the height adjustment to apply to the cameras before rendering.

See Also:

setHeightAdjustment(float)

setHeightAdjustment

void setHeightAdjustment(float amount)

Set the height adjustment to apply to the cameras before rendering.

Parameters:

amount - the height adjustment to apply to the cameras before rendering.

See Also:

getHeightAdjustment()

getVREnvironment

VREnvironment getVREnvironment()

Get the VR environment to which the view manager is attached.

Returns:

the VR environment to which the view manager is attached.

initialize

void initialize()

Initialize the VR view manager. This method should be called after the attachment of a VR environment to an application.

update

void update(float tpf)

Update the VR view manager. This method is called by the attached app state and should not be called manually.

Parameters:

tpf - the time per frame.

render

void render()

This method contains action to be done during the rendering phase. This method should be called for example from the render method of an app state.

See Also:

postRender()

postRender

void postRender()

Send the rendering result as textures to the two eyes. This method should be called after all the rendering operations (for example at the end of the postRender() method of the attached app state.)

See Also:

render()

moveScreenProcessingToEyes

void moveScreenProcessingToEyes()

Handles moving filters from the main view to each eye.