/** * @file llviewerinput.cpp * @brief LLViewerInput class implementation * * $LicenseInfo:firstyear=2005&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2010, Linden Research, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; * version 2.1 of the License only. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA * $/LicenseInfo$ */ #include "llviewerprecompiledheaders.h" #include "llviewerinput.h" #include "llappviewer.h" #include "llfloaterreg.h" #include "llmath.h" #include "llagent.h" #include "llagentcamera.h" #include "llfloaterimnearbychat.h" #include "llfocusmgr.h" #include "llkeybind.h" // LLKeyData #include "llmorphview.h" #include "llmoveview.h" #include "lltoolfocus.h" #include "lltoolpie.h" #include "llviewercontrol.h" #include "llviewerwindow.h" #include "llvoavatarself.h" #include "llfloatercamera.h" #include "llinitparam.h" #include "llselectmgr.h" // // Constants // const F32 FLY_TIME = 0.5f; const F32 FLY_FRAMES = 4; const F32 NUDGE_TIME = 0.25f; // in seconds const S32 NUDGE_FRAMES = 2; const F32 ORBIT_NUDGE_RATE = 0.05f; // fraction of normal speed const LLKeyData agent_control_lbutton(CLICK_LEFT, KEY_NONE, MASK_NONE, true); struct LLKeyboardActionRegistry : public LLRegistrySingleton, LLKeyboardActionRegistry> { LLSINGLETON_EMPTY_CTOR(LLKeyboardActionRegistry); }; LLViewerInput gViewerInput; bool agent_jump( EKeystate s ) { static BOOL first_fly_attempt(TRUE); if (KEYSTATE_UP == s) { first_fly_attempt = TRUE; return true; } F32 time = gKeyboard->getCurKeyElapsedTime(); S32 frame_count = ll_round(gKeyboard->getCurKeyElapsedFrameCount()); if( time < FLY_TIME || frame_count <= FLY_FRAMES || gAgent.upGrabbed() || !gSavedSettings.getBOOL("AutomaticFly")) { gAgent.moveUp(1); } else { gAgent.setFlying(TRUE, first_fly_attempt); first_fly_attempt = FALSE; gAgent.moveUp(1); } return true; } bool agent_push_down( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgent.moveUp(-1); return true; } static void agent_check_temporary_run(LLAgent::EDoubleTapRunMode mode) { if (gAgent.mDoubleTapRunMode == mode && gAgent.getRunning() && !gAgent.getAlwaysRun()) { // Turn off temporary running. gAgent.clearRunning(); gAgent.sendWalkRun(gAgent.getRunning()); } } static void agent_handle_doubletap_run(EKeystate s, LLAgent::EDoubleTapRunMode mode) { if (KEYSTATE_UP == s) { // Note: in case shift is already released, slide left/right run // will be released in agent_turn_left()/agent_turn_right() agent_check_temporary_run(mode); } else if (gSavedSettings.getBOOL("AllowTapTapHoldRun") && KEYSTATE_DOWN == s && !gAgent.getRunning()) { if (gAgent.mDoubleTapRunMode == mode && gAgent.mDoubleTapRunTimer.getElapsedTimeF32() < NUDGE_TIME) { // Same walk-key was pushed again quickly; this is a // double-tap so engage temporary running. gAgent.setRunning(); gAgent.sendWalkRun(gAgent.getRunning()); } // Pressing any walk-key resets the double-tap timer gAgent.mDoubleTapRunTimer.reset(); gAgent.mDoubleTapRunMode = mode; } } static void agent_push_forwardbackward( EKeystate s, S32 direction, LLAgent::EDoubleTapRunMode mode ) { agent_handle_doubletap_run(s, mode); if (KEYSTATE_UP == s) return; F32 time = gKeyboard->getCurKeyElapsedTime(); S32 frame_count = ll_round(gKeyboard->getCurKeyElapsedFrameCount()); if( time < NUDGE_TIME || frame_count <= NUDGE_FRAMES) { gAgent.moveAtNudge(direction); } else { gAgent.moveAt(direction); } } bool camera_move_forward( EKeystate s ); bool agent_push_forward( EKeystate s ) { if(gAgent.isMovementLocked()) return true; //in free camera control mode we need to intercept keyboard events for avatar movements if (LLFloaterCamera::inFreeCameraMode()) { camera_move_forward(s); } else { agent_push_forwardbackward(s, 1, LLAgent::DOUBLETAP_FORWARD); } return true; } bool camera_move_backward( EKeystate s ); bool agent_push_backward( EKeystate s ) { if(gAgent.isMovementLocked()) return true; //in free camera control mode we need to intercept keyboard events for avatar movements if (LLFloaterCamera::inFreeCameraMode()) { camera_move_backward(s); } else if (!gAgent.backwardGrabbed() && gAgentAvatarp->isSitting() && gSavedSettings.getBOOL("LeaveMouselook")) { gAgentCamera.changeCameraToThirdPerson(); } else { agent_push_forwardbackward(s, -1, LLAgent::DOUBLETAP_BACKWARD); } return true; } static void agent_slide_leftright( EKeystate s, S32 direction, LLAgent::EDoubleTapRunMode mode ) { agent_handle_doubletap_run(s, mode); if( KEYSTATE_UP == s ) return; F32 time = gKeyboard->getCurKeyElapsedTime(); S32 frame_count = ll_round(gKeyboard->getCurKeyElapsedFrameCount()); if( time < NUDGE_TIME || frame_count <= NUDGE_FRAMES) { gAgent.moveLeftNudge(direction); } else { gAgent.moveLeft(direction); } } bool agent_slide_left( EKeystate s ) { if(gAgent.isMovementLocked()) return true; agent_slide_leftright(s, 1, LLAgent::DOUBLETAP_SLIDELEFT); return true; } bool agent_slide_right( EKeystate s ) { if(gAgent.isMovementLocked()) return true; agent_slide_leftright(s, -1, LLAgent::DOUBLETAP_SLIDERIGHT); return true; } bool camera_spin_around_cw( EKeystate s ); bool agent_turn_left(EKeystate s) { //in free camera control mode we need to intercept keyboard events for avatar movements if (LLFloaterCamera::inFreeCameraMode()) { camera_spin_around_cw(s); return true; } if(gAgent.isMovementLocked()) return false; if (LLToolCamera::getInstance()->mouseSteerMode()) { agent_slide_left(s); } else { if (KEYSTATE_UP == s) { // Check temporary running. In case user released 'left' key with shift already released. agent_check_temporary_run(LLAgent::DOUBLETAP_SLIDELEFT); return true; } F32 time = gKeyboard->getCurKeyElapsedTime(); gAgent.moveYaw( LLFloaterMove::getYawRate( time ) ); } return true; } bool camera_spin_around_ccw( EKeystate s ); bool agent_turn_right( EKeystate s ) { //in free camera control mode we need to intercept keyboard events for avatar movements if (LLFloaterCamera::inFreeCameraMode()) { camera_spin_around_ccw(s); return true; } if(gAgent.isMovementLocked()) return false; if (LLToolCamera::getInstance()->mouseSteerMode()) { agent_slide_right(s); } else { if (KEYSTATE_UP == s) { // Check temporary running. In case user released 'right' key with shift already released. agent_check_temporary_run(LLAgent::DOUBLETAP_SLIDERIGHT); return true; } F32 time = gKeyboard->getCurKeyElapsedTime(); gAgent.moveYaw( -LLFloaterMove::getYawRate( time ) ); } return true; } bool agent_look_up( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgent.movePitch(-1); //gAgent.rotate(-2.f * DEG_TO_RAD, gAgent.getFrame().getLeftAxis() ); return true; } bool agent_look_down( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgent.movePitch(1); //gAgent.rotate(2.f * DEG_TO_RAD, gAgent.getFrame().getLeftAxis() ); return true; } bool agent_toggle_fly( EKeystate s ) { // Only catch the edge if (KEYSTATE_DOWN == s ) { LLAgent::toggleFlying(); } return true; } F32 get_orbit_rate() { F32 time = gKeyboard->getCurKeyElapsedTime(); if( time < NUDGE_TIME ) { F32 rate = ORBIT_NUDGE_RATE + time * (1 - ORBIT_NUDGE_RATE)/ NUDGE_TIME; //LL_INFOS() << rate << LL_ENDL; return rate; } else { return 1; } } bool camera_spin_around_ccw( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitLeftKey( get_orbit_rate() ); return true; } bool camera_spin_around_cw( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitRightKey( get_orbit_rate() ); return true; } bool camera_spin_around_ccw_sitting( EKeystate s ) { if( KEYSTATE_UP == s && gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_SLIDERIGHT ) return true; if (gAgent.rotateGrabbed() || gAgentCamera.sitCameraEnabled() || gAgent.getRunning()) { //send keystrokes, but do not change camera agent_turn_right(s); } else { //change camera but do not send keystrokes gAgentCamera.unlockView(); gAgentCamera.setOrbitLeftKey( get_orbit_rate() ); } return true; } bool camera_spin_around_cw_sitting( EKeystate s ) { if( KEYSTATE_UP == s && gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_SLIDELEFT ) return true; if (gAgent.rotateGrabbed() || gAgentCamera.sitCameraEnabled() || gAgent.getRunning()) { //send keystrokes, but do not change camera agent_turn_left(s); } else { //change camera but do not send keystrokes gAgentCamera.unlockView(); gAgentCamera.setOrbitRightKey( get_orbit_rate() ); } return true; } bool camera_spin_over( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitUpKey( get_orbit_rate() ); return true; } bool camera_spin_under( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitDownKey( get_orbit_rate() ); return true; } bool camera_spin_over_sitting( EKeystate s ) { if( KEYSTATE_UP == s ) return true; if (gAgent.upGrabbed() || gAgentCamera.sitCameraEnabled()) { //send keystrokes, but do not change camera agent_jump(s); } else { //change camera but do not send keystrokes gAgentCamera.setOrbitUpKey( get_orbit_rate() ); } return true; } bool camera_spin_under_sitting( EKeystate s ) { if( KEYSTATE_UP == s ) return true; if (gAgent.downGrabbed() || gAgentCamera.sitCameraEnabled()) { //send keystrokes, but do not change camera agent_push_down(s); } else { //change camera but do not send keystrokes gAgentCamera.setOrbitDownKey( get_orbit_rate() ); } return true; } bool camera_move_forward( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitInKey( get_orbit_rate() ); return true; } bool camera_move_backward( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitOutKey( get_orbit_rate() ); return true; } bool camera_move_forward_sitting( EKeystate s ) { if( KEYSTATE_UP == s && gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_FORWARD ) return true; if (gAgent.forwardGrabbed() || gAgentCamera.sitCameraEnabled() || (gAgent.getRunning() && !gAgent.getAlwaysRun())) { agent_push_forward(s); } else { gAgentCamera.setOrbitInKey( get_orbit_rate() ); } return true; } bool camera_move_backward_sitting( EKeystate s ) { if( KEYSTATE_UP == s && gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_BACKWARD ) return true; if (gAgent.backwardGrabbed() || gAgentCamera.sitCameraEnabled() || (gAgent.getRunning() && !gAgent.getAlwaysRun())) { agent_push_backward(s); } else { gAgentCamera.setOrbitOutKey( get_orbit_rate() ); } return true; } bool camera_pan_up( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanUpKey( get_orbit_rate() ); return true; } bool camera_pan_down( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanDownKey( get_orbit_rate() ); return true; } bool camera_pan_left( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanLeftKey( get_orbit_rate() ); return true; } bool camera_pan_right( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanRightKey( get_orbit_rate() ); return true; } bool camera_pan_in( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanInKey( get_orbit_rate() ); return true; } bool camera_pan_out( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setPanOutKey( get_orbit_rate() ); return true; } bool camera_move_forward_fast( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitInKey(2.5f); return true; } bool camera_move_backward_fast( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gAgentCamera.unlockView(); gAgentCamera.setOrbitOutKey(2.5f); return true; } bool edit_avatar_spin_ccw( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitLeftKey( get_orbit_rate() ); //gMorphView->orbitLeft( get_orbit_rate() ); return true; } bool edit_avatar_spin_cw( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitRightKey( get_orbit_rate() ); //gMorphView->orbitRight( get_orbit_rate() ); return true; } bool edit_avatar_spin_over( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitUpKey( get_orbit_rate() ); //gMorphView->orbitUp( get_orbit_rate() ); return true; } bool edit_avatar_spin_under( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitDownKey( get_orbit_rate() ); //gMorphView->orbitDown( get_orbit_rate() ); return true; } bool edit_avatar_move_forward( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitInKey( get_orbit_rate() ); //gMorphView->orbitIn(); return true; } bool edit_avatar_move_backward( EKeystate s ) { if( KEYSTATE_UP == s ) return true; gMorphView->setCameraDrivenByKeys( TRUE ); gAgentCamera.setOrbitOutKey( get_orbit_rate() ); //gMorphView->orbitOut(); return true; } bool stop_moving( EKeystate s ) { //it's supposed that 'stop moving' key will be held down for some time if( KEYSTATE_UP == s ) return true; // stop agent gAgent.setControlFlags(AGENT_CONTROL_STOP); // cancel autopilot gAgent.stopAutoPilot(); return true; } bool start_chat( EKeystate s ) { if (LLAppViewer::instance()->quitRequested()) { return true; // can't talk, gotta go, kthxbye! } if (KEYSTATE_DOWN != s) return true; // start chat LLFloaterIMNearbyChat::startChat(NULL); return true; } bool start_gesture( EKeystate s ) { LLUICtrl* focus_ctrlp = dynamic_cast(gFocusMgr.getKeyboardFocus()); if (KEYSTATE_UP == s && ! (focus_ctrlp && focus_ctrlp->acceptsTextInput())) { if ((LLFloaterReg::getTypedInstance("nearby_chat"))->getCurrentChat().empty()) { // No existing chat in chat editor, insert '/' LLFloaterIMNearbyChat::startChat("/"); } else { // Don't overwrite existing text in chat editor LLFloaterIMNearbyChat::startChat(NULL); } } return true; } bool run_forward(EKeystate s) { if (KEYSTATE_UP != s) { if (gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_FORWARD) { gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_FORWARD; } if (!gAgent.getRunning()) { gAgent.setRunning(); gAgent.sendWalkRun(true); } } else if(KEYSTATE_UP == s) { if (gAgent.mDoubleTapRunMode == LLAgent::DOUBLETAP_FORWARD) gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_NONE; gAgent.clearRunning(); gAgent.sendWalkRun(false); } agent_push_forward(s); return true; } bool run_backward(EKeystate s) { if (KEYSTATE_UP != s) { if (gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_BACKWARD) { gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_BACKWARD; } if (!gAgent.getRunning()) { gAgent.setRunning(); gAgent.sendWalkRun(true); } } else if (KEYSTATE_UP == s) { if (gAgent.mDoubleTapRunMode == LLAgent::DOUBLETAP_BACKWARD) gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_NONE; gAgent.clearRunning(); gAgent.sendWalkRun(false); } agent_push_backward(s); return true; } bool run_left(EKeystate s) { if (KEYSTATE_UP != s) { if (gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_SLIDELEFT) { gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_SLIDELEFT; } if (!gAgent.getRunning()) { gAgent.setRunning(); gAgent.sendWalkRun(true); } } else if (KEYSTATE_UP == s) { if (gAgent.mDoubleTapRunMode == LLAgent::DOUBLETAP_SLIDELEFT) gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_NONE; gAgent.clearRunning(); gAgent.sendWalkRun(false); } agent_slide_left(s); return true; } bool run_right(EKeystate s) { if (KEYSTATE_UP != s) { if (gAgent.mDoubleTapRunMode != LLAgent::DOUBLETAP_SLIDERIGHT) { gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_SLIDERIGHT; } if (!gAgent.getRunning()) { gAgent.setRunning(); gAgent.sendWalkRun(true); } } else if (KEYSTATE_UP == s) { if (gAgent.mDoubleTapRunMode == LLAgent::DOUBLETAP_SLIDERIGHT) gAgent.mDoubleTapRunMode = LLAgent::DOUBLETAP_NONE; gAgent.clearRunning(); gAgent.sendWalkRun(false); } agent_slide_right(s); return true; } bool toggle_run(EKeystate s) { if (KEYSTATE_DOWN != s) return true; bool run = gAgent.getAlwaysRun(); if (run) { gAgent.clearAlwaysRun(); gAgent.clearRunning(); } else { gAgent.setAlwaysRun(); gAgent.setRunning(); } gAgent.sendWalkRun(!run); return true; } bool toggle_sit(EKeystate s) { if (KEYSTATE_DOWN != s) return true; if (gAgent.isSitting()) { gAgent.standUp(); } else { gAgent.sitDown(); } return true; } bool toggle_pause_media(EKeystate s) // analogue of play/pause button in top bar { if (KEYSTATE_DOWN != s) return true; bool pause = LLViewerMedia::getInstance()->isAnyMediaPlaying(); LLViewerMedia::getInstance()->setAllMediaPaused(pause); return true; } bool toggle_enable_media(EKeystate s) { if (KEYSTATE_DOWN != s) return true; bool pause = LLViewerMedia::getInstance()->isAnyMediaPlaying() || LLViewerMedia::getInstance()->isAnyMediaShowing(); LLViewerMedia::getInstance()->setAllMediaEnabled(!pause); return true; } bool walk_to(EKeystate s) { if (KEYSTATE_DOWN != s) return true; return LLToolPie::getInstance()->walkToClickedLocation(); } bool teleport_to(EKeystate s) { if (KEYSTATE_DOWN != s) return true; return LLToolPie::getInstance()->teleportToClickedLocation(); } bool toggle_voice(EKeystate s) { if (KEYSTATE_DOWN != s) return true; if (!LLAgent::isActionAllowed("speak")) return false; LLVoiceClient::getInstance()->toggleUserPTTState(); return true; } bool voice_follow_key(EKeystate s) { if (KEYSTATE_DOWN == s) { if (!LLAgent::isActionAllowed("speak")) return false; LLVoiceClient::getInstance()->setUserPTTState(true); return true; } else if (KEYSTATE_UP == s && LLVoiceClient::getInstance()->getUserPTTState()) { LLVoiceClient::getInstance()->setUserPTTState(false); return true; } return false; } bool sript_trigger_lbutton(EKeystate s) { // Check for script overriding/expecting left mouse button. // Note that this does not pass event further and depends onto mouselook. // Checks CONTROL_ML_LBUTTON_DOWN_INDEX for mouselook, // CONTROL_LBUTTON_DOWN_INDEX for normal camera if (gAgent.leftButtonGrabbed()) { bool mouselook = gAgentCamera.cameraMouselook(); switch (s) { case KEYSTATE_DOWN: // at the moment sript_trigger_lbutton is only intended for mouselook // but handling other modes just in case if (mouselook) { gAgent.setControlFlags(AGENT_CONTROL_ML_LBUTTON_DOWN); } else { gAgent.setControlFlags(AGENT_CONTROL_LBUTTON_DOWN); } return true; case KEYSTATE_UP: if (mouselook) { gAgent.setControlFlags(AGENT_CONTROL_ML_LBUTTON_UP); } else { gAgent.setControlFlags(AGENT_CONTROL_LBUTTON_UP); } return true; default: break; } } return false; } // Used by scripts, for overriding/handling left mouse button // see mControlsTakenCount bool agent_control_lbutton_handle(EKeystate s) { switch (s) { case KEYSTATE_DOWN: gAgent.setControlFlags(AGENT_CONTROL_LBUTTON_DOWN); break; case KEYSTATE_UP: gAgent.setControlFlags(AGENT_CONTROL_LBUTTON_UP); break; default: break; } return true; } #define REGISTER_KEYBOARD_ACTION(KEY, ACTION) LLREGISTER_STATIC(LLKeyboardActionRegistry, KEY, ACTION); REGISTER_KEYBOARD_ACTION("jump", agent_jump); REGISTER_KEYBOARD_ACTION("push_down", agent_push_down); REGISTER_KEYBOARD_ACTION("push_forward", agent_push_forward); REGISTER_KEYBOARD_ACTION("push_backward", agent_push_backward); REGISTER_KEYBOARD_ACTION("look_up", agent_look_up); REGISTER_KEYBOARD_ACTION("look_down", agent_look_down); REGISTER_KEYBOARD_ACTION("toggle_fly", agent_toggle_fly); REGISTER_KEYBOARD_ACTION("turn_left", agent_turn_left); REGISTER_KEYBOARD_ACTION("turn_right", agent_turn_right); REGISTER_KEYBOARD_ACTION("slide_left", agent_slide_left); REGISTER_KEYBOARD_ACTION("slide_right", agent_slide_right); REGISTER_KEYBOARD_ACTION("spin_around_ccw", camera_spin_around_ccw); REGISTER_KEYBOARD_ACTION("spin_around_cw", camera_spin_around_cw); REGISTER_KEYBOARD_ACTION("spin_around_ccw_sitting", camera_spin_around_ccw_sitting); REGISTER_KEYBOARD_ACTION("spin_around_cw_sitting", camera_spin_around_cw_sitting); REGISTER_KEYBOARD_ACTION("spin_over", camera_spin_over); REGISTER_KEYBOARD_ACTION("spin_under", camera_spin_under); REGISTER_KEYBOARD_ACTION("spin_over_sitting", camera_spin_over_sitting); REGISTER_KEYBOARD_ACTION("spin_under_sitting", camera_spin_under_sitting); REGISTER_KEYBOARD_ACTION("move_forward", camera_move_forward); REGISTER_KEYBOARD_ACTION("move_backward", camera_move_backward); REGISTER_KEYBOARD_ACTION("move_forward_sitting", camera_move_forward_sitting); REGISTER_KEYBOARD_ACTION("move_backward_sitting", camera_move_backward_sitting); REGISTER_KEYBOARD_ACTION("pan_up", camera_pan_up); REGISTER_KEYBOARD_ACTION("pan_down", camera_pan_down); REGISTER_KEYBOARD_ACTION("pan_left", camera_pan_left); REGISTER_KEYBOARD_ACTION("pan_right", camera_pan_right); REGISTER_KEYBOARD_ACTION("pan_in", camera_pan_in); REGISTER_KEYBOARD_ACTION("pan_out", camera_pan_out); REGISTER_KEYBOARD_ACTION("move_forward_fast", camera_move_forward_fast); REGISTER_KEYBOARD_ACTION("move_backward_fast", camera_move_backward_fast); REGISTER_KEYBOARD_ACTION("edit_avatar_spin_ccw", edit_avatar_spin_ccw); REGISTER_KEYBOARD_ACTION("edit_avatar_spin_cw", edit_avatar_spin_cw); REGISTER_KEYBOARD_ACTION("edit_avatar_spin_over", edit_avatar_spin_over); REGISTER_KEYBOARD_ACTION("edit_avatar_spin_under", edit_avatar_spin_under); REGISTER_KEYBOARD_ACTION("edit_avatar_move_forward", edit_avatar_move_forward); REGISTER_KEYBOARD_ACTION("edit_avatar_move_backward", edit_avatar_move_backward); REGISTER_KEYBOARD_ACTION("stop_moving", stop_moving); REGISTER_KEYBOARD_ACTION("start_chat", start_chat); REGISTER_KEYBOARD_ACTION("start_gesture", start_gesture); REGISTER_KEYBOARD_ACTION("run_forward", run_forward); REGISTER_KEYBOARD_ACTION("run_backward", run_backward); REGISTER_KEYBOARD_ACTION("run_left", run_left); REGISTER_KEYBOARD_ACTION("run_right", run_right); REGISTER_KEYBOARD_ACTION("toggle_run", toggle_run); REGISTER_KEYBOARD_ACTION("toggle_sit", toggle_sit); REGISTER_KEYBOARD_ACTION("toggle_pause_media", toggle_pause_media); REGISTER_KEYBOARD_ACTION("toggle_enable_media", toggle_enable_media); REGISTER_KEYBOARD_ACTION("teleport_to", teleport_to); REGISTER_KEYBOARD_ACTION("walk_to", walk_to); REGISTER_KEYBOARD_ACTION("toggle_voice", toggle_voice); REGISTER_KEYBOARD_ACTION("voice_follow_key", voice_follow_key); REGISTER_KEYBOARD_ACTION(script_mouse_handler_name, sript_trigger_lbutton); #undef REGISTER_KEYBOARD_ACTION LLViewerInput::LLViewerInput() { resetBindings(); for (S32 i = 0; i < KEY_COUNT; i++) { mKeyHandledByUI[i] = FALSE; } for (S32 i = 0; i < CLICK_COUNT; i++) { mMouseLevel[i] = MOUSE_STATE_SILENT; } // we want the UI to never see these keys so that they can always control the avatar/camera for(KEY k = KEY_PAD_UP; k <= KEY_PAD_DIVIDE; k++) { mKeysSkippedByUI.insert(k); } } // static BOOL LLViewerInput::modeFromString(const std::string& string, S32 *mode) { if (string == "FIRST_PERSON") { *mode = MODE_FIRST_PERSON; return TRUE; } else if (string == "THIRD_PERSON") { *mode = MODE_THIRD_PERSON; return TRUE; } else if (string == "EDIT_AVATAR") { *mode = MODE_EDIT_AVATAR; return TRUE; } else if (string == "SITTING") { *mode = MODE_SITTING; return TRUE; } else { *mode = MODE_THIRD_PERSON; return FALSE; } } // static BOOL LLViewerInput::mouseFromString(const std::string& string, EMouseClickType *mode) { if (string == "LMB") { *mode = CLICK_LEFT; return TRUE; } else if (string == "Double LMB") { *mode = CLICK_DOUBLELEFT; return TRUE; } else if (string == "MMB") { *mode = CLICK_MIDDLE; return TRUE; } else if (string == "MB4") { *mode = CLICK_BUTTON4; return TRUE; } else if (string == "MB5") { *mode = CLICK_BUTTON5; return TRUE; } else { *mode = CLICK_NONE; return FALSE; } } BOOL LLViewerInput::handleKey(KEY translated_key, MASK translated_mask, BOOL repeated) { // check for re-map EKeyboardMode mode = gViewerInput.getMode(); U32 keyidx = (translated_mask<<16) | translated_key; key_remap_t::iterator iter = mRemapKeys[mode].find(keyidx); if (iter != mRemapKeys[mode].end()) { translated_key = (iter->second) & 0xff; translated_mask = (iter->second)>>16; } // No repeats of F-keys BOOL repeatable_key = (translated_key < KEY_F1 || translated_key > KEY_F12); if (!repeatable_key && repeated) { return FALSE; } LL_DEBUGS("UserInput") << "keydown -" << translated_key << "-" << LL_ENDL; // skip skipped keys if(mKeysSkippedByUI.find(translated_key) != mKeysSkippedByUI.end()) { mKeyHandledByUI[translated_key] = FALSE; LL_INFOS("KeyboardHandling") << "Key wasn't handled by UI!" << LL_ENDL; } else { // it is sufficient to set this value once per call to handlekey // without clearing it, as it is only used in the subsequent call to scanKey mKeyHandledByUI[translated_key] = gViewerWindow->handleKey(translated_key, translated_mask); // mKeyHandledByUI is not what you think ... this indicates whether the UI has handled this keypress yet (any keypress) // NOT whether some UI shortcut wishes to handle the keypress } return mKeyHandledByUI[translated_key]; } BOOL LLViewerInput::handleKeyUp(KEY translated_key, MASK translated_mask) { return gViewerWindow->handleKeyUp(translated_key, translated_mask); } BOOL LLViewerInput::bindKey(const S32 mode, const KEY key, const MASK mask, const std::string& function_name) { S32 index; typedef boost::function function_t; function_t function = NULL; std::string name; // Allow remapping of F2-F12 if (function_name[0] == 'F') { int c1 = function_name[1] - '0'; int c2 = function_name[2] ? function_name[2] - '0' : -1; if (c1 >= 0 && c1 <= 9 && c2 >= -1 && c2 <= 9) { int idx = c1; if (c2 >= 0) idx = idx*10 + c2; if (idx >=2 && idx <= 12) { U32 keyidx = ((mask<<16)|key); (mRemapKeys[mode])[keyidx] = ((0<<16)|(KEY_F1+(idx-1))); return TRUE; } } } // Not remapped, look for a function function_t* result = LLKeyboardActionRegistry::getValue(function_name); if (result) { function = *result; } if (!function) { LL_ERRS() << "Can't bind key to function " << function_name << ", no function with this name found" << LL_ENDL; return FALSE; } // check for duplicate first and overwrite S32 size = mKeyBindings[mode].size(); for (index = 0; index < size; index++) { if (key == mKeyBindings[mode][index].mKey && mask == mKeyBindings[mode][index].mMask) break; } if (mode >= MODE_COUNT) { LL_ERRS() << "LLKeyboard::bindKey() - unknown mode passed" << mode << LL_ENDL; return FALSE; } LLKeyboardBinding bind; bind.mKey = key; bind.mMask = mask; bind.mFunction = function; mKeyBindings[mode].push_back(bind); return TRUE; } BOOL LLViewerInput::bindMouse(const S32 mode, const EMouseClickType mouse, const MASK mask, const std::string& function_name) { S32 index; typedef boost::function function_t; function_t function = NULL; if (mouse == CLICK_LEFT && mask == MASK_NONE && function_name == script_mouse_handler_name) { // Special case // Left click has script overrides and by default // is handled via agent_control_lbutton as last option // In case of mouselook and present overrides it has highest // priority even over UI and is handled in LLToolCompGun::handleMouseDown // so just mark it as having default handler mLMouseDefaultHandling[mode] = true; return TRUE; } function_t* result = LLKeyboardActionRegistry::getValue(function_name); if (result) { function = *result; } if (!function) { LL_ERRS() << "Can't bind key to function " << function_name << ", no function with this name found" << LL_ENDL; return FALSE; } // check for duplicate first and overwrite S32 size = mMouseBindings[mode].size(); for (index = 0; index < size; index++) { if (mouse == mMouseBindings[mode][index].mMouse && mask == mMouseBindings[mode][index].mMask) break; } if (mode >= MODE_COUNT) { LL_ERRS() << "LLKeyboard::bindKey() - unknown mode passed" << mode << LL_ENDL; return FALSE; } LLMouseBinding bind; bind.mMouse = mouse; bind.mMask = mask; bind.mFunction = function; mMouseBindings[mode].push_back(bind); return TRUE; } LLViewerInput::KeyBinding::KeyBinding() : key("key"), mouse("mouse"), mask("mask"), command("command") {} LLViewerInput::KeyMode::KeyMode() : bindings("binding") {} LLViewerInput::Keys::Keys() : first_person("first_person"), third_person("third_person"), sitting("sitting"), edit_avatar("edit_avatar") {} void LLViewerInput::resetBindings() { for (S32 i = 0; i < MODE_COUNT; i++) { mKeyBindings[i].clear(); mMouseBindings[i].clear(); mLMouseDefaultHandling[i] = false; } } S32 LLViewerInput::loadBindingsXML(const std::string& filename) { resetBindings(); S32 binding_count = 0; Keys keys; LLSimpleXUIParser parser; if (parser.readXUI(filename, keys) && keys.validateBlock()) { binding_count += loadBindingMode(keys.first_person, MODE_FIRST_PERSON); binding_count += loadBindingMode(keys.third_person, MODE_THIRD_PERSON); binding_count += loadBindingMode(keys.sitting, MODE_SITTING); binding_count += loadBindingMode(keys.edit_avatar, MODE_EDIT_AVATAR); } return binding_count; } S32 count_masks(const MASK &mask) { S32 res = 0; if (mask & MASK_CONTROL) { res++; } if (mask & MASK_SHIFT) { res++; } if (mask & MASK_ALT) { res++; } return res; } bool compare_key_by_mask(LLKeyboardBinding i1, LLKeyboardBinding i2) { return (count_masks(i1.mMask) > count_masks(i2.mMask)); } bool compare_mouse_by_mask(LLMouseBinding i1, LLMouseBinding i2) { return (count_masks(i1.mMask) > count_masks(i2.mMask)); } S32 LLViewerInput::loadBindingMode(const LLViewerInput::KeyMode& keymode, S32 mode) { S32 binding_count = 0; for (LLInitParam::ParamIterator::const_iterator it = keymode.bindings.begin(), end_it = keymode.bindings.end(); it != end_it; ++it) { bool processed = false; std::string key_str = it->key.getValue(); if (!key_str.empty() && key_str != "NONE") { KEY key; LLKeyboard::keyFromString(key_str, &key); if (key != KEY_NONE) { MASK mask; LLKeyboard::maskFromString(it->mask, &mask); bindKey(mode, key, mask, it->command); processed = true; } else { LL_WARNS_ONCE() << "There might be issues in keybindings' file" << LL_ENDL; } } if (!processed && it->mouse.isProvided() && !it->mouse.getValue().empty()) { EMouseClickType mouse; mouseFromString(it->mouse.getValue(), &mouse); if (mouse != CLICK_NONE) { MASK mask; LLKeyboard::maskFromString(it->mask, &mask); bindMouse(mode, mouse, mask, it->command); processed = true; } else { LL_WARNS_ONCE() << "There might be issues in keybindings' file" << LL_ENDL; } } if (processed) { // total binding_count++; } } // sort lists by mask (so that Shift+W is executed before W, if both are assigned, but if Shift+W is not assigned W should be executed) std::sort(mKeyBindings[mode].begin(), mKeyBindings[mode].end(), compare_key_by_mask); std::sort(mMouseBindings[mode].begin(), mMouseBindings[mode].end(), compare_mouse_by_mask); return binding_count; } EKeyboardMode LLViewerInput::getMode() const { if ( gAgentCamera.cameraMouselook() ) { return MODE_FIRST_PERSON; } else if ( gMorphView && gMorphView->getVisible()) { return MODE_EDIT_AVATAR; } else if (isAgentAvatarValid() && gAgentAvatarp->isSitting()) { return MODE_SITTING; } else { return MODE_THIRD_PERSON; } } bool LLViewerInput::scanKey(const std::vector &binding, S32 binding_count, KEY key, MASK mask, BOOL key_down, BOOL key_up, BOOL key_level, bool repeat) const { for (S32 i = 0; i < binding_count; i++) { if (binding[i].mKey == key) { if ((binding[i].mMask & mask) == binding[i].mMask) { bool res = false; if (key_down && !repeat) { // ...key went down this frame, call function res = binding[i].mFunction( KEYSTATE_DOWN ); return true; } else if (key_up) { // ...key went down this frame, call function res = binding[i].mFunction( KEYSTATE_UP ); } else if (key_level) { // ...key held down from previous frame // Not windows, just call the function. res = binding[i].mFunction( KEYSTATE_LEVEL ); }//if // Key+Mask combinations are supposed to be unique, so we won't find anything else return res; }//if }//if }//for return false; } // Called from scanKeyboard. bool LLViewerInput::scanKey(KEY key, BOOL key_down, BOOL key_up, BOOL key_level) const { if (LLApp::isExiting()) { return false; } S32 mode = getMode(); // Consider keyboard scanning as NOT mouse event. JC MASK mask = gKeyboard->currentMask(FALSE); if (mKeyHandledByUI[key]) { return false; } // don't process key down on repeated keys BOOL repeat = gKeyboard->getKeyRepeated(key); bool res = scanKey(mKeyBindings[mode], mKeyBindings[mode].size(), key, mask, key_down, key_up, key_level, repeat); if (!res && agent_control_lbutton.canHandle(CLICK_NONE, key, mask)) { // pass mouse left button press to script if (key_down && !repeat) { res = agent_control_lbutton_handle(KEYSTATE_DOWN); } if (key_up) { res = agent_control_lbutton_handle(KEYSTATE_UP); } } return res; } BOOL LLViewerInput::handleMouse(LLWindow *window_impl, LLCoordGL pos, MASK mask, EMouseClickType clicktype, BOOL down) { BOOL handled = gViewerWindow->handleAnyMouseClick(window_impl, pos, mask, clicktype, down); if (clicktype != CLICK_NONE) { // Special case // If UI doesn't handle double click, LMB click is issued, so supres LMB 'down' when doubleclick is set // handle !down as if we are handling doubleclick bool double_click_sp = (clicktype == CLICK_LEFT && (mMouseLevel[CLICK_DOUBLELEFT] != MOUSE_STATE_SILENT) && mMouseLevel[CLICK_LEFT] == MOUSE_STATE_SILENT); if (double_click_sp && !down) { // Process doubleclick instead clicktype = CLICK_DOUBLELEFT; } if (double_click_sp && down) { // Consume click. // Due to handling, double click that is not handled will be immediately followed by LMB click } // If UI handled 'down', it should handle 'up' as well // If we handle 'down' not by UI, then we should handle 'up'/'level' regardless of UI else if (handled) { // UI handled new 'down' so iterupt whatever state we were in. if (mMouseLevel[clicktype] != MOUSE_STATE_SILENT) { if (mMouseLevel[clicktype] == MOUSE_STATE_DOWN) { mMouseLevel[clicktype] = MOUSE_STATE_CLICK; } else { mMouseLevel[clicktype] = MOUSE_STATE_UP; } } } else if (down) { if (mMouseLevel[clicktype] == MOUSE_STATE_DOWN) { // this is repeated hit (mouse does not repeat event until release) // for now treat rapid clicking like mouse being held mMouseLevel[clicktype] = MOUSE_STATE_LEVEL; } else { mMouseLevel[clicktype] = MOUSE_STATE_DOWN; } } else if (mMouseLevel[clicktype] != MOUSE_STATE_SILENT) { // Released mouse key if (mMouseLevel[clicktype] == MOUSE_STATE_DOWN) { mMouseLevel[clicktype] = MOUSE_STATE_CLICK; } else { mMouseLevel[clicktype] = MOUSE_STATE_UP; } } } return handled; } bool LLViewerInput::scanMouse(const std::vector &binding, S32 binding_count, EMouseClickType mouse, MASK mask, EMouseState state) const { for (S32 i = 0; i < binding_count; i++) { if (binding[i].mMouse == mouse && (binding[i].mMask & mask) == binding[i].mMask) { bool res = false; switch (state) { case MOUSE_STATE_DOWN: res = binding[i].mFunction(KEYSTATE_DOWN); break; case MOUSE_STATE_CLICK: // Button went down and up in scope of single frame // might not work best with some functions, // but some function need specific states specifically res = binding[i].mFunction(KEYSTATE_DOWN); res |= binding[i].mFunction(KEYSTATE_UP); break; case MOUSE_STATE_LEVEL: res = binding[i].mFunction(KEYSTATE_LEVEL); break; case MOUSE_STATE_UP: res = binding[i].mFunction(KEYSTATE_UP); break; default: break; } // Key+Mask combinations are supposed to be unique, no need to continue return res; } } return false; } // todo: this recods key, scanMouse() triggers functions with EKeystate bool LLViewerInput::scanMouse(EMouseClickType click, EMouseState state) const { bool res = false; S32 mode = getMode(); MASK mask = gKeyboard->currentMask(TRUE); res = scanMouse(mMouseBindings[mode], mMouseBindings[mode].size(), click, mask, state); // no user defined actions found or those actions can't handle the key/button, handle control if nessesary // This will pass AGENT_CONTROL_LBUTTON_DOWN to server, no idea why it doesn't do mouselook variant _ML_ // but it was set this way forever (moved as is from LLTool::handleMouseDown) so lots of scripts probably // rely on this. if (!res && mLMouseDefaultHandling[mode] && agent_control_lbutton.canHandle(click, KEY_NONE, mask)) { switch (state) { case MOUSE_STATE_DOWN: agent_control_lbutton_handle(KEYSTATE_DOWN); res = true; break; case MOUSE_STATE_CLICK: // might not work best with some functions, // but some function need specific states too specifically agent_control_lbutton_handle(KEYSTATE_DOWN); agent_control_lbutton_handle(KEYSTATE_UP); res = true; break; case MOUSE_STATE_UP: agent_control_lbutton_handle(KEYSTATE_UP); res = true; break; default: break; } } return res; } void LLViewerInput::scanMouse() { for (S32 i = 0; i < CLICK_COUNT; i++) { if (mMouseLevel[i] != MOUSE_STATE_SILENT) { scanMouse((EMouseClickType)i, mMouseLevel[i]); if (mMouseLevel[i] == MOUSE_STATE_DOWN) { // mouse doesn't support 'continued' state, so after handling, switch to LEVEL mMouseLevel[i] = MOUSE_STATE_LEVEL; } else if (mMouseLevel[i] == MOUSE_STATE_UP || mMouseLevel[i] == MOUSE_STATE_CLICK) { mMouseLevel[i] = MOUSE_STATE_SILENT; } } } } bool LLViewerInput::isMouseBindUsed(const EMouseClickType mouse, const MASK mask, const S32 mode) { S32 size = mMouseBindings[mode].size(); for (S32 index = 0; index < size; index++) { if (mouse == mMouseBindings[mode][index].mMouse && mask == mMouseBindings[mode][index].mMask) return true; } return false; }