#include <GHOST_SystemCocoa.hh>

Inherits GHOST_System.

Public Member Functions
	GHOST_SystemCocoa ()

	~GHOST_SystemCocoa () override

uint64_t	getMilliSeconds () const override

uint8_t	getNumDisplays () const override

void	getMainDisplayDimensions (uint32_t &width, uint32_t &height) const override

void	getAllDisplayDimensions (uint32_t &width, uint32_t &height) const override

GHOST_IWindow *	createWindow (const char title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, GHOST_GPUSettings gpuSettings, const bool exclusive=false, const bool is_dialog=false, const GHOST_IWindow parentWindow=nullptr) override

GHOST_IContext *	createOffscreenContext (GHOST_GPUSettings gpuSettings) override

GHOST_TSuccess	disposeContext (GHOST_IContext *context) override

GHOST_IWindow *	getWindowUnderCursor (int32_t x, int32_t y) override

bool	processEvents (bool waitForEvent) override

void	handleQuitRequest ()

bool	handleOpenDocumentRequest (void *filepathStr)

GHOST_TSuccess	handleDraggingEvent (GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType, GHOST_WindowCocoa window, int mouseX, int mouseY, void data)

GHOST_TSuccess	getCursorPosition (int32_t &x, int32_t &y) const override

GHOST_TSuccess	setCursorPosition (int32_t x, int32_t y) override

GHOST_TSuccess	getPixelAtCursor (float r_color[3]) const override

GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const override

GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const override

GHOST_TCapabilityFlag	getCapabilities () const override

char *	getClipboard (bool selection) const override

void	putClipboard (const char *buffer, bool selection) const override

GHOST_TSuccess	hasClipboardImage () const override

uint *	getClipboardImage (int r_width, int r_height) const override

GHOST_TSuccess	putClipboardImage (uint *rgba, int width, int height) const override

GHOST_TSuccess	handleWindowEvent (GHOST_TEventType eventType, GHOST_WindowCocoa *window)

GHOST_TSuccess	handleApplicationBecomeActiveEvent ()

bool	hasDialogWindow ()

void	notifyExternalEventProcessed ()

bool	setConsoleWindowState (GHOST_TConsoleWindowState) override

GHOST_TSuccess	handleTabletEvent (void *eventPtr, short eventType)

bool	handleTabletEvent (void *eventPtr)

GHOST_TSuccess	handleMouseEvent (void *eventPtr)

GHOST_TSuccess	handleKeyEvent (void *eventPtr)

GHOST_TSuccess	showMessageBox (const char title, const char message, const char help_label, const char continue_label, const char *link, GHOST_DialogOptions dialog_options) const override

Public Member Functions inherited from GHOST_System
GHOST_ITimerTask *	installTimer (uint64_t delay, uint64_t interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=nullptr)

GHOST_TSuccess	removeTimer (GHOST_ITimerTask *timerTask)

GHOST_TSuccess	disposeWindow (GHOST_IWindow *window)

bool	validWindow (GHOST_IWindow *window)

GHOST_TSuccess	beginFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window, const bool stereoVisual)

GHOST_TSuccess	updateFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window)

GHOST_TSuccess	endFullScreen ()

bool	getFullScreen ()

bool	useNativePixel ()

void	useWindowFocus (const bool use_focus)

void	setAutoFocus (const bool auto_focus)

void	dispatchEvents ()

GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer)

GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer)

GHOST_TSuccess	getCursorPositionClientRelative (const GHOST_IWindow *window, int32_t &x, int32_t &y) const

GHOST_TSuccess	setCursorPositionClientRelative (GHOST_IWindow *window, int32_t x, int32_t y)

GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKey mask, bool &isDown) const

GHOST_TSuccess	getButtonState (GHOST_TButton mask, bool &isDown) const

void	setMultitouchGestures (const bool use)

virtual void	setTabletAPI (GHOST_TTabletAPI api)

GHOST_TTabletAPI	getTabletAPI ()

GHOST_TSuccess	pushEvent (const GHOST_IEvent *event)

GHOST_TimerManager *	getTimerManager () const

GHOST_EventManager *	getEventManager () const

GHOST_WindowManager *	getWindowManager () const

virtual void	initDebug (GHOST_Debug debug)

virtual bool	isDebugEnabled ()

Protected Member Functions
GHOST_TSuccess	init () override

