Skip navigation links
LuciadLightspeed
2021.0.07
com.luciad.view.lightspeed.swing.navigationcontrols

LuciadLightspeedClass TLspCompassNavigationControl

    • Nested Class Summary

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

        javax.swing.JPanel.AccessibleJPanel
      • 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
    • 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.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    • Constructor Summary

      Constructors 
      Constructor and Description
      TLspCompassNavigationControl(ILspView aView)
      A constructor for the compass component of the navigation controls for a ILspView.
      TLspCompassNavigationControl(java.lang.String aImagePath, ILspView aView)
      A constructor for the compass component of the navigation controls for a ILspView using the given image path and view.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      protected void angleChanged()
      This method is called whenever the angle has been changed by direct interaction with the component (received mouse events).
      java.awt.Dimension getMaximumSize()
      Returns the dimension specified by the images used.
      java.awt.Dimension getMinimumSize()
      Returns the dimension specified by the images used.
      java.awt.Dimension getPreferredSize()
      Returns the dimension specified by the images used.
      protected void interactionStarted()
      This method will be called when the mouse starts interacting with the panel (except when it's interacting with the draggable rotation ring).
      protected void interactionTerminated()
      This method will be called when the mouse stops interacting with the panel.
      boolean isInnerRingPan()
      Returns the behavior when the inside ring of the compass navigation is used.
      void setInnerRingPan(boolean aInnerRingPan)
      Indicates what view navigation needs to happen when the inside ring of the compass navigation is used.
      void setMaxAnimationDuration(double aAnimationDuration)
      Sets the maximum duration of the animation used when resetting the orientation to north.
      void setMinAnimationDuration(double aAnimationDuration)
      Sets the minimum duration of the animation used when resetting the orientation to north.
      • 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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TLspCompassNavigationControl

        public TLspCompassNavigationControl(ILspView aView)
                                     throws java.io.IOException
        A constructor for the compass component of the navigation controls for a ILspView. The constructor also loads the necessary images and will initialize all the subcomponents of the panel.
        Parameters:
        aView - The view this panel will interact with
        Throws:
        java.io.IOException - when one of the necessary images is missing
        Since:
        2019.0.05
      • TLspCompassNavigationControl

        public TLspCompassNavigationControl(java.lang.String aImagePath,
                                            ILspView aView)
                                     throws java.io.IOException
        A constructor for the compass component of the navigation controls for a ILspView using the given image path and view. The constructor also loads the necessary images and will initialize all the subcomponents of the panel.

        Parameters:
        aImagePath - The (relative or absolute) path to the directory where the images are stored.
        aView - The view this panel will interact with.
        Throws:
        java.io.IOException - when one of the necessary images is missing.
    • Method Detail

      • isInnerRingPan

        public boolean isInnerRingPan()
        Returns the behavior when the inside ring of the compass navigation is used.
        Returns:
        the current behavior, true for panning, false for rotation
        See Also:
        setInnerRingPan(boolean)
      • setInnerRingPan

        public void setInnerRingPan(boolean aInnerRingPan)
        Indicates what view navigation needs to happen when the inside ring of the compass navigation is used.
        • false will trigger rotation (and pitching in a 3D view). This is the default.
        • true will trigger panning.
        Parameters:
        aInnerRingPan - true for panning, false for rotation
      • setMinAnimationDuration

        public void setMinAnimationDuration(double aAnimationDuration)
        Sets the minimum duration of the animation used when resetting the orientation to north. The actual duration will be linearly interpolated between the minimum and maximum duration based in the difference between the current angle and the north.

        By default, the minimum duration is 0.5 second. Set both this and the setMaxAnimationDuration(double) maximum duration } to 0 if no animation is required.

        Parameters:
        aAnimationDuration - expressed in seconds.
        See Also:
        setMaxAnimationDuration(double)
      • setMaxAnimationDuration

        public void setMaxAnimationDuration(double aAnimationDuration)
        Sets the maximum duration of the animation used when resetting the orientation to north. The actual duration will be linearly interpolated between the minimum and maximum duration based on the difference between the current angle and the north.

        By default, the duration is 1.5 second. et both this and the setMinAnimationDuration(double) minimum duration } to 0 if no animation is required.

        Parameters:
        aAnimationDuration - expressed in seconds.
        See Also:
        setMinAnimationDuration(double)
      • getPreferredSize

        public java.awt.Dimension getPreferredSize()
        Returns the dimension specified by the images used.
        Overrides:
        getPreferredSize in class javax.swing.JComponent
        Returns:
        the size of the images this panel is a based on.
      • getMinimumSize

        public java.awt.Dimension getMinimumSize()
        Returns the dimension specified by the images used.
        Overrides:
        getMinimumSize in class javax.swing.JComponent
        Returns:
        the size of the images this panel is a based on.
      • getMaximumSize

        public java.awt.Dimension getMaximumSize()
        Returns the dimension specified by the images used.
        Overrides:
        getMaximumSize in class javax.swing.JComponent
        Returns:
        the size of the images this panel is based on.
LuciadLightspeed
2021.0.07