com.luciad.lucy.addons.debug

LuciadLightspeedClass TLcyDebugAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyPreferencesAddOn

com.luciad.lucy.addons.debug.TLcyDebugAddOn

public class TLcyDebugAddOn
extends ALcyPreferencesAddOn

This add-on adds debugging information to the user interface.

Functionality:

The following options and functionality are added to the Lucy user interface when this add-on is used.

• Easily enable performance monitoring using JConsole. This is also explained in detail in the LuciadLightspeed Developer's Guide.
• Debug actions. Provides tool tips on all tool bar and menu bar buttons with their configuration options. The menu and tool bars themselves get a shiny border and tool tip with their action bar ID, used to configure actions into it. See also the logging explanation of ALcyActionBar.
• Debug asynchronous painting and paint queue assignment. This is the same as enabling logging for TLcdGXYBusyLayerTreeNodeCellRenderer.
• Check for Swing threading violations by replacing the RepaintManager by one which checks whether the current Thread is the Event Dispatch Thread, and logs a warning otherwise.
• Open the developer guide through the Lucy UI
• Print the layer types and model content types of the layers in a view.
For non-gxy layers (e.g. Lightspeed), only the model content type is printed.
• Shows a performance overlay layer for Lightspeed maps. It for example shows the maximum possible frame rate in the top left corner (in reality, it might be clamped to a lower value to limit resource consumption).
• Shows a GL resource overlay layer for Lightspeed maps. It shows the usage of the OpenGL resources.
• Inspect a workspace file. Workspace files are a hierarchical structure of data blocks. These blocks are displayed as expandable nodes in a tree, showing their content when expanded. Nodes starting with % are object references, encoded with ALcyWorkspaceCodec.encodeReference(java.lang.Object, java.lang.Object). Other nodes list the UID of the ALcyWorkspaceCodecDelegate that has written them.
• Open the developer guide through the Lucy UI
• Print the registered actions and active settables in the TLcyActionBarManager.

Its menu items can be found in the debug menu. Its behavior and API can change in any version.

Activating the add-on in your IDE

This add-on is by default included in the addons.xml file. However, this is not sufficient to actually load the add-on. The functionality offered by this add-on will only become available when the system property 'lucy.debug' is set to true. This is done by specifying the following on the command-line:

   -Dlucy.debug=true
 

This allows to conveniently switch the add-on on and off,without making any changes to your project files.

Should you want to permanently disable this functionality, simply remove this add-on from the addons.xml file.

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	LUCY_DEBUG System property which determines whether this add-on will be loaded or not

Constructor Summary

Constructors

Constructor and Description
TLcyDebugAddOn() Default constructor

Method Summary

Modifier and Type	Method and Description
void	plugInto(ILcyLucyEnv aLucyEnv) Creates and plugs in the add-on's preferences tool.
void	unplugFrom(ILcyLucyEnv aLucyEnv) Unplugs the add-on's preferences tool.

Methods inherited from class com.luciad.lucy.addons.ALcyPreferencesAddOn

createPreferencesTool, getLongPrefix, getLucyEnv, getPreferences, getPreferencesTool, getShortPrefix

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Field Detail

LUCY_DEBUG

public static final String LUCY_DEBUG

System property which determines whether this add-on will be loaded or not

See Also:

Constant Field Values

Constructor Detail

TLcyDebugAddOn

public TLcyDebugAddOn()

Default constructor

Method Detail

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyPreferencesAddOn

Creates and plugs in the add-on's preferences tool.

Overrides:

plugInto in class ALcyPreferencesAddOn

Parameters:

aLucyEnv - the Lucy environment to plug into

See Also:

ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

unplugFrom

public void unplugFrom(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyPreferencesAddOn

Unplugs the add-on's preferences tool.

Overrides:

unplugFrom in class ALcyPreferencesAddOn

Parameters:

aLucyEnv - the Lucy environment

See Also:

ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)