GHOST_TSuccess	setMouseCursorPosition (int32_t x, int32_t y)

Protected Member Functions inherited from GHOST_System
	GHOST_System ()

virtual	~GHOST_System ()

virtual GHOST_TSuccess	exit ()

GHOST_TSuccess	createFullScreenWindow (GHOST_Window **window, const GHOST_DisplaySetting &settings, const bool stereoVisual)

Protected Member Functions inherited from GHOST_ISystem
	GHOST_ISystem ()

virtual	~GHOST_ISystem ()

Protected Attributes
bool	m_outsideLoopEventProcessed

bool	m_needDelayedApplicationBecomeActiveEventProcessing

uint32_t	m_modifierMask

bool	m_ignoreWindowSizedMessages

bool	m_ignoreMomentumScroll

bool	m_multiTouchScroll

double	m_last_warp_timestamp

Protected Attributes inherited from GHOST_System
GHOST_DisplayManager *	m_displayManager

GHOST_TimerManager *	m_timerManager

GHOST_WindowManager *	m_windowManager

GHOST_EventManager *	m_eventManager

GHOST_DisplaySetting	m_preFullScreenSetting

bool	m_multitouchGestures

GHOST_TTabletAPI	m_tabletAPI

bool	m_is_debug_enabled

Additional Inherited Members
Static Public Member Functions inherited from GHOST_ISystem
static GHOST_TSuccess	createSystem (bool verbose, bool background)

static GHOST_TSuccess	createSystemBackground ()

static GHOST_TSuccess	disposeSystem ()

static GHOST_ISystem *	getSystem ()

static const char *	getSystemBackend ()

static GHOST_TBacktraceFn	getBacktraceFn ()

static void	setBacktraceFn (GHOST_TBacktraceFn backtrace_fn)

Public Attributes inherited from GHOST_System
bool	m_nativePixel

bool	m_windowFocus

bool	m_autoFocus

Static Protected Attributes inherited from GHOST_ISystem
static GHOST_ISystem *	m_system = nullptr

static const char *	m_system_backend_id = nullptr

static GHOST_TBacktraceFn	m_backtrace_fn = nullptr

Detailed Description

Definition at line 25 of file GHOST_SystemCocoa.hh.

Constructor & Destructor Documentation

◆ GHOST_SystemCocoa()

GHOST_SystemCocoa::GHOST_SystemCocoa ( )

Constructor.

Definition at line 539 of file GHOST_SystemCocoa.mm.

References GHOST_ASSERT.

◆ ~GHOST_SystemCocoa()

GHOST_SystemCocoa::~GHOST_SystemCocoa ( )

override

Destructor.

Definition at line 554 of file GHOST_SystemCocoa.mm.

Member Function Documentation

◆ createOffscreenContext()

GHOST_IContext * GHOST_SystemCocoa::createOffscreenContext ( GHOST_GPUSettings gpuSettings )

overridevirtual

Create a new off-screen context. Never explicitly delete the context, use disposeContext() instead.

Returns: The new context (or 0 if creation failed).

Implements GHOST_System.

Definition at line 788 of file GHOST_SystemCocoa.mm.

References GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, GHOST_gpuDebugContext, and GHOST_GPUSettings::preferred_device.

◆ createWindow()

GHOST_IWindow * GHOST_SystemCocoa::createWindow	(	const char *	title,
		int32_t	left,
		int32_t	top,
		uint32_t	width,
		uint32_t	height,
		GHOST_TWindowState	state,
		GHOST_GPUSettings	gpuSettings,
		const bool	exclusive = false,
		const bool	is_dialog = false,
		const GHOST_IWindow *	parentWindow = nullptr )

overridevirtual

Create a new window. The new window is added to the list of windows managed. Never explicitly delete the window, use disposeWindow() instead.

Parameters

title	The name of the window. (displayed in the title bar of the window if the OS supports it).
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state of the window when opened.
gpuSettings	Misc GPU settings.
exclusive	Use to show the window on top and ignore others (used full-screen).
parentWindow	Parent (embedder) window.

Returns: The new window (or 0 if creation failed).

Implements GHOST_ISystem.

Definition at line 723 of file GHOST_SystemCocoa.mm.

References GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, GHOST_IWindow::getValid(), GHOST_ASSERT, GHOST_gpuDebugContext, GHOST_gpuStereoVisual, GHOST_kEventWindowActivate, GHOST_kEventWindowSize, GHOST_PRINT, left, GHOST_GPUSettings::preferred_device, pushEvent, and state.

◆ disposeContext()

GHOST_TSuccess GHOST_SystemCocoa::disposeContext ( GHOST_IContext * context )

overridevirtual

Dispose of a context.

Parameters

context Pointer to the context to be disposed.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 828 of file GHOST_SystemCocoa.mm.

References GHOST_kSuccess.

◆ getAllDisplayDimensions()

void GHOST_SystemCocoa::getAllDisplayDimensions	(	uint32_t &	width,
		uint32_t &	height ) const

overridevirtual

Returns the combine dimensions of all monitors.

Returns: The dimension of the workspace.

Implements GHOST_ISystem.

Definition at line 717 of file GHOST_SystemCocoa.mm.

◆ getButtons()

GHOST_TSuccess GHOST_SystemCocoa::getButtons ( GHOST_Buttons & buttons ) const

overridevirtual

Returns the state of the mouse buttons (outside the message queue).

Parameters

buttons The state of the buttons.

Returns: Indication of success.

Implements GHOST_System.

Definition at line 992 of file GHOST_SystemCocoa.mm.

References GHOST_Buttons::clear(), GHOST_kButtonMaskButton4, GHOST_kButtonMaskButton5, GHOST_kButtonMaskLeft, GHOST_kButtonMaskMiddle, GHOST_kButtonMaskRight, GHOST_kSuccess, and GHOST_Buttons::set().

◆ getCapabilities()

GHOST_TCapabilityFlag GHOST_SystemCocoa::getCapabilities ( ) const

overridevirtual

Return features supported by the system back-end.

The resulting value doesn't change at run-time.

Implements GHOST_ISystem.

Definition at line 1005 of file GHOST_SystemCocoa.mm.

References GHOST_CAPABILITY_FLAG_ALL, and GHOST_kCapabilityPrimaryClipboard.

◆ getClipboard()

char * GHOST_SystemCocoa::getClipboard ( bool selection ) const

overridevirtual

Returns Clipboard data

Parameters

selection Indicate which buffer to return.

Returns: Returns the selected buffer

Implements GHOST_System.

Definition at line 1998 of file GHOST_SystemCocoa.mm.

◆ getClipboardImage()

uint * GHOST_SystemCocoa::getClipboardImage	(	int *	r_width,
		int *	r_height ) const

overridevirtual

Get image data from the Clipboard

Parameters

r_width	the returned image width in pixels.
r_height	the returned image height in pixels.

Returns: pointer uint array in RGBA byte order. Caller must free.

Reimplemented from GHOST_System.

Definition at line 2089 of file GHOST_SystemCocoa.mm.

References ImBuf::byte_buffer, ImBufByteBuffer::data, getNSImagePixelSize(), IMB_freeImBuf(), NSImageToImBuf(), and NSPasteboardGetImageFile().

◆ getCursorPosition()

GHOST_TSuccess GHOST_SystemCocoa::getCursorPosition	(	int32_t &	x,
		int32_t &	y ) const

overridevirtual

Returns the current location of the cursor (location in screen coordinates)

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Note: returns coordinates in Cocoa screen coordinates.

Implements GHOST_ISystem.

Definition at line 855 of file GHOST_SystemCocoa.mm.

References GHOST_kSuccess.

Referenced by GHOST_WindowCocoa::setWindowCursorGrab().

◆ getMainDisplayDimensions()

void GHOST_SystemCocoa::getMainDisplayDimensions	(	uint32_t &	width,
		uint32_t &	height ) const

overridevirtual

Returns the dimensions of the main display on this system.

Returns: The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 700 of file GHOST_SystemCocoa.mm.

◆ getMilliSeconds()

uint64_t GHOST_SystemCocoa::getMilliSeconds ( ) const

overridevirtual

Returns the system time. Returns the number of milliseconds since the start of the system process. Based on ANSI clock() routine.

Returns: The number of milliseconds.

Implements GHOST_ISystem.

Definition at line 685 of file GHOST_SystemCocoa.mm.

Referenced by DeviceEvent().

◆ getModifierKeys()

GHOST_TSuccess GHOST_SystemCocoa::getModifierKeys ( GHOST_ModifierKeys & keys ) const

overridevirtual

