A WindowController manages a ViewController and its descendants within an SDL_Window. More...

#include <WindowController.h>

Inheritance diagram for WindowController:

Public Member Functions
Class *	_WindowController (void)
	The WindowController archetype. More...

void	debug (WindowController *self)
	Debugs the current frame. More...

View *	eventTarget (const WindowController self, const SDL_Event event)

View *	firstResponder (const WindowController self, const SDL_Event event)

WindowController *	initWithWindow (WindowController self, SDL_Window window)
	Initializes this WindowController with the given window. More...

void	render (WindowController *self)
	Renders the ViewController's View. More...

void	respondToEvent (WindowController self, const SDL_Event event)
	Responds to the given event. More...

void	setRenderer (WindowController self, Renderer renderer)
	Sets this WindowController's Renderer. More...

void	setSoundStage (WindowController self, SoundStage soundStage)
	Sets this WindowController's SoundStage. More...

void	setTheme (WindowController self, Theme theme)
	Sets this WindowController's Theme. More...

void	setViewController (WindowController self, ViewController viewController)
	Sets this WindowController's ViewController. More...

void	setWindow (WindowController self, SDL_Window window)
	Sets this WindowController's window. More...

void	toggleDebugger (WindowController *self)
	Toggles the debugger tools. More...

WindowController *	windowController (SDL_Window *window)

Data Fields
DebugViewController *	debugViewController
	The DebugViewController. More...

Object	object
	The superclass. More...

Renderer *	renderer
	The Renderer. More...

SoundStage *	soundStage
	The SoundStage. More...

Theme *	theme
	The Theme. More...

ViewController *	viewController
	The ViewController. More...

SDL_Window *	window
	The window. More...

Protected Attributes
WindowControllerInterface *	interface
	The interface. More...

Detailed Description

A WindowController manages a ViewController and its descendants within an SDL_Window.

Definition at line 46 of file WindowController.h.

Member Function Documentation

◆ _WindowController()

Class * _WindowController ( void )

The WindowController archetype.

Returns: The WindowController Class.

