com.threerings.miso.client

Class MisoScenePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.threerings.media.MediaPanel

com.threerings.media.VirtualMediaPanel

com.threerings.miso.client.MisoScenePanel

All Implemented Interfaces:

RadialMenu.Host, FrameParticipant, MediaConstants, MediaHost, AStarPathUtil.TraversalPred, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener

public class MisoScenePanel
extends VirtualMediaPanel
implements MouseListener, MouseMotionListener, AStarPathUtil.TraversalPred, RadialMenu.Host

Renders a Miso scene for all to see.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.media.MediaPanel

MediaPanel.Obscurer

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_TIPS Show flag that indicates we should show all tips.

Fields inherited from class com.threerings.media.VirtualMediaPanel

CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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 com.threerings.media.MediaConstants

ALL, BACK, FRONT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
MisoScenePanel(MisoContext ctx, MisoSceneMetrics metrics) Creates a blank miso scene display.

Method Summary

Modifier and Type	Method and Description
void	addNotify()
boolean	canTraverse(Object traverser, int tx, int ty) Requests to know if the specified traverser (which was provided in the call to AStarPathUtil.getPath(TraversalPred,Object,int,int,int,int,int,boolean)) can traverse the specified tile coordinate.
void	centerOnTile(int tx, int ty) Moves the scene such that the specified tile is in the center.
boolean	checkShowFlag(int flag) Check to see if the specified show flag is on.
void	clearRadialMenu() Clears any radial menu being displayed.
void	computeIndicators() Compute the indicators for any objects in the scene.
static void	computeInfluentialBounds(Rectangle visibleBounds, Rectangle influentualBounds, Rectangle visibleBlockBounds) Configures influentialBounds to contain the bounds of the potentially "influential" world and visibleBlockBounds to contain bounds that are used to determine which blocks should be resolved before making the view visible.
Iterator<SceneBlock>	enumerateResolvedBlocks() Returns an iterator over all resolved SceneBlock instances.
SceneBlock	getBlock(int tx, int ty) Returns the resolved block that contains the specified tile coordinate or null if no block is resolved for that coordinate.
Component	getComponent() If a frame participant wishes also to be actively rendered every frame rather than use passive rendering (which for Swing, at least, is hijacked when using the frame manager such that we take care of repainting dirty Swing components every frame into our off-screen buffer), it can return a component here which will have Component.paint(java.awt.Graphics) called on it once per frame with a translated but unclipped graphics object.
Point	getFullCoords(int x, int y) Converts the supplied screen coordinates to full coordinates.
Point	getHoverCoords() Returns the tile coordinates of the tile over which the mouse is hovering.
Object	getHoverObject() Returns the top-most object over which the mouse is hovering; this may be a sprite or a SceneObject.
Path	getPath(Sprite sprite, int x, int y, boolean loose) Computes a path for the specified sprite to the specified tile coordinates.
MisoSceneMetrics	getSceneMetrics() Returns the scene metrics in use by this panel.
MisoSceneModel	getSceneModel() Returns the scene model being displayed by this panel.
Point	getScreenCoords(int x, int y) Converts the supplied full coordinates to screen coordinates.
Point	getTileCoords(int x, int y) Converts the supplied screen coordinates to tile coordinates.
Rectangle	getViewBounds() Returns the bounds of the viewport in virtual coordinates.
void	menuDeactivated(RadialMenu menu)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paint(Graphics g)
void	pressObject(SceneObject scobj) Programmatically "click" a scene object.
void	refreshScene() Completely invalidates our current resolved scene and re-resolves it from the ground up.
void	removeNotify()
void	repaintRect(int x, int y, int width, int height)
void	reportMemoryUsage() Reports the memory usage of the resolved tiles in the current scene block.
void	setBounds(int x, int y, int width, int height)
void	setSceneModel(MisoSceneModel model) Configures this display with a scene model which will immediately be resolved and displayed.
void	setShowFlags(int flags, boolean on) Set whether or not to highlight object tooltips (and potentially other scene entities).

Methods inherited from class com.threerings.media.VirtualMediaPanel

addViewTracker, clearPathable, doLayout, removeViewTracker, setBackground, setFollowsPathable, setViewLocation

Methods inherited from class com.threerings.media.MediaPanel

abortAnimation, addAnimation, addObscurer, addSprite, clearAnimations, clearSprites, createGraphics, getAnimationManager, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, removeObscurer, removeSprite, repaint, setOpaque, setPaused, tick

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SHOW_TIPS

public static final int SHOW_TIPS

Show flag that indicates we should show all tips.

See Also:

Constant Field Values

Constructor Detail

MisoScenePanel

public MisoScenePanel(MisoContext ctx,
                      MisoSceneMetrics metrics)

Creates a blank miso scene display. Configure it with a scene model via setSceneModel(com.threerings.miso.data.MisoSceneModel) to cause it to display something.

Method Detail

setSceneModel

public void setSceneModel(MisoSceneModel model)

Configures this display with a scene model which will immediately be resolved and displayed.

refreshScene

public void refreshScene()

