com.sun.j3d.utils.behaviors.mouse
Class MouseTranslate

java.lang.Object
  extended by javax.media.j3d.SceneGraphObject
      extended by javax.media.j3d.Node
          extended by javax.media.j3d.Leaf
              extended by javax.media.j3d.Behavior
                  extended by com.sun.j3d.utils.behaviors.mouse.MouseBehavior
                      extended by com.sun.j3d.utils.behaviors.mouse.MouseTranslate
All Implemented Interfaces:
java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class MouseTranslate
extends MouseBehavior

MouseTranslate is a Java3D behavior object that lets users control the translation (X, Y) of an object via a mouse drag motion with the third mouse button (alt-click on PC). See MouseRotate for similar usage info.


Field Summary
 
Fields inherited from class com.sun.j3d.utils.behaviors.mouse.MouseBehavior
buttonPress, currXform, enable, flags, invert, INVERT_INPUT, MANUAL_WAKEUP, mouseCriterion, mouseEvents, mouseq, reset, transformGroup, transformX, transformY, wakeUp, x, x_last, y, y_last
 
Fields inherited from class javax.media.j3d.Node
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING
 
Constructor Summary
MouseTranslate()
          Creates a default translate behavior.
MouseTranslate(java.awt.Component c)
          Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent.
MouseTranslate(java.awt.Component c, int flags)
          Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent.
MouseTranslate(java.awt.Component c, TransformGroup transformGroup)
          Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent.
MouseTranslate(int flags)
          Creates a translate behavior.
MouseTranslate(TransformGroup transformGroup)
          Creates a mouse translate behavior given the transform group.
 
Method Summary
 double getXFactor()
          Return the x-axis movement multipler.
 double getYFactor()
          Return the y-axis movement multipler.
 void initialize()
          Initializes the behavior.
 void processStimulus(java.util.Enumeration criteria)
          All mouse manipulators must implement this.
 void setFactor(double factor)
          Set the x-axis amd y-axis movement multipler with factor.
 void setFactor(double xFactor, double yFactor)
          Set the x-axis amd y-axis movement multipler with xFactor and yFactor respectively.
 void setupCallback(MouseBehaviorCallback callback)
          The transformChanged method in the callback class will be called every time the transform is updated
 void transformChanged(Transform3D transform)
          Users can overload this method which is called every time the Behavior updates the transform Default implementation does nothing
 
Methods inherited from class com.sun.j3d.utils.behaviors.mouse.MouseBehavior
addListener, getTransformGroup, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, processMouseEvent, setEnable, setTransformGroup, wakeup
 
Methods inherited from class javax.media.j3d.Behavior
getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, getView, getWakeupCondition, postId, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, updateNodeReferences, wakeupOn
 
Methods inherited from class javax.media.j3d.Node
cloneNode, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable
 
Methods inherited from class javax.media.j3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MouseTranslate

public MouseTranslate(TransformGroup transformGroup)
Creates a mouse translate behavior given the transform group.

Parameters:
transformGroup - The transformGroup to operate on.

MouseTranslate

public MouseTranslate()
Creates a default translate behavior.


MouseTranslate

public MouseTranslate(int flags)
Creates a translate behavior. Note that this behavior still needs a transform group to work on (use setTransformGroup(tg)) and the transform group must add this behavior.

Parameters:
flags -

MouseTranslate

public MouseTranslate(java.awt.Component c)
Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent. The behavior is added to the specified Component. A null component can be passed to specify the behavior should use listeners. Components can then be added to the behavior with the addListener(Component c) method.

Parameters:
c - The Component to add the MouseListener and MouseMotionListener to.
Since:
Java 3D 1.2.1

MouseTranslate

public MouseTranslate(java.awt.Component c,
                      TransformGroup transformGroup)
Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent. The behaviors is added to the specified Component and works on the given TransformGroup. A null component can be passed to specify the behavior should use listeners. Components can then be added to the behavior with the addListener(Component c) method.

Parameters:
c - The Component to add the MouseListener and MouseMotionListener to.
transformGroup - The TransformGroup to operate on.
Since:
Java 3D 1.2.1

MouseTranslate

public MouseTranslate(java.awt.Component c,
                      int flags)
Creates a translate behavior that uses AWT listeners and behavior posts rather than WakeupOnAWTEvent. The behavior is added to the specified Component. A null component can be passed to specify the behavior should use listeners. Components can then be added to the behavior with the addListener(Component c) method. Note that this behavior still needs a transform group to work on (use setTransformGroup(tg)) and the transform group must add this behavior.

Parameters:
flags - interesting flags (wakeup conditions).
Since:
Java 3D 1.2.1
Method Detail

initialize

public void initialize()
Description copied from class: MouseBehavior
Initializes the behavior.

Overrides:
initialize in class MouseBehavior

getXFactor

public double getXFactor()
Return the x-axis movement multipler.


getYFactor

public double getYFactor()
Return the y-axis movement multipler.


setFactor

public void setFactor(double factor)
Set the x-axis amd y-axis movement multipler with factor.


setFactor

public void setFactor(double xFactor,
                      double yFactor)
Set the x-axis amd y-axis movement multipler with xFactor and yFactor respectively.


processStimulus

public void processStimulus(java.util.Enumeration criteria)
Description copied from class: MouseBehavior
All mouse manipulators must implement this.

Specified by:
processStimulus in class MouseBehavior
Parameters:
criteria - an enumeration of triggered wakeup criteria for this behavior

transformChanged

public void transformChanged(Transform3D transform)
Users can overload this method which is called every time the Behavior updates the transform Default implementation does nothing


setupCallback

public void setupCallback(MouseBehaviorCallback callback)
The transformChanged method in the callback class will be called every time the transform is updated



Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.