Plugin Header

From World Wind Wiki

Revision as of 11:53, 13 February 2007 by Mkpl (Talk | contribs)
Jump to: navigation, search

The plugin header is used by World Wind to present information about the plugin to the user before compiling/loading it, and also contains compiler related information when needed. The header isn't required, but recommended. One or more fields may also be omitted. NOTE: The header is read when World Wind loads. Changes to the header will not be reflected until the application is reloaded.

Contents

Sample Header

//----------------------------------------------------------------------------
// NAME: Joystick control
// VERSION: 1.0
// REFERENCES: Microsoft.DirectX.DirectInput.dll
// DESCRIPTION: Allow World Wind to be controlled by joystick/game controller
// DEVELOPER: John Doe
// WEBSITE: http://www.com
// REFERENCES: Microsoft.DirectX.DirectInput, MyCoordinateSystemLibrary.dll
//----------------------------------------------------------------------------

Fields

Name

A short name for the plugin.

Version

The plugin version number string

Description

A longer description of the plugin functionality.

Developer

The name(s) of the plugin developer(s).

WebSite

An URL pointing to the "home" of the plugin.

References

A comma separated list of additional libraries the plugin needs a refence to. These might be local (plugin directory) assemblies, or system wide assemblies located in the Glocal Assembly Cache. For local assemblies filename (no path) including extension (usually .dll) must be specified. For global assemblies omit the extension.

The sample on the top of this page requests references to the Managed DirectX assembly Microsoft.DirectX.DirectInput.dll in the GAC and a local assembly MyCoordinateSystemLibrary.dll located in the directory of the plugin.

Personal tools