com.threerings.tudey.tools
Class EditorTool

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.threerings.tudey.tools.EditorTool

All Implemented Interfaces:

Compositable, Tickable, TudeySceneModel.Observer, MouseListener, MouseMotionListener, MouseWheelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

Arrow, BaseMover, ConfigTool, Eraser, Eyedropper, GlobalEditor, Layers, Notepad, Selector

public abstract class EditorTool
extends JPanel
implements Tickable, Compositable, TudeySceneModel.Observer, MouseListener, MouseMotionListener, MouseWheelListener

A tool to use in the scene editor.

See Also:

Serialized Form

Nested Class Summary

protected static class	EditorTool.DirectionalConstraint The directional constraints.
protected static class	EditorTool.Filter Determines which kinds of entries we want to affect.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected JToggleButton	_button The tool's button.
protected SceneEditor	_editor A reference to the creating editor.
protected MessageBundle	_msgs The editor message bundle.
protected Ray3D	_pick Used for picking.
protected TudeySceneModel	_scene A reference to the scene.
protected static float	FINE_ROTATION_INCREMENT The fine rotation increment.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

EditorTool(SceneEditor editor)
Creates the tool.

Method Summary

void	activate() Notes that the tool has been activated.
boolean	allowsMouseCamera() Determines whether this tool (currently) allows the user to move the camera using the mouse (without holding down the control key).
void	composite() Adds this object's Dependencys and Enqueueables to the compositor in preparation for rendering.
void	deactivate() Notes that the tool has been deactivated.
void	entryAdded(TudeySceneModel.Entry entry) Notes that an entry has been added to the scene.
void	entryRemoved(TudeySceneModel.Entry oentry) Notes that an entry has been removed from the scene.
void	entryUpdated(TudeySceneModel.Entry oentry, TudeySceneModel.Entry nentry) Notes that an entry has been updated within the scene.
protected boolean	getMousePlaneIntersection(Vector3f result) Finds the point at which the mouse ray intersects the grid plane.
void	init() Initializes the tool after the renderer has been initialized.
void	mouseClicked(MouseEvent event)
void	mouseDragged(MouseEvent event)
void	mouseEntered(MouseEvent event)
void	mouseExited(MouseEvent event)
void	mouseMoved(MouseEvent event)
void	mousePressed(MouseEvent event)
void	mouseReleased(MouseEvent event)
void	mouseWheelMoved(MouseWheelEvent event)
void	sceneChanged(TudeySceneModel scene) Notes that the scene object has changed.
void	setButton(JToggleButton button) Configures the tool with a reference to its button.
void	tick(float elapsed) Updates the state of this object based on the elapsed time in seconds.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_editor

protected SceneEditor _editor

A reference to the creating editor.

_msgs

protected MessageBundle _msgs

The editor message bundle.

_button

protected JToggleButton _button

The tool's button.

_scene

protected TudeySceneModel _scene

A reference to the scene.

_pick

protected Ray3D _pick

Used for picking.

FINE_ROTATION_INCREMENT

protected static final float FINE_ROTATION_INCREMENT

The fine rotation increment.

Constructor Detail

EditorTool

public EditorTool(SceneEditor editor)

Creates the tool.

Method Detail

setButton

public void setButton(JToggleButton button)

Configures the tool with a reference to its button.

init

public void init()

Initializes the tool after the renderer has been initialized.

activate

public void activate()

Notes that the tool has been activated.

deactivate

public void deactivate()

Notes that the tool has been deactivated.

sceneChanged

public void sceneChanged(TudeySceneModel scene)

Notes that the scene object has changed.

allowsMouseCamera

public boolean allowsMouseCamera()

Determines whether this tool (currently) allows the user to move the camera using the mouse (without holding down the control key).

tick

public void tick(float elapsed)

Description copied from interface: Tickable

Updates the state of this object based on the elapsed time in seconds.

Specified by:

tick in interface Tickable

composite

public void composite()

Description copied from interface: Compositable

Adds this object's Dependencys and Enqueueables to the compositor in preparation for rendering.

Specified by:

composite in interface Compositable

entryAdded

public void entryAdded(TudeySceneModel.Entry entry)

Description copied from interface: TudeySceneModel.Observer

Notes that an entry has been added to the scene.

Specified by:

entryAdded in interface TudeySceneModel.Observer

entryUpdated

public void entryUpdated(TudeySceneModel.Entry oentry,
                         TudeySceneModel.Entry nentry)

Description copied from interface: TudeySceneModel.Observer

Notes that an entry has been updated within the scene.

Specified by:

entryUpdated in interface TudeySceneModel.Observer

entryRemoved

public void entryRemoved(TudeySceneModel.Entry oentry)

Description copied from interface: TudeySceneModel.Observer

Notes that an entry has been removed from the scene.

Specified by:

entryRemoved in interface TudeySceneModel.Observer

mouseClicked

public void mouseClicked(MouseEvent event)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent event)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent event)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent event)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent event)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent event)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent event)

Specified by:

mouseMoved in interface MouseMotionListener

mouseWheelMoved

public void mouseWheelMoved(MouseWheelEvent event)

Specified by:

mouseWheelMoved in interface MouseWheelListener

getMousePlaneIntersection

protected boolean getMousePlaneIntersection(Vector3f result)

Finds the point at which the mouse ray intersects the grid plane.

Returns:

true if the mouse is on the canvas and the mouse ray intersects the grid plane (in which case the result object will be populated), false if not.