SCExaminerHandler

Inherits From:
SCEventHandler : NSObject

Conforms To:
NSCoding

Declared In:
Sc21/SCExaminerHandler.h

Class Description

SCExaminerHandler allows you to inspect the scene by rotating, panning, and zooming in and out.

Note that the mouse + modifier key combinations are most easily configured through the associated InterfaceBuilder inspector.


Method Types

Mouse- and keybindings for rotate mode
- setRotateButton:modifier:
- getRotateButton:modifier:
- disableRotateButton
- rotateButtonIsEnabled
Mouse- and keybindings for pan mode
- setPanButton:modifier:
- getPanButton:modifier:
- disablePanButton
- panButtonIsEnabled
Mouse- and keybindings for zoom mode
- setZoomButton:modifier:
- getZoomButton:modifier:
- disableZoomButton
- zoomButtonIsEnabled
Controlling "spin" animation
- setSpinEnabled:
- spinEnabled
Controlling the mouse wheel
- setScrollWheelZoomEnabled:
- scrollWheelZoomEnabled

Instance Methods

disablePanButton

- (void)disablePanButton

Disable panning by clicking and dragging.


disableRotateButton

- (void)disableRotateButton

Disable rotating by clicking and dragging.


disableZoomButton

- (void)disableZoomButton

Disable zooming by clicking and dragging.

Note that this does not affect zooming via the mouse wheel.


getPanButton:modifier:

- (void)getPanButton:(int*)buttonNr modifier:(unsigned int*)modifierFlags

Get the mouse button and modifier key(s) used for panning.


getRotateButton:modifier:

- (void)getRotateButton:(int*)buttonNr modifier:(unsigned int*)modifierFlags

Get the mouse button and modifier key(s) used for rotating.


getZoomButton:modifier:

- (void)getZoomButton:(int*)buttonNr modifier:(unsigned int*)modifierFlags

Get the mouse button and modifier key(s) used for zooming.


panButtonIsEnabled

- (BOOL)panButtonIsEnabled

Returns YES if panning by clicking and dragging is enabled.


rotateButtonIsEnabled

- (BOOL)rotateButtonIsEnabled

Returns YES if rotating by clicking and dragging is enabled.


scrollWheelZoomEnabled

- (BOOL)scrollWheelZoomEnabled

Returns YES if the mouse wheel can be used for zooming, and NO otherwise.

Note that this only reports whether Sc21 is set up to use the mouse wheel. You cannot use this method to check if a mouse wheel is present at runtime or not.


setPanButton:modifier:

- (void)setPanButton:(int)buttonNr modifier:(unsigned int)modifierFlags

Set the mouse button and modifier key(s) used for panning.


setRotateButton:modifier:

- (void)setRotateButton:(int)buttonNr modifier:(unsigned int)modifierFlags

Set the mouse button and modifier key(s) used for rotating.


setScrollWheelZoomEnabled:

- (void)setScrollWheelZoomEnabled:(BOOL)enabled

Pass YES to enable scrolling by using the mouse wheel (if present).


setSpinEnabled:

- (void)setSpinEnabled:(BOOL)enabled

Pass YES to enable "spinning" (i.e. starting a continuous animation by dragging and then releasing).


setZoomButton:modifier:

- (void)setZoomButton:(int)buttonNr modifier:(unsigned int)modifierFlags

Set the mouse button and modifier key(s) used for zooming.


spinEnabled

- (BOOL)spinEnabled

Returns YES if spinning is enabled, and NO otherwise.


zoomButtonIsEnabled

- (BOOL)zoomButtonIsEnabled

Returns YES if zooming by clicking and dragging is enabled.

Note that this does not affect zooming via the mouse wheel.


Sc21 version 1.0 © 2003-2004 Systems in Motion AS.