UICamera

Overview

UICamera is a somewhat poorly named component. In fact, its name is kept only for backwards compatibility purposes.

What the UICamera script actually does is sends out NGUI events to all the objects seen by the camera it‘s attached to. It doesn‘t have to have anything to do with UI though. In fact, if you wish to receive NGUI events on your in-game objects such as OnPress, OnClick, OnDrag etc, then all you need to do is attach the UICamera script to your main camera.

You can have several UICamera scripts in the scene. Most games will have one on the camera that draws the widgets, and another on the camera that draws the game.

NOTE: For UICamera to work, "Raycasts Hit Triggers" （基于射线碰撞测试，可以理解为什么需要box colider了）must be checked in the Physics settings.

   

The first option on the UICamera, Event Type is what determines how the script sorts whats underneath the mouse and touch events. If it‘s set to UI mode, then it‘s always based on widget‘s depth -- just like the draw order. Changing this option to World mode is something you should do if your UICamera is attached to your Main Camera. Doing so will sort the hit objects by their distance to the camera.

Event Mask is what determines which game object layers will be capable of receiving events. In most cases you can leave this on "Everything", as this value is combined with the UnityEngine.Camera‘s Culling Mask, but you can fine-tune it if you wish. If you ever change the Layer of your game object containing the UI hierarchy, make sure to adjust the Event Mask or you will suddenly find your UI no longer responding to events.

Debug option can be used to debug what‘s currently under the mouse. If you can‘t figure out what‘s intercepting mouse events when you click on some button, just turn on this option and you will be able to see it in the top-right corner.

Allow Multi-Touch option controls whether multiple touches will be supported. If turned off, multiple touches will all be treated as a single touch.

Sticky Tooltip option fine-tunes the tooltip behaviour. If off, the tooltip will hide as soon as the mouse moves again. If on, the tooltip will remain open while the mouse is over the same object.

Tooltip Delay controls the delay between the mouse stopping movement over some object and the OnTooltip notification being sent to that object. This value is in seconds.

Raycast Range controls the length of the raycast, and in most cases this value can be safely ignored. This value is in world units, so if your camera has the near clip of 0.3 and far clipping of 1000, you and you are finding that some far-away objects are not responding to clicks, set this value to something like 2000 (something greater than the difference between your camera‘s far and near clipping planes).



Event Sources section controls what kind of event types will be processed. If one of the options is turned off, those events will no longer be processed. Some platforms force-disable specific events under the hood. For example targeting consoles will automatically turn off mouse and touch events.



Thresholds section lets you fine-tune how the mouse and touch events behave by tweaking the thresholds of click, drag and tap events. These values are in pixels.



Axes and Keys section lets you choose which axes result in which movement. These axes should match the names in your project‘s Input Manager.

Pro-Tip #1

UICamera sends out the following events to colliders:

• OnHover (isOver) is sent when the mouse hovers over a collider or moves away.
• OnPress (isDown) is sent when a mouse button gets pressed on the collider.
• OnSelect (selected) is sent when a mouse button is first pressed on a game object. Repeated presses on the same object won‘t result in a new OnSelect.
• OnClick () is sent with the same conditions as OnSelect, with the added check to see if the mouse has not moved much. UICamera.currentTouchID tells you which button was clicked.
• OnDoubleClick () is sent when the click happens twice within a fourth of a second. UICamera.currentTouchID tells you which button was clicked.
• OnDragStart () is sent to a game object under the touch just before the OnDrag() notifications begin.
• OnDrag (delta) is sent to an object that‘s being dragged.
• OnDragOver (draggedObject) is sent to a game object when another object is dragged over its area.
• OnDragOut (draggedObject) is sent to a game object when another object is dragged out of its area.
• OnDragEnd () is sent to a dragged object when the drag event finishes.
• OnInput (text) is sent when typing (after selecting a collider by clicking on it).
• OnTooltip (show) is sent when the mouse hovers over a collider for some time without moving.
• OnScroll (float delta) is sent out when the mouse scroll wheel is moved.
• OnKey (KeyCode key) is sent when keyboard or controller input is used.