Returns the state of all modifier keys.

Parameters

keys	The state of all modifier keys (true == pressed).

Returns: Indication of success.

Implements GHOST_System.

Definition at line 980 of file GHOST_SystemCocoa.mm.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftOS, GHOST_kModifierKeyLeftShift, GHOST_kSuccess, GHOST_ModifierKeys::set(), and true.

◆ getNumDisplays()

uint8_t GHOST_SystemCocoa::getNumDisplays ( ) const

overridevirtual

Returns the number of displays on this system.

Returns: The number of displays.

Implements GHOST_ISystem.

Definition at line 691 of file GHOST_SystemCocoa.mm.

◆ getPixelAtCursor()

GHOST_TSuccess GHOST_SystemCocoa::getPixelAtCursor ( float r_color[3] ) const

overridevirtual

Get the color of the pixel at the current mouse cursor location

Parameters

r_color returned sRGB float colors

Returns: Success value (true == successful and supported by platform)

Reimplemented from GHOST_System.

Definition at line 889 of file GHOST_SystemCocoa.mm.

References GHOST_kFailure, GHOST_kSuccess, green, and red.

◆ getWindowUnderCursor()

GHOST_IWindow * GHOST_SystemCocoa::getWindowUnderCursor	(	int32_t	x,
		int32_t	y )

overridevirtual

Get the Window under the cursor.

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: The window under the cursor or nullptr if none.

Reimplemented from GHOST_System.

Definition at line 835 of file GHOST_SystemCocoa.mm.

◆ handleApplicationBecomeActiveEvent()

GHOST_TSuccess GHOST_SystemCocoa::handleApplicationBecomeActiveEvent ( )

Handles the Cocoa event telling the application has become active (again)

Returns: Indication whether the event was handled.

Definition at line 1108 of file GHOST_SystemCocoa.mm.

References GHOST_kEventKeyDown, GHOST_kEventKeyUp, GHOST_kFailure, GHOST_kKeyLeftAlt, GHOST_kKeyLeftControl, GHOST_kKeyLeftOS, GHOST_kKeyLeftShift, GHOST_kSuccess, GHOST_WindowCocoa::isDialog(), and pushEvent.

◆ handleDraggingEvent()

GHOST_TSuccess GHOST_SystemCocoa::handleDraggingEvent	(	GHOST_TEventType	eventType,
		GHOST_TDragnDropTypes	draggedObjectType,
		GHOST_WindowCocoa *	window,
		int	mouseX,
		int	mouseY,
		void *	data )

Handles a drag & drop destination event. Called by GHOST_WindowCocoa window subclass.

Parameters

eventType	The type of drag & drop event.
draggedObjectType	The type object concerned. (currently array of file names, string, TIFF image).
mouseX	x mouse coordinate (in cocoa base window coordinates).
mouseY	y mouse coordinate.
window	The window on which the event occurred.

Returns: Indication whether the event was handled.

Definition at line 1311 of file GHOST_SystemCocoa.mm.

References GHOST_WindowCocoa::clientToScreenIntern(), GHOST_TStringArray::count, data, free(), GHOST_kDragnDropTypeBitmap, GHOST_kDragnDropTypeFilenames, GHOST_kDragnDropTypeString, GHOST_kEventDraggingDropDone, GHOST_kEventDraggingEntered, GHOST_kEventDraggingExited, GHOST_kEventDraggingUpdated, GHOST_kFailure, GHOST_kSuccess, NSImageToImBuf(), pushEvent, and GHOST_TStringArray::strings.

◆ handleKeyEvent()

GHOST_TSuccess GHOST_SystemCocoa::handleKeyEvent ( void * eventPtr )

Handles a key event.

Parameters

eventPtr An #NSEvent pointer (cast to void * to enable compilation in standard C++).

Returns: Indication whether the event was handled.

Definition at line 1854 of file GHOST_SystemCocoa.mm.

References convertKey(), GHOST_kEventKeyDown, GHOST_kEventKeyUp, GHOST_kFailure, GHOST_kKeyDownArrow, GHOST_kKeyF1, GHOST_kKeyF20, GHOST_kKeyLeftAlt, GHOST_kKeyLeftArrow, GHOST_kKeyLeftControl, GHOST_kKeyLeftOS, GHOST_kKeyLeftShift, GHOST_kKeyQ, GHOST_kSuccess, printf, and pushEvent.

