Plugin FAQ

From World Wind Wiki

Revision as of 00:35, 25 June 2005 (edit) Nosilleg (Talk | contribs) m (removed cat:dev) ← Previous diff		Revision as of 20:49, 25 June 2005 (edit) (undo) Mashiharu (Talk | contribs) (→How-to) Next diff →
Line 16:		Line 16:
	==How-to==		==How-to==
		+
		+	===How do I subscribe to the event that fires when vertical exaggeration changes===
		+
		+	Currently events aren't used in World Wind. If you are writing a layer you can instead in the Update method store the current vertical exaggeration value. Next time your update method is called (by the background worker thread) you check if it has changed.
	===How do I access the layer list (renderable objects)===		===How do I access the layer list (renderable objects)===

---

Revision as of 20:49, 25 June 2005

Contents 1 General 1.1 Is it possible to run binary plugins 1.2 Which programming languages are supported 2 Troubleshooting 2.1 Why doesn't World Wind unload my plugin cleanly 3 How-to 3.1 How do I subscribe to the event that fires when vertical exaggeration changes 3.2 How do I access the layer list (renderable objects) 3.3 How do I get the location of WW's main directory 3.4 How do I reference additional assemblies from my plugin 3.5 How do I add my own property dialog for a layer 3.6 How do I remote control World Wind 3.7 How do I retrieve the current position 3.8 How do I detect what directory my plugin was loaded from

General

Is it possible to run binary plugins

In addition to loading source code plugins World Wind also probes for .dll files inside the Plugins directory that implement the plugin interface. If found they will be displayed in the Plugin Dialog.

Which programming languages are supported

Currently, VB.net, C# and JScript.net in addition to pre-compiled binary plugins.

Troubleshooting

Why doesn't World Wind unload my plugin cleanly

It is the responsibilty of the plugin to restore World Wind to the original state when the plugin is unloaded. For example if the plugin adds menu items, the plugin must remove those menu items when unloading.

How-to

How do I subscribe to the event that fires when vertical exaggeration changes

Currently events aren't used in World Wind. If you are writing a layer you can instead in the Update method store the current vertical exaggeration value. Next time your update method is called (by the background worker thread) you check if it has changed.

How do I access the layer list (renderable objects)

ParentApplication.WorldWindow.CurrentWorld.ChildObjects

This RenderableObjectList contains a collection of RenderableObjects and RenderableObjectLists making it a tree.

How do I get the location of WW's main directory

MainApplication.DirectoryPath

How do I reference additional assemblies from my plugin

Use the REFERENCES keyword in the Plugin Header.

How do I add my own property dialog for a layer

Override OnPropertiesClick for example like this:

/// <summary>
/// Layer properties context menu item
/// </summary>
protected virtual void OnPropertiesClick(object sender, System.EventArgs e)
{
  if(m_propertyBrowser!=null)
    m_propertyBrowser.Dispose();
  m_propertyBrowser = new MyFancyPropertyDialog(this);
  m_propertyBrowser.Show();
}

How do I remote control World Wind

ParentApplication.WorldWindow.GotoLatLonAltitude(50.94299, 6.96291, 10000)

How do I retrieve the current position

ParentApplication.WorldWindow.DrawArgs.WorldCamera.Latitude
ParentApplication.WorldWindow.DrawArgs.WorldCamera.Longitude

How do I detect what directory my plugin was loaded from

The Plugin base class has a property PluginDirectory that contains the path from which the plugin was loaded. This path may be used to find any additional files you may want to load.

this.PluginDirectory