Completely invalidates our current resolved scene and re-resolves it from the ground up.

centerOnTile

public void centerOnTile(int tx,
                         int ty)

Moves the scene such that the specified tile is in the center.

getSceneModel

public MisoSceneModel getSceneModel()

Returns the scene model being displayed by this panel. Do not modify!

getSceneMetrics

public MisoSceneMetrics getSceneMetrics()

Returns the scene metrics in use by this panel. Do not modify!

setShowFlags

public void setShowFlags(int flags,
                         boolean on)

Set whether or not to highlight object tooltips (and potentially other scene entities).

checkShowFlag

public boolean checkShowFlag(int flag)

Check to see if the specified show flag is on.

getHoverObject

public Object getHoverObject()

Returns the top-most object over which the mouse is hovering; this may be a sprite or a SceneObject.

getHoverCoords

public Point getHoverCoords()

Returns the tile coordinates of the tile over which the mouse is hovering.

enumerateResolvedBlocks

public Iterator<SceneBlock> enumerateResolvedBlocks()

Returns an iterator over all resolved SceneBlock instances.

getBlock

public SceneBlock getBlock(int tx,
                           int ty)

Returns the resolved block that contains the specified tile coordinate or null if no block is resolved for that coordinate.

getPath

public Path getPath(Sprite sprite,
                    int x,
                    int y,
                    boolean loose)

Computes a path for the specified sprite to the specified tile coordinates.

Parameters:

loose - if true, an approximate path will be returned if a complete path cannot be located. This path will navigate the sprite "legally" as far as possible and then walk the sprite in a straight line to its final destination. This is generally only useful if the the path goes "off screen".

getScreenCoords

public Point getScreenCoords(int x,
                             int y)

Converts the supplied full coordinates to screen coordinates.

getFullCoords

public Point getFullCoords(int x,
                           int y)

Converts the supplied screen coordinates to full coordinates.

getTileCoords

public Point getTileCoords(int x,
                           int y)

Converts the supplied screen coordinates to tile coordinates.

clearRadialMenu

public void clearRadialMenu()

Clears any radial menu being displayed.

reportMemoryUsage

public void reportMemoryUsage()

Reports the memory usage of the resolved tiles in the current scene block.

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

pressObject

public void pressObject(SceneObject scobj)

Programmatically "click" a scene object. This results in a call to handleObjectPressed(com.threerings.miso.client.SceneObject, int, int) with click coordinates in the center of the object.

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

canTraverse

public boolean canTraverse(Object traverser,
                           int tx,
                           int ty)

Description copied from interface: AStarPathUtil.TraversalPred

Requests to know if the specified traverser (which was provided in the call to AStarPathUtil.getPath(TraversalPred,Object,int,int,int,int,int,boolean)) can traverse the specified tile coordinate.

Specified by:

canTraverse in interface AStarPathUtil.TraversalPred

getViewBounds

public Rectangle getViewBounds()

Description copied from class: VirtualMediaPanel

Returns the bounds of the viewport in virtual coordinates. The returned rectangle must not be modified.

Specified by:

getViewBounds in interface RadialMenu.Host

Overrides:

getViewBounds in class VirtualMediaPanel

getComponent

public Component getComponent()

Description copied from interface: FrameParticipant

If a frame participant wishes also to be actively rendered every frame rather than use passive rendering (which for Swing, at least, is hijacked when using the frame manager such that we take care of repainting dirty Swing components every frame into our off-screen buffer), it can return a component here which will have Component.paint(java.awt.Graphics) called on it once per frame with a translated but unclipped graphics object.

Because clipping is expensive in terms of rectangle object allocation, frame participants are given the opportunity to do their own clipping because they are likely to want to clip to a more fine grained region than their entire bounds. If a participant does not wish to be actively rendered, it can safely return null.

Specified by:

getComponent in interface RadialMenu.Host

Specified by:

getComponent in interface FrameParticipant

Overrides:

getComponent in class MediaPanel

repaintRect

public void repaintRect(int x,
                        int y,
                        int width,
                        int height)

Specified by:

repaintRect in interface RadialMenu.Host

menuDeactivated

public void menuDeactivated(RadialMenu menu)

Specified by:

menuDeactivated in interface RadialMenu.Host

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Overrides:

setBounds in class VirtualMediaPanel

computeInfluentialBounds

public static void computeInfluentialBounds(Rectangle visibleBounds,
                                            Rectangle influentualBounds,
                                            Rectangle visibleBlockBounds)

Configures influentialBounds to contain the bounds of the potentially "influential" world and visibleBlockBounds to contain bounds that are used to determine which blocks should be resolved before making the view visible.

Everything that intersects the influential area will be resolved on the expectation that it could be scrolled into view at any time. The influential bounds should be large enough that the time between a block becoming influential and the time at which it is resolved is longer than the expected time by which it will be scrolled into view, otherwise the users will see the man behind the curtain.

computeIndicators

public void computeIndicators()

Compute the indicators for any objects in the scene.

paint

public void paint(Graphics g)

Overrides:

paint in class MediaPanel