Ocean
OpenGLFrameMediumViewController Class Reference

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

Inheritance diagram for OpenGLFrameMediumViewController:

Instance Methods

(void) - setFrameMedium:
 Sets or changes the frame medium to be displayed. More...
 
(void) - setFrameMedium:withRotation:
 Sets or changes the frame medium to be displayed. More...
 
(Ocean::Media::FrameMediumRef- frameMedium
 Returns the current frame medium. More...
 
(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). More...
 
- Instance Methods inherited from OpenGLViewController
(void) - makeOpenGLContextCurrent
 Makes the OpenGL context of this controller the current context. More...
 

Detailed Description

The OpenGLViewController 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.
This class can be seen as a FrameMediumView equivalent using OpenGLES.

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
frameMediumThe frame medium to be displayed, must be valid

◆ 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
frameMediumThe frame medium to be displayed, must be valid
display_R_mediumExplicit rotation between medium and display, and invalid rotation to use the medium's and framebuffer's transformations to determine the rotation

◆ 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
viewPointThe 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

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