videoRangePanel.vrmethods

Interface VRMethod

All Known Implementing Classes:

AbstractVRMethod, AddCalibrationMethod, IMUMethod, LocalisationCalc, VRHorizonMethod, VRLandMarkMethod, VRShoreMethod

public interface VRMethod

Method Summary

Methods

Modifier and Type	Method and Description
void	clearOverlay() Clears all user ineractions and resets overlay.
javax.swing.plaf.LayerUI	getJLayerOverlay() Get the overlay panel for the picture unique to this method.
java.lang.String	getName() The name of this type of analysis method.
PamPanel	getRibbonPanel() Some methods may require a panel above the picture for manual input or to view current information.
PamPanel	getSettingsPanel() Different video range methods will have different settings.
PamPanel	getSidePanel() Different video range methods will have different controls in the side panel.
void	update(int updateType) Called from other parts of the module whenever a method panel may needed updated e.g.

Method Detail

getName

java.lang.String getName()

The name of this type of analysis method.

Returns:

getSidePanel

PamPanel getSidePanel()

Different video range methods will have different controls in the side panel. This returns the side panel unique to the method. May return null if no panel is needed.

Returns:

getJLayerOverlay

javax.swing.plaf.LayerUI getJLayerOverlay()

Get the overlay panel for the picture unique to this method. In general this will be a translucent panel which will be placed over the picture and will include the interactions for the method. Layer Ui's can be used for a variety of purposes, including adding wait animations etc.

Returns:

clearOverlay

void clearOverlay()

Clears all user ineractions and resets overlay. Required for changes to settings, picture being changed and other interactions not directly associated with the VRMethod.

getRibbonPanel

PamPanel getRibbonPanel()

Some methods may require a panel above the picture for manual input or to view current information. getRibbonPanel() returns the panel unique to this method which may go above the picture. May return null if no panel is needed.

Returns:

getSettingsPanel

PamPanel getSettingsPanel()

Different video range methods will have different settings. This panel provide the vr specific settings in the vr settings dialog panel.

Returns:

update

void update(int updateType)

Called from other parts of the module whenever a method panel may needed updated e.g. when new calibration data is manually added in the settings dialog.

Parameters:

updateType -