com.eteks.sweethome3d.swing

Class HomeComponent3D

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.eteks.sweethome3d.swing.HomeComponent3D

All Implemented Interfaces:

View, View3D, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable

public class HomeComponent3D
extends javax.swing.JComponent
implements View3D, java.awt.print.Printable

A component that displays home walls, rooms and furniture with Java 3D.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomeComponent3D.Projection

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface com.eteks.sweethome3d.viewcontroller.View

View.PointerType

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
HomeComponent3D(Home home) Creates a 3D component that displays home walls, rooms and furniture, with no controller.
HomeComponent3D(Home home, HomeController3D controller) Creates a 3D component that displays home walls, rooms and furniture.
HomeComponent3D(Home home, UserPreferences preferences, boolean displayShadowOnFloor) Creates a 3D component that displays home walls, rooms and furniture, with shadows on the floor.
HomeComponent3D(Home home, UserPreferences preferences, HomeController3D controller) Creates a 3D component that displays home walls, rooms and furniture.
HomeComponent3D(Home home, UserPreferences preferences, Object3DFactory object3dFactory, boolean displayShadowOnFloor, HomeController3D controller) Creates a 3D component that displays home walls, rooms and furniture.
HomeComponent3D(Home home, UserPreferences preferences, Object3DFactory object3dFactory, HomeComponent3D.Projection projection, HomeController3D controller) Creates a 3D component that displays home walls, rooms and furniture.
HomeComponent3D(Home home, UserPreferences preferences, Object3DFactory object3dFactory, HomeController3D controller) Creates a 3D component that displays home walls, rooms and furniture.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(java.awt.event.MouseListener l)
void	addMouseMotionListener(java.awt.event.MouseMotionListener l)
float[]	convertPixelLocationToVirtualWorld(int x, int y) Returns the 3D point matching the point (x, y) in component coordinates space.
void	endOffscreenImagesCreation() Frees unnecessary resources after the creation of a sequence of multiple offscreen images.
Selectable	getClosestItemAt(int x, int y) Deprecated. Use rather getClosestSelectableItemAt.
Selectable	getClosestSelectableItemAt(int x, int y) Returns the closest Selectable object at component coordinates (x, y), or null if not found.
Object3DFactory	getObject3DFactory() Returns the object factory used to create 3D objects.
java.awt.image.BufferedImage	getOffScreenImage(int width, int height) Returns an image of the home viewed by this component at the given size.
float[]	getVirtualWorldPointAt(int x, int y, float elevation) Returns the coordinates intersecting the floor of the selected level in the direction joining camera location and component coordinates (x, y).
int	print(java.awt.Graphics g, java.awt.print.PageFormat pageFormat, int pageIndex) Prints this component to make it fill pageFormat imageable size.
void	removeMouseListener(java.awt.event.MouseListener l)
void	removeMouseMotionListener(java.awt.event.MouseMotionListener l)
void	setVisible(boolean visible)
void	startOffscreenImagesCreation() Optimizes this component for the creation of a sequence of multiple off screen images.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, unregisterKeyboardAction, update, updateUI

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, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

HomeComponent3D

public HomeComponent3D(Home home)

Creates a 3D component that displays home walls, rooms and furniture, with no controller.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       HomeController3D controller)

Creates a 3D component that displays home walls, rooms and furniture.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       UserPreferences preferences,
                       boolean displayShadowOnFloor)

Creates a 3D component that displays home walls, rooms and furniture, with shadows on the floor.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       UserPreferences preferences,
                       HomeController3D controller)

Creates a 3D component that displays home walls, rooms and furniture.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       UserPreferences preferences,
                       Object3DFactory object3dFactory,
                       HomeController3D controller)

Creates a 3D component that displays home walls, rooms and furniture.

Parameters:

home - the home to display in this component

preferences - user preferences

object3dFactory - a factory able to create 3D objects from home items. The createObject3D of this factory is expected to return an instance of Object3DBranch in current implementation.

controller - the controller that manages modifications in home.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       UserPreferences preferences,
                       Object3DFactory object3dFactory,
                       boolean displayShadowOnFloor,
                       HomeController3D controller)

Creates a 3D component that displays home walls, rooms and furniture.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

HomeComponent3D

public HomeComponent3D(Home home,
                       UserPreferences preferences,
                       Object3DFactory object3dFactory,
                       HomeComponent3D.Projection projection,
                       HomeController3D controller)

Creates a 3D component that displays home walls, rooms and furniture.

Throws:

java.lang.IllegalStateException - if the 3D component couldn't be created.

Method Detail

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class javax.swing.JComponent

print

public int print(java.awt.Graphics g,
                 java.awt.print.PageFormat pageFormat,
                 int pageIndex)

Prints this component to make it fill pageFormat imageable size.

Specified by:

print in interface java.awt.print.Printable

startOffscreenImagesCreation

public void startOffscreenImagesCreation()

Optimizes this component for the creation of a sequence of multiple off screen images. Once off screen images are generated with getOffScreenImage, call endOffscreenImagesCreation method to free resources.

getOffScreenImage

public java.awt.image.BufferedImage getOffScreenImage(int width,
                                                      int height)

Returns an image of the home viewed by this component at the given size.

endOffscreenImagesCreation

public void endOffscreenImagesCreation()

Frees unnecessary resources after the creation of a sequence of multiple offscreen images.

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)

Overrides:

addMouseMotionListener in class java.awt.Component

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)

Overrides:

removeMouseMotionListener in class java.awt.Component

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)

Overrides:

addMouseListener in class java.awt.Component

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)

Overrides:

removeMouseListener in class java.awt.Component

getClosestItemAt

public Selectable getClosestItemAt(int x,
                                   int y)

Deprecated. Use rather getClosestSelectableItemAt.

Returns the closest Selectable object at component coordinates (x, y), or null if not found.

getClosestSelectableItemAt

public Selectable getClosestSelectableItemAt(int x,
                                             int y)

Returns the closest Selectable object at component coordinates (x, y), or null if not found.

Specified by:

getClosestSelectableItemAt in interface View3D

convertPixelLocationToVirtualWorld

public float[] convertPixelLocationToVirtualWorld(int x,
                                                  int y)

Returns the 3D point matching the point (x, y) in component coordinates space.

Specified by:

convertPixelLocationToVirtualWorld in interface View3D

getVirtualWorldPointAt

public float[] getVirtualWorldPointAt(int x,
                                      int y,
                                      float elevation)

Returns the coordinates intersecting the floor of the selected level in the direction joining camera location and component coordinates (x, y).

Specified by:

getVirtualWorldPointAt in interface View3D

getObject3DFactory

public Object3DFactory getObject3DFactory()

Returns the object factory used to create 3D objects.