◆ handleMouseEvent()

GHOST_TSuccess GHOST_SystemCocoa::handleMouseEvent ( void * eventPtr )

Handles a mouse event.

Parameters

eventPtr An #NSEvent pointer (cast to void * to enable compilation in standard C++).

Returns: Indication whether the event was handled.

Definition at line 1553 of file GHOST_SystemCocoa.mm.

References bounds(), GHOST_WindowCocoa::clientToScreenIntern(), convertButton(), GHOST_WindowCocoa::getClientBounds(), GHOST_WindowCocoa::GetCocoaTabletData(), GHOST_Window::getCursorGrabAccum(), GHOST_Window::getCursorGrabAxis(), GHOST_Window::getCursorGrabBounds(), GHOST_Window::getCursorGrabInitPos(), GHOST_Window::getCursorGrabMode(), GHOST_Window::getCursorGrabModeIsWarp(), GHOST_WindowCocoa::getOSWindow(), GHOST_kButtonMaskLeft, GHOST_kButtonMaskRight, GHOST_kEventButtonDown, GHOST_kEventButtonUp, GHOST_kEventCursorMove, GHOST_kFailure, GHOST_kGrabDisable, GHOST_kGrabHide, GHOST_kGrabWrap, GHOST_kSuccess, GHOST_kTrackpadEventMagnify, GHOST_kTrackpadEventRotate, GHOST_kTrackpadEventScroll, GHOST_kTrackpadEventSmartMagnify, GHOST_Rect::m_b, GHOST_Rect::m_l, GHOST_Rect::m_r, GHOST_Rect::m_t, pushEvent, GHOST_WindowCocoa::screenToClient(), GHOST_WindowCocoa::screenToClientIntern(), GHOST_Window::setCursorGrabAccum(), GHOST_Rect::wrapPoint(), x, and y.

◆ handleOpenDocumentRequest()

bool GHOST_SystemCocoa::handleOpenDocumentRequest ( void * filepathStr )

Handle Cocoa openFile event Display confirmation request panel if changes performed since last save

Definition at line 1436 of file GHOST_SystemCocoa.mm.

References count, GHOST_Window::getCursorGrabModeIsWarp(), GHOST_kEventOpenMainFile, GHOST_kFailure, and pushEvent.

◆ handleQuitRequest()

void GHOST_SystemCocoa::handleQuitRequest ( )

Handle User request to quit, from Menu bar Quit, and Command+Q Display alert panel if changes performed since last save

Definition at line 1422 of file GHOST_SystemCocoa.mm.

References GHOST_Window::getCursorGrabModeIsWarp(), GHOST_kEventQuitRequest, and pushEvent.

◆ handleTabletEvent() [1/2]

bool GHOST_SystemCocoa::handleTabletEvent ( void * eventPtr )

Definition at line 1536 of file GHOST_SystemCocoa.mm.

◆ handleTabletEvent() [2/2]

GHOST_TSuccess GHOST_SystemCocoa::handleTabletEvent	(	void *	eventPtr,
		short	eventType )

Handles a tablet event.

Parameters

eventPtr	An #NSEvent pointer (cast to void* to enable compilation in standard C++).
eventType	The type of the event. It needs to be passed separately as it can be either directly in the event type, or as a sub-type if combined with a mouse button event.

Returns: Indication whether the event was handled.

Definition at line 1481 of file GHOST_SystemCocoa.mm.

References GHOST_TabletData::Active, FALSE, GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, GHOST_kTabletModeEraser, GHOST_kTabletModeNone, GHOST_kTabletModeStylus, GHOST_TABLET_DATA_NONE, GHOST_TabletData::Pressure, GHOST_TabletData::Xtilt, and GHOST_TabletData::Ytilt.

◆ handleWindowEvent()

GHOST_TSuccess GHOST_SystemCocoa::handleWindowEvent	(	GHOST_TEventType	eventType,
		GHOST_WindowCocoa *	window )

Handles a window event. Called by GHOST_WindowCocoa window delegate

Parameters

eventType	The type of window event.
window	The window on which the event occurred.

Returns: Indication whether the event was handled.

Definition at line 1191 of file GHOST_SystemCocoa.mm.

