com.threerings.media

Class VirtualMediaPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.threerings.media.MediaPanel

com.threerings.media.VirtualMediaPanel

All Implemented Interfaces:

FrameParticipant, MediaConstants, MediaHost, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

MisoScenePanel

public class VirtualMediaPanel
extends MediaPanel

Extends the base media panel with the notion of a virtual coordinate system. All entities in the virtual media panel have virtual coordinates and the virtual media panel displays a window into that virtual view. The panel can be made to scroll by adjusting the view offset slightly at the start of each tick and it will efficiently copy the unmodified view data and generate repaint requests for the exposed regions.

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 byte	CENTER_ON_PATHABLE The code for the pathable following mode wherein we keep the view centered on the pathable's location.
static byte	ENCLOSE_PATHABLE The code for the pathable following mode wherein we ensure that the marked pathable is always kept within the visible bounds of the view.
static byte	TRACK_PATHABLE The code for the pathable following mode wherein we set the upper-left corner of the view to the coordinates of the 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
VirtualMediaPanel(FrameManager framemgr) Constructs a virtual media panel.

Method Summary

Modifier and Type	Method and Description
void	addViewTracker(ViewTracker tracker) Adds an entity that will be informed when the view scrolls.
void	clearPathable() Clears out the pathable that was being enclosed or followed due to a previous call to setFollowsPathable(com.threerings.media.util.Pathable, byte).
void	doLayout()
Rectangle	getViewBounds() Returns the bounds of the viewport in virtual coordinates.
void	removeViewTracker(ViewTracker tracker) Removes an entity from the view trackers list.
void	setBackground(Mirage background) Set a background image to tile the background of the media panel.
void	setBounds(int x, int y, int width, int height)
void	setFollowsPathable(Pathable pable, byte followMode) Instructs the view to follow the supplied pathable; ensuring that the view's coordinates are adjusted according to the follow mode.
void	setViewLocation(int x, int y) Sets the upper-left coordinate of the view port in virtual coordinates.

Methods inherited from class com.threerings.media.MediaPanel

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

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, removeNotify, 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

CENTER_ON_PATHABLE

public static final byte CENTER_ON_PATHABLE

The code for the pathable following mode wherein we keep the view centered on the pathable's location.

See Also:

Constant Field Values

ENCLOSE_PATHABLE

public static final byte ENCLOSE_PATHABLE

The code for the pathable following mode wherein we ensure that the marked pathable is always kept within the visible bounds of the view.

See Also:

Constant Field Values

TRACK_PATHABLE

public static final byte TRACK_PATHABLE

The code for the pathable following mode wherein we set the upper-left corner of the view to the coordinates of the pathable.

See Also:

Constant Field Values

Constructor Detail

VirtualMediaPanel

public VirtualMediaPanel(FrameManager framemgr)

Constructs a virtual media panel.

Method Detail

setBackground

public void setBackground(Mirage background)

Set a background image to tile the background of the media panel.

setViewLocation

public void setViewLocation(int x,
                            int y)

Sets the upper-left coordinate of the view port in virtual coordinates. The view will be as efficient as possible about repainting itself to achieve this new virtual location (meaning that if we need only to move one pixel to the left, it will use Graphics.copyArea(int, int, int, int, int, int) to move our rendered view over one pixel and generate a dirty region for the exposed area). The new location will not take effect until the view is MediaPanel.tick(long)ed, so only the last call to this method during a tick will have any effect.

getViewBounds

public Rectangle getViewBounds()

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

Overrides:

getViewBounds in class MediaPanel

addViewTracker

public void addViewTracker(ViewTracker tracker)

Adds an entity that will be informed when the view scrolls.

removeViewTracker

public void removeViewTracker(ViewTracker tracker)

Removes an entity from the view trackers list.

setFollowsPathable

public void setFollowsPathable(Pathable pable,
                               byte followMode)

Instructs the view to follow the supplied pathable; ensuring that the view's coordinates are adjusted according to the follow mode.

Parameters:

pable - the pathable to follow.

followMode - the strategy for keeping the pathable in view.

clearPathable

public void clearPathable()

Clears out the pathable that was being enclosed or followed due to a previous call to setFollowsPathable(com.threerings.media.util.Pathable, byte).

doLayout

public void doLayout()

Overrides:

doLayout in class Container

setBounds

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

Overrides:

setBounds in class Component