com.luciad.lucy.addons.bci.lightspeed

LuciadLightspeedClass TLcyLspBCIFormatAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyPreferencesAddOn

com.luciad.lucy.addons.lightspeed.ALcyLspFormatAddOn

com.luciad.lucy.addons.bci.lightspeed.TLcyLspBCIFormatAddOn

public class TLcyLspBCIFormatAddOn
extends ALcyLspFormatAddOn

Add-on which provides the ALcyLspFormat responsible for the visualization of BCI models.

Since:

2012.0

Constructor Summary

Constructors

Constructor and Description
TLcyLspBCIFormatAddOn() Default constructor

Method Summary

Modifier and Type	Method and Description
protected ALcyLspFormat	createBaseFormat() Returns a new data format for this add-on.
protected ALcyLspFormat	createFormatWrapper(ALcyLspFormat aBaseFormat) Returns a new data format wrapper for this add-on.
void	plugInto(ILcyLucyEnv aLucyEnv) Creates and plugs in the add-on's format and preferences tool.

Methods inherited from class com.luciad.lucy.addons.lightspeed.ALcyLspFormatAddOn

createFormatTool, getFormat, unplugFrom

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

Constructor Detail

TLcyLspBCIFormatAddOn

public TLcyLspBCIFormatAddOn()

Default constructor

Method Detail

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyLspFormatAddOn

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

Overrides:

plugInto in class ALcyLspFormatAddOn

Parameters:

aLucyEnv - the Lucy environment to plug into

See Also:

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

createBaseFormat

protected ALcyLspFormat createBaseFormat()

Description copied from class: ALcyLspFormatAddOn

Returns a new data format for this add-on. Override this method to extend the default format with new functionality.

For example, to alter the icon of the layers of this format, you can decorate the layer factory created in the format:

 @Override
 protected ALcyLspFormat createBaseFormat() {
   return new ALcyLspFormatWrapper(super.createBaseFormat()){
     @Override
     protected ILspLayerFactory createLayerFactory(){
       final ILspLayerFactory delegate = super.createLayerFactory();
       return new ILspLayerFactory(){
         @Override
         public boolean canCreateLayers(ILcdModel aModel){
           return delegate.canCreateLayers(aModel);
         }

         @Override
         public Collection<ILspLayer> createLayers(ILcdModel aModel){
           Collection<ILspLayer> layers = delegate.createLayers(aModel);
           for(ILspLayer layer : layers){
             ILcdIcon icon = ...;
             layer.setIcon(icon)
           }
           return layers;
         }
       }
     }
   }
 }
 

Specified by:

createBaseFormat in class ALcyLspFormatAddOn

Returns:

a new format for this add-on

createFormatWrapper

protected final ALcyLspFormat createFormatWrapper(ALcyLspFormat aBaseFormat)

Description copied from class: ALcyLspFormatAddOn

Returns a new data format wrapper for this add-on. A format wrapper extends the base format with aspects such as safe guarding, etc.

Overriding this method of an existing add-on should be done with extreme care as add-ons typically rely on the wrappers that should be present (e.g. a safe guard).

Specified by:

createFormatWrapper in class ALcyLspFormatAddOn

Parameters:

aBaseFormat - the base format to wrap

Returns:

a new format for this add-on

See Also:

ALcyLspFormatWrapper