Vibrator.java :  » Game » rokon » com » stickycoding » rokon » device » Android Open Source

package com.stickycoding.rokon.device;

import com.stickycoding.rokon.Rokon;

import android.content.Context;

/**
 * Vibrate.java
 * A helper class for vibrating the device
 * 
 * REMEMBER TO ADD THE RIGHT PERMISSIONS TO AndroidManifest.xml * 
 * <uses-permission android:name="android.permission.VIBRATE" ></uses-permission>
 * 
 * Take care when using import, the name clashes with android.os.Vibrator (yeah, I know.)
 * 
 * @author Richard
 */

public class Vibrator {
  
  protected static android.os.Vibrator vibrator;
  protected static boolean enabled = true;
  
  /**
   * Enables the Vibrator to work (this is on by default)
   */
  public static void enable() {
    enabled = true;
  }
  
  /**
   * Prevents the Vibrator from vibrating
   */
  public static void disable() {
    enabled = false;
  }
  
  private static void prepareVibrator() {
    if(vibrator != null) return;
    vibrator = (android.os.Vibrator) Rokon.getActivity().getSystemService(Context.VIBRATOR_SERVICE);
    
  }
  
  /**
   * Vibrates the phone for a given time
   * 
   * @param time in milliseconds
   */
  public static void vibrate(long time) {
    if(!enabled) return;
    prepareVibrator();
    vibrator.vibrate(time);
  }
  
  /**
   * Vibrates the phone with a given pattern
   * Pass in an array of ints that are the times at which to turn on or off the vibrator. The first one is how long to wait before turning it on, and then after that it alternates. If you want to repeat, pass the index into the pattern at which to start the repeat.
   * 
   * @param pattern an array of longs of times to turn the vibrator on or off
   * @param repeat the index into pattern at which to repeat, or -1 if you don't want to repeat
   */
  public static void vibrate(long[] pattern, int repeat) {
    if(!enabled) return;
    prepareVibrator();
    vibrator.vibrate(pattern, repeat);
  }

}