Difference between revisions of "Input Pointers"

using System;
using UnityEngine;


/// <summary>A laser pointer which fires an input ray from e.g. a 3D hand.</summary>
/// NOTE: PowerUI.InputPointer.Raycast is defined in PowerUI git master, not in releases at least up to 2.0.700
public class LaserPointer : PowerUI.InputPointer{
    
    public Transform Transform;
    /// <summary>True if UI's move around.</summary>
    public bool MovingUIs; 
   

    /// <summary>Setup a laser pointer from the given transform (e.g. a hand object).</summary>
    public LaserPointer(Transform transform):this(transform,true){}
   
    /// <summary>Setup a laser pointer from the given transform (e.g. a hand object).</summary>
    /// <param name='movingUIs'>Set this to true if your WorldUI's move around.
    /// Setting it to false is a small performance saving. If you're not sure, just use true.</param>
    public LaserPointer(Transform transform, bool movingUIs){
       Transform = transform;
       MovingUIs = movingUIs;
       
       // It won't interact with the main UI so just put it offscreen to skip checking entirely:
       ScreenX = ScreenY = -1000f;
       
    }
    
    public override bool Raycast(out RaycastHit hit, Camera cam, Vector2 screenPoint){
        
        // Fire off your ray in whatever your pointers direction is; we'll use transform.forward here.
        // ('forward' is +ve z):
        Ray ray = new Ray(Transform.position, Transform.forward);

        return Physics.Raycast(theRay, out hit);
    }
    
    public override bool Relocate(out Vector2 delta){
        
        // We can just ignore delta (it's for the main UI):
        delta = Vector2.zero;
        
        if(MovingUIs){
            // Always recompute.
            return true;
        }
        
        // Transform moved?
        if(Transform!=null && Transform.hasChanged){
            Transform.hasChanged = false;
            return true;
        }
        
        // Don't bother recalculating - it's not moved.
        // (Always return true if your UI's are moving instead).
        return false;
    }
    
}

// Fires a ray from the given hand object. If your UI's don't move around, use LaserPointer(aHandObject,false) to make a performance gain.
LaserPointer myPointer = new LaserPointer(aHandObject);

// Add it:
myPointer.Add();

// myPointer.LeftDown(); etc to click (see more below)

public class MyCustomPointer : InputPointer{
}

    MyCustomPointer pointer = new MyCustomPointer();
    pointer.Add();

    pointer.Position = new Vector2(100,100);

public class MyCustomPointer : InputPointer{
    
    public override bool Relocate(out Vector2 positionChange){
    
        // - Get your latest coordinates here -
        Vector2 newPosition = Vector2.zero;
        
        // Try moving it (just returns false if your position wasn't different to the current one):
        return TryChangePosition(newPosition, out positionChange);
    }

}

void OnGUI(){

  // Returns true if your pointer actually did something (it went down or up)
  // You can also directly pass a UnityEngine.Event too.
  bool didSomething = MyPointer.HandleEvent();

}

// Mousedown event, left button:
MyPointer.Down(0);

// Which is also the same as:
MyPointer.LeftDown();

// Mouseup event, left button:
MyPointer.Up(0);

// Which is the same as:
MyPointer.LeftUp();

void Update(){
  
  // Update the pointer pressure:
  MyPointer.SetPressure(someVaryingField);

}