tsc_PointStakeoutConfigFormEventArgs

This class is an interface which is passed to the OnInitialConfig event handler which is invoked just before the stakeout configuration form is displayed at the start of the stakeout process.  The interface contains a number of methods for obtaining information about the configuration, and for changing the configuration.

Note that although the methods on these interfaces are abstract, they are implemented in the instance passed to the event handler.

Public members

tsc_PointStakeoutGetOptionsInterface& GetOptions;

This is  reference to another interface class which provides information about the current stakeout configuration.  The settings represent the default values that will be used for the form and/or stakeout, and they may be modified by other methods in this class.

tsc_PointStakeoutSetOptionsInterface& SetOptions;

This is a reference to an interface which has methods for changing stakeout options.

virtual void ShowConfigForm (bool show);

Controls whether the config form is displayed or not.  In some cases, such as when there is no antenna height, the form will be shown regardless of the value supplied. The form's fields will reflect the configuration set by the methods in this class. If the form is suppressed then the configuration set by the other methods in this interface are used for the stakeout.

virtual void ShowOptionsSoftkey (bool show);

Controls whether the options softkey is shown on the navigation screen and on the initial configuration form.  The default is true; if false is specified then the plugin must supply it's own way for the user to control the options.

virtual void SetMethodToThePoint ();

Sets the stakeout method to "To the point". This is the only method available when using a conventional instrument.

virtual void SetMethodFromPoint (const char* pointName);

Sets the stakeout method to "From point", and sets the 'from' point name. This method will be ignored if a conventional instrument is being used.

virtual void SetMethodRelativeToAzimuth (double azimuth);

Sets the stakeout method to "Relative to azimuth", and sets the azimuth to be used, measured in radians from North.  This method will be ignored if a conventional instrument is being used.