GLFrameViewController Class Reference

The GLFrameViewController implements a view controller that is mainly able to display medium objects. More...

#include <GLFrameViewController.h>

Inheritance diagram for GLFrameViewController:

Instance Methods
(void)	- setFrameMedium:
	Sets or changes the frame medium to be displayed.
(void)	- setFrameMedium:andAdjustFov:
	Sets or changes the frame medium to be displayed.
(void)	- setFrameMedium:withRotation:
	Sets or changes the frame medium to be displayed.
(void)	- setFrameMedium:withRotation:andAdjustFov:
	Sets or changes the frame medium to be displayed.
(Ocean::Media::FrameMediumRef)	- frameMedium
	Returns the current frame medium.
(CGPoint)	- view2medium:
	Converts a 2D location defined in the view's coordinate system to a location defined in the coordinate system of the medium (an image frame).
Instance Methods inherited from GLRendererViewController
(bool)	- setFovX:
	Sets the horizontal field of view for this view.
(bool)	- setBackgroundColor:
	Sets the background color of this view.
(void)	- setViewInteractionEnabled:
	Sets whether the user can change the view's position and rotation by touch events.
(void)	- update
	Updates the rendering engine.
Instance Methods inherited from GLViewController
(void)	- makeOpenGLContextCurrent
	Makes the OpenGL context of this controller the current context.

Protected Attributes
Ocean::Rendering::UndistortedBackgroundRef	renderingUndistortedBackground_
	The undistorted background.
Ocean::Media::FrameMediumRef	intermediateBackgroundFrameMedium_
	The frame medium of the background which is stored as long as the view hasn't been initialized.
bool	intermediateBackgroundAdjustFov_
	True, to adjust the field of view of the view automatically so that the background medium is entirely covered.
bool	adjustFovXToBackground_
	State determining that the view's field of view has to be adjusted to the background's field of view.
Protected Attributes inherited from GLRendererViewController
Ocean::Rendering::EngineRef	renderingEngine_
	The rendering engine to be used.
Ocean::Rendering::FramebufferRef	renderingFramebuffer_
	The framebuffer in which the result will be rendered.
Ocean::Rendering::PerspectiveViewRef	renderingView_
	The rendering view.
float	previousTouchX_
	Previous horizontal touch position.
float	previousTouchY_
	Previous vertical touch position.
Ocean::Timestamp	renderingStartTimestamp_
	Rendering start timestamp.
unsigned int	renderingIterations_
	Rendering iterations.
bool	viewInteractionEnabled_
	True, to allow the user to change the view's position and rotation by touch events; False, to disable the user interaction.
Ocean::Lock	lock_
	View lock object.

Detailed Description

The GLFrameViewController implements a view controller that is mainly able to display medium objects.

The view controller is derived from an OpenGLES view controller so that we can ensure the best performance possible.

See also

Apple::MacOS::FrameMediumView.

Method Documentation

frameMedium

- Media:

Returns the current frame medium.

Returns

The frame medium which is currently displayed

setFrameMedium:

- (void) setFrameMedium:

(const Ocean::Media::FrameMediumRef &)

frameMedium

Sets or changes the frame medium to be displayed.

Parameters

frameMedium

The frame medium to be displayed, must be valid

setFrameMedium:andAdjustFov:

- (void) setFrameMedium:		(const Ocean::Media::FrameMediumRef &)	frameMedium
andAdjustFov:		(bool)	adjustFov

Sets or changes the frame medium to be displayed.

Parameters

frameMedium	The frame medium to be displayed, must be valid
adjustFov	True, to adjust the view's field of view to the medium's field of view; False, to keep the view's field of view as is

setFrameMedium:withRotation:

- (void) setFrameMedium:		(const Ocean::Media::FrameMediumRef &)	frameMedium
withRotation:		(const Ocean::Quaternion &)	display_R_medium

Sets or changes the frame medium to be displayed.

Parameters

frameMedium	The frame medium to be displayed, must be valid
display_R_medium	Explicit rotation between medium and display, and invalid rotation to use the medium's and framebuffer's transformations to determine the rotation

setFrameMedium:withRotation:andAdjustFov:

- (void) setFrameMedium:		(const Ocean::Media::FrameMediumRef &)	frameMedium
withRotation:		(const Ocean::Quaternion &)	display_R_medium
andAdjustFov:		(bool)	adjustFov

Sets or changes the frame medium to be displayed.

Parameters

frameMedium	The frame medium to be displayed, must be valid
display_R_medium	Explicit rotation between medium and display, and invalid rotation to use the medium's and framebuffer's transformations to determine the rotation
adjustFov	True, to adjust the view's field of view to the medium's field of view; False, to keep the view's field of view as is

view2medium:

- (CGPoint) view2medium:

(CGPoint)

viewPoint

Converts a 2D location defined in the view's coordinate system to a location defined in the coordinate system of the medium (an image frame).

Parameters

viewPoint

The 2D location within this view

Returns

The corresponding 2D location within the image frame of the medium, a negative coordinate (-1, -1), in case no valid mapping exists

Field Documentation

adjustFovXToBackground_

- (bool) adjustFovXToBackground_

protected

State determining that the view's field of view has to be adjusted to the background's field of view.

Provided by category GLFrameViewController().

intermediateBackgroundAdjustFov_

- (bool) intermediateBackgroundAdjustFov_

protected

True, to adjust the field of view of the view automatically so that the background medium is entirely covered.

Provided by category GLFrameViewController().

intermediateBackgroundFrameMedium_

- Media:

protected

The frame medium of the background which is stored as long as the view hasn't been initialized.

Provided by category GLFrameViewController().

renderingUndistortedBackground_

- Rendering:

protected

The undistorted background.

Provided by category GLFrameViewController().

---

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

• GLFrameViewController.h