Definition at line 380 of file WindowController.c.

                               {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "WindowController",
            .superclass = _Object(),
            .instanceSize = sizeof(WindowController),
            .interfaceOffset = offsetof(WindowController, interface),
            .interfaceSize = sizeof(WindowControllerInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

◆ debug()

void debug ( WindowController * self )

Debugs the current frame.

Parameters

self	The WindowController.

Definition at line 55 of file WindowController.c.

                                          {
 
    if (self->viewController && self->debugViewController) {
 
        ViewController *debugViewController = (ViewController *) self->debugViewController;
 
        SDL_Point point = MakePoint(0, 0);
        SDL_GetMouseState(&point.x, &point.y);
 
        View *view = $(self->viewController->view, hitTest, &point);
        if (view) {
            $(self->debugViewController, debug, view, self->renderer);
        }
 
        $(debugViewController->view, applyThemeIfNeeded, self->theme);
        $(debugViewController->view, layoutIfNeeded);
        $(debugViewController->view, draw, self->renderer);
    }
}

◆ eventTarget()

View * eventTarget	(	const WindowController *	self,
		const SDL_Event *	event
	)

Parameters

self	The WindowController.
event	The event.

Returns: The View that was targeted by the given event.

See also: View::hitTest(const View *, const SDL_Point *)

Definition at line 79 of file WindowController.c.

                                                                               {
 
    SDL_Point point;
 
    if (event->type == SDL_MOUSEBUTTONDOWN || event->type == SDL_MOUSEBUTTONUP) {
        point = MakePoint(event->button.x, event->button.y);
    } else if (event->type == SDL_MOUSEMOTION) {
        point = MakePoint(event->motion.x, event->motion.y);
    } else if (event->type == SDL_MOUSEWHEEL) {
        SDL_GetMouseState(&point.x, &point.y);
    } else {
        return NULL;
    }
 
    return $(self->viewController->view, hitTest, &point);
}

◆ firstResponder()

View * firstResponder	(	const WindowController *	self,
		const SDL_Event *	event
	)

Parameters

self	The WindowController.
event	The event.

Returns: The first responder for the given event.

See also: MVC_FirstResponder(SDL_Window *)

Definition at line 100 of file WindowController.c.

                                                                                  {
    return $$(View, firstResponder, self->window) ?: $(self, eventTarget, event);
}

◆ initWithWindow()

WindowController * initWithWindow	(	WindowController *	self,
		SDL_Window *	window
	)

Initializes this WindowController with the given window.

Parameters

self	The WindowController.
window	The window.

Returns: The initialized WindowController, or NULL on error.

Definition at line 108 of file WindowController.c.

                                                                                    {
 
    self = (WindowController *) super(Object, self, init);
    if (self) {
        $(self, setWindow, window);
        $(self, setViewController, NULL);
        $(self, setSoundStage, NULL);
        $(self, setRenderer, NULL);
        $(self, setTheme, NULL);
    }
 
    return self;
}

◆ render()

void render ( WindowController * self )

Renders the ViewController's View.

Parameters

self	The WindowController.

Remarks: Your application should call this method once per frame to render the View hierarchy.

Definition at line 126 of file WindowController.c.

                                           {
 
    assert(self->renderer);
 
    $(self->renderer, beginFrame);
 
    $(self->viewController->view, applyThemeIfNeeded, self->theme);
    $(self->viewController->view, layoutIfNeeded);
 
    $(self->viewController->view, draw, self->renderer);
 
    $(self, debug);
 
    $(self->renderer, endFrame);
}

◆ respondToEvent()

void respondToEvent	(	WindowController *	self,
		const SDL_Event *	event
	)

Responds to the given event.

Parameters

self	The WindowController.
event	The event.

Remarks

Your application should call this method for each event that the View hierarchy is expected to respond to. The event will be dispatched to WindowController::firstResponder, which is the first of:

The View that has claimed first responder status for the window via View::becomeFirstResponder
The inner-most descendant in the View hierarchy that received the event, according to View::hitTest
This WindowController's ViewController

By default, the event is passed up the View hierarchy by View::respondToEvent. Subclasses of View, such as Control, may stop event propagation if an event has been adequately responded to.

Definition at line 146 of file WindowController.c.

                                                                           {
 
    if (event->type == SDL_USEREVENT && event->user.type == MVC_NOTIFICATION_EVENT) {
        $(self->viewController, handleNotification, &(const Notification) {
            .name = event->user.code,
            .sender = event->user.data1,
            .data = event->user.data2
        });
    } else {
 
        if (event->type == SDL_WINDOWEVENT) {
            switch (event->window.event) {
                case SDL_WINDOWEVENT_EXPOSED:
                    $(self, setWindow, SDL_GL_GetCurrentWindow());
                    $(self->renderer, renderDeviceDidReset);
                    $(self->viewController->view, renderDeviceDidReset);
                    $(self->viewController->view, updateBindings);
                    break;
                case SDL_WINDOWEVENT_CLOSE:
                    $(self->renderer, renderDeviceWillReset);
                    $(self->viewController->view, renderDeviceWillReset);
                    break;
                default:
                    break;
            }
        }
 
        View *firstResponder = $(self, firstResponder, event);
        if (firstResponder) {
 
            switch (event->type) {
                case SDL_MOUSEMOTION:
                    break;
                default: {
                    String *desc = $((Object *) firstResponder, description);
                    MVC_LogMessage(SDL_LOG_PRIORITY_DEBUG, "%d -> %s\n", event->type, desc->chars);
                    release(desc);
                }
            }
 
            $(firstResponder, respondToEvent, event);
        }
 
        if (event->type == SDL_KEYUP) {
            if (event->key.keysym.sym == SDLK_d) {
                if (event->key.keysym.mod & KMOD_CTRL) {
                    $(self, toggleDebugger);
                }
            }
        }
    }
}

◆ setRenderer()

void setRenderer	(	WindowController *	self,
		Renderer *	renderer
	)

Sets this WindowController's Renderer.

Parameters

self	The WindowController.
renderer	The Renderer.

Definition at line 203 of file WindowController.c.

                                                                    {
 
    if (self->renderer != renderer || self->renderer == NULL) {
 
        release(self->renderer);
 
        if (renderer) {
            self->renderer = retain(renderer);
        } else {
            self->renderer = $(alloc(Renderer), init);
        }
 
        $(self->viewController->view, renderDeviceDidReset);
    }
}

◆ setSoundStage()

void setSoundStage	(	WindowController *	self,
		SoundStage *	soundStage
	)

Sets this WindowController's SoundStage.

Parameters

self	The WindowController.
soundStage	The SoundStage.

Definition at line 223 of file WindowController.c.

                                                                          {
 
    if (self->soundStage != soundStage || self->soundStage == NULL) {
 
        release(self->soundStage);
 
        if (soundStage) {
            self->soundStage = retain(soundStage);
        } else {
            self->soundStage = $(alloc(SoundStage), init);
        }
    }
}

◆ setTheme()

void setTheme	(	WindowController *	self,
		Theme *	theme
	)

Sets this WindowController's Theme.

Parameters

self	The WindowController.
theme	The Theme.

Definition at line 241 of file WindowController.c.

                                                           {
 
    if (self->theme != theme || self->theme == NULL) {
 
        release(self->theme);
 
        if (theme) {
            self->theme = retain(theme);
        } else {
            self->theme = $(alloc(Theme), init);
        }
    }
 
    $(self->viewController->view, invalidateStyle);
}

◆ setViewController()

void setViewController	(	WindowController *	self,
		ViewController *	viewController
	)

Sets this WindowController's ViewController.

Parameters

self	The WindowController.
viewController	The ViewController.

Definition at line 261 of file WindowController.c.

                                                                                      {
 
    if (self->viewController != viewController || self->viewController == NULL) {
 
        if (self->viewController) {
            $(self->viewController, viewWillDisappear);
            $(self->viewController->view, moveToWindow, NULL);
            $(self->viewController, viewDidDisappear);
        }
 
        release(self->viewController);
 
        if (viewController) {
            self->viewController = retain(viewController);
        } else {
            self->viewController = $(alloc(ViewController), init);
        }
 
        $(self->viewController, loadViewIfNeeded);
 
        $(self->viewController, viewWillAppear);
        $(self->viewController->view, moveToWindow, self->window);
        $(self->viewController, viewDidAppear);
    }
}

◆ setWindow()

void setWindow	(	WindowController *	self,
		SDL_Window *	window
	)

Sets this WindowController's window.

Parameters

self	The WindowController.
window	The window.

Definition at line 291 of file WindowController.c.

                                                                  {
 
    self->window = window;
    assert(self->window);
 
    const Uint32 flags = SDL_GetWindowFlags(self->window);
    assert(flags & SDL_WINDOW_OPENGL);
 
    SDL_SetWindowData(self->window, "windowController", self);
    assert(SDL_GetWindowData(self->window, "windowController") == self);
 
    if (self->viewController) {
        $(self->viewController->view, moveToWindow, self->window);
    }
 
    if (self->debugViewController) {
        $(self->debugViewController->viewController.view, moveToWindow, self->window);
    }
}

◆ toggleDebugger()

void toggleDebugger ( WindowController * self )

Toggles the debugger tools.

Parameters

self	The WindowViewController.

Definition at line 315 of file WindowController.c.

                                                   {
 
    if (self->debugViewController == NULL) {
 
        self->debugViewController = $(alloc(DebugViewController), init);
        assert(self->debugViewController);
 
        ViewController *debugViewController = (ViewController *) self->debugViewController;
 
        $(debugViewController, loadView);
        $(debugViewController, viewWillAppear);
        $(debugViewController->view, moveToWindow, self->window);
        $(debugViewController, viewDidAppear);
 
        if (self->viewController) {
            $(self->viewController->view, addClassName, "debug");
        }
    } else {
        self->debugViewController = release(self->debugViewController);
 
        if (self->viewController) {
            $(self->viewController->view, removeClassName, "debug");
        }
    }
}

◆ windowController()

WindowController * windowController ( SDL_Window * window )

Parameters

window The window.

Returns: The WindowController bound to the given window.

Definition at line 345 of file WindowController.c.

                                                              {
 
    assert(window);
 
    return SDL_GetWindowData(window, "windowController");
}

Field Documentation

◆ debugViewController

DebugViewController* WindowController::debugViewController

The DebugViewController.

Definition at line 62 of file WindowController.h.

◆ interface

WindowControllerInterface* WindowController::interface

protected

The interface.

Definition at line 57 of file WindowController.h.

◆ object

Object WindowController::object

The superclass.

Definition at line 51 of file WindowController.h.

◆ renderer

Renderer* WindowController::renderer

The Renderer.

Definition at line 67 of file WindowController.h.

◆ soundStage

SoundStage* WindowController::soundStage

The SoundStage.

Definition at line 72 of file WindowController.h.

◆ theme

Theme* WindowController::theme

The Theme.

Definition at line 77 of file WindowController.h.

◆ viewController

ViewController* WindowController::viewController

The ViewController.

Definition at line 82 of file WindowController.h.

◆ window

SDL_Window* WindowController::window

The window.

Definition at line 87 of file WindowController.h.

The documentation for this struct was generated from the following files:

Sources/ObjectivelyMVC/WindowController.h
Sources/ObjectivelyMVC/WindowController.c

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ _WindowController()

◆ debug()

◆ eventTarget()

◆ firstResponder()

◆ initWithWindow()

◆ render()

◆ respondToEvent()

◆ setRenderer()

◆ setSoundStage()

◆ setTheme()

◆ setViewController()

◆ setWindow()

◆ toggleDebugger()

◆ windowController()

Field Documentation

◆ debugViewController

◆ interface

◆ object

◆ renderer

◆ soundStage

◆ theme

◆ viewController

◆ window