References GHOST_Window::getCursorShape(), GHOST_Window::getCursorVisibility(), GHOST_kButtonMaskLeft, GHOST_kEventButtonUp, GHOST_kEventNativeResolutionChange, GHOST_kEventWindowActivate, GHOST_kEventWindowClose, GHOST_kEventWindowDeactivate, GHOST_kEventWindowMove, GHOST_kEventWindowSize, GHOST_kEventWindowUpdate, GHOST_kFailure, GHOST_kSuccess, GHOST_TABLET_DATA_NONE, GHOST_WindowCocoa::loadCursor(), pushEvent, GHOST_WindowCocoa::setNativePixelSize(), and GHOST_Window::updateDrawingContext().

◆ hasClipboardImage()

GHOST_TSuccess GHOST_SystemCocoa::hasClipboardImage ( void ) const

overridevirtual

Returns GHOST_kSuccess if the clipboard contains an image.

Reimplemented from GHOST_System.

Definition at line 2065 of file GHOST_SystemCocoa.mm.

References GHOST_kFailure, GHOST_kSuccess, and NSPasteboardGetImageFile().

◆ hasDialogWindow()

bool GHOST_SystemCocoa::hasDialogWindow ( )

Returns: True if any dialog window is open.

Definition at line 1174 of file GHOST_SystemCocoa.mm.

References GHOST_WindowCocoa::isDialog().

◆ init()

GHOST_TSuccess GHOST_SystemCocoa::init ( )

overrideprotectedvirtual

Initializes the system. For now, it just registers the window class (WNDCLASS).

Returns: A success value.

Reimplemented from GHOST_System.

Definition at line 570 of file GHOST_SystemCocoa.mm.

References GHOST_System::init().

◆ notifyExternalEventProcessed()

void GHOST_SystemCocoa::notifyExternalEventProcessed ( )

External objects should call this when they send an event outside processEvents.

Definition at line 1185 of file GHOST_SystemCocoa.mm.

Referenced by DeviceEvent().

◆ processEvents()

bool GHOST_SystemCocoa::processEvents ( bool waitForEvent )

overridevirtual

Gets events from the system and stores them in the queue.

Parameters

waitForEvent Flag to wait for an event (or return immediately).

Returns: Indication of the presence of events.

The event queue polling function

Implements GHOST_ISystem.

Definition at line 1020 of file GHOST_SystemCocoa.mm.

References double(), GHOST_TimerManager::fireTimers(), GHOST_kFireTimeNever, next, and GHOST_TimerManager::nextFireTime().

◆ putClipboard()

void GHOST_SystemCocoa::putClipboard	(	const char *	buffer,
		bool	selection ) const

overridevirtual

Puts buffer to system clipboard

Parameters

buffer	The buffer to be copied.
selection	Indicates which buffer to copy too, only used on X11.

Implements GHOST_System.

Definition at line 2026 of file GHOST_SystemCocoa.mm.

◆ putClipboardImage()

GHOST_TSuccess GHOST_SystemCocoa::putClipboardImage	(	uint *	rgba,
		int	width,
		int	height ) const

overridevirtual

Put image data to the Clipboard

Parameters

rgba	uint array in RGBA byte order.
width	the image width in pixels.
height	the image height in pixels.

Reimplemented from GHOST_System.

Definition at line 2137 of file GHOST_SystemCocoa.mm.

References GHOST_kFailure, and GHOST_kSuccess.

◆ setConsoleWindowState()

bool GHOST_SystemCocoa::setConsoleWindowState ( GHOST_TConsoleWindowState )

inlineoverridevirtual

See also: GHOST_ISystem

Implements GHOST_ISystem.

Definition at line 272 of file GHOST_SystemCocoa.hh.

◆ setCursorPosition()

GHOST_TSuccess GHOST_SystemCocoa::setCursorPosition	(	int32_t	x,
		int32_t	y )

overridevirtual

Updates the location of the cursor (location in screen coordinates).

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Note: expect Cocoa screen coordinates.

Implements GHOST_ISystem.

Definition at line 868 of file GHOST_SystemCocoa.mm.

References GHOST_WindowCocoa::GetCocoaTabletData(), GHOST_kEventCursorMove, GHOST_kFailure, GHOST_kSuccess, and pushEvent.

Referenced by GHOST_WindowCocoa::setWindowCursorGrab().

◆ setMouseCursorPosition()

GHOST_TSuccess GHOST_SystemCocoa::setMouseCursorPosition	(	int32_t	x,
		int32_t	y )

protected

Performs the actual cursor position update (location in screen coordinates).

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Definition at line 947 of file GHOST_SystemCocoa.mm.

References float, GHOST_WindowCocoa::getScreen(), GHOST_kFailure, and GHOST_kSuccess.

◆ showMessageBox()

GHOST_TSuccess GHOST_SystemCocoa::showMessageBox	(	const char *	title,
		const char *	message,
		const char *	help_label,
		const char *	continue_label,
		const char *	link,
		GHOST_DialogOptions	dialog_options ) const

overridevirtual

Show a system message box

Parameters

title	The title of the message box.
message	The message to display.
help_label	Help button label.
continue_label	Continue button label.
link	An optional hyperlink.
dialog_options	Options how to display the message.

Reimplemented from GHOST_System.

Definition at line 2179 of file GHOST_SystemCocoa.mm.

References GHOST_DialogError, GHOST_DialogWarning, and GHOST_kSuccess.

Member Data Documentation

◆ m_ignoreMomentumScroll

bool GHOST_SystemCocoa::m_ignoreMomentumScroll

protected

Temporarily ignore momentum scroll events

Definition at line 349 of file GHOST_SystemCocoa.hh.

◆ m_ignoreWindowSizedMessages

bool GHOST_SystemCocoa::m_ignoreWindowSizedMessages

protected

Ignores window size messages (when window is dragged).

Definition at line 346 of file GHOST_SystemCocoa.hh.

◆ m_last_warp_timestamp

double GHOST_SystemCocoa::m_last_warp_timestamp

protected

To prevent multiple warp, we store the time of the last warp event and ignore mouse moved events generated before that.

Definition at line 354 of file GHOST_SystemCocoa.hh.

◆ m_modifierMask

uint32_t GHOST_SystemCocoa::m_modifierMask

protected

State of the modifiers.

Definition at line 343 of file GHOST_SystemCocoa.hh.

◆ m_multiTouchScroll

bool GHOST_SystemCocoa::m_multiTouchScroll

protected

Is the scroll wheel event generated by a multi-touch trackpad or mouse?

Definition at line 351 of file GHOST_SystemCocoa.hh.

◆ m_needDelayedApplicationBecomeActiveEventProcessing

bool GHOST_SystemCocoa::m_needDelayedApplicationBecomeActiveEventProcessing

protected

Raised window is not yet known by the window manager, so delay application become active event handling

Definition at line 340 of file GHOST_SystemCocoa.hh.

◆ m_outsideLoopEventProcessed

bool GHOST_SystemCocoa::m_outsideLoopEventProcessed

protected

Event has been processed directly by Cocoa (or NDOF manager) and has sent a ghost event to be dispatched

Definition at line 336 of file GHOST_SystemCocoa.hh.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_SystemCocoa()

◆ ~GHOST_SystemCocoa()

Member Function Documentation

◆ createOffscreenContext()

◆ createWindow()

◆ disposeContext()

◆ getAllDisplayDimensions()

◆ getButtons()

◆ getCapabilities()

◆ getClipboard()

◆ getClipboardImage()

◆ getCursorPosition()

◆ getMainDisplayDimensions()

◆ getMilliSeconds()

◆ getModifierKeys()

◆ getNumDisplays()

◆ getPixelAtCursor()

◆ getWindowUnderCursor()

◆ handleApplicationBecomeActiveEvent()

◆ handleDraggingEvent()

◆ handleKeyEvent()

◆ handleMouseEvent()

◆ handleOpenDocumentRequest()

◆ handleQuitRequest()

◆ handleTabletEvent() [1/2]

◆ handleTabletEvent() [2/2]

◆ handleWindowEvent()

◆ hasClipboardImage()

◆ hasDialogWindow()

◆ init()

◆ notifyExternalEventProcessed()

◆ processEvents()

◆ putClipboard()

◆ putClipboardImage()

◆ setConsoleWindowState()

◆ setCursorPosition()

◆ setMouseCursorPosition()

◆ showMessageBox()

Member Data Documentation

◆ m_ignoreMomentumScroll

◆ m_ignoreWindowSizedMessages

◆ m_last_warp_timestamp

◆ m_modifierMask

◆ m_multiTouchScroll

◆ m_needDelayedApplicationBecomeActiveEventProcessing

◆ m_outsideLoopEventProcessed