mirror of
https://github.com/SCToolsfactory/SCJMapper-V2.git
synced 2024-11-10 13:10:25 +00:00
325 lines
12 KiB
C#
325 lines
12 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Xml;
|
|
using System.IO;
|
|
using System.Xml.Linq;
|
|
using System.Windows.Forms;
|
|
|
|
namespace SCJMapper_V2.Devices.Options
|
|
{
|
|
/// <summary>
|
|
/// Maintains an Options - something like:
|
|
///
|
|
/// <options type="joystick" instance="1">
|
|
/// <!-- Make all piloting input linear -->
|
|
/// <pilot exponent="1" />
|
|
/// </options>
|
|
///
|
|
/// <options type="joystick" instance="2" >
|
|
/// <flight_move_strafe_longitudinal invert="1" />
|
|
/// </options>
|
|
///
|
|
/// [type] : set to shared, keyboard, xboxpad, or joystick
|
|
/// [instance] : set to the device number; js1=1, js2=2, etc
|
|
/// [optiongroup] : set to what group the option should affect (for available groups see default actionmap)
|
|
/// [option] : instance, sensitivity, exponent, nonlinearity *instance is a bug that will be fixed to 'invert' in the future
|
|
/// [value] : for invert use 0/1; for others use 0.0 to 2.0
|
|
///
|
|
/// options are given per deviceClass and instance - it seems
|
|
/// </summary>
|
|
public class OptionTree : ICloneable
|
|
{
|
|
private static readonly log4net.ILog log = log4net.LogManager.GetLogger( System.Reflection.MethodBase.GetCurrentMethod( ).DeclaringType );
|
|
|
|
|
|
// Support only one set of independent options (string storage)
|
|
List<string> m_stringOptions = new List<string>( );
|
|
|
|
// bag for all tuning items - key is the option name
|
|
CloneableDictionary<string, DeviceTuningParameter> m_tuning = new CloneableDictionary<string, DeviceTuningParameter>( );
|
|
|
|
|
|
|
|
/// <summary>
|
|
/// Clone this object
|
|
/// </summary>
|
|
/// <returns>A deep Clone of this object</returns>
|
|
public object Clone()
|
|
{
|
|
var ot = (OptionTree)this.MemberwiseClone( );
|
|
// more objects to deep copy
|
|
ot.m_stringOptions = new List<string>( m_stringOptions );
|
|
if ( this.m_tuning != null ) ot.m_tuning = (CloneableDictionary<string, DeviceTuningParameter>)this.m_tuning.Clone( );
|
|
|
|
return ot;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check clone against This
|
|
/// </summary>
|
|
/// <param name="clone"></param>
|
|
/// <returns>True if the clone is identical but not a shallow copy</returns>
|
|
internal bool CheckClone( OptionTree clone )
|
|
{
|
|
bool ret = true;
|
|
// object vars first
|
|
ret &= ( !object.ReferenceEquals( this.m_stringOptions, clone.m_stringOptions ) ); // shall not be the same object !!
|
|
|
|
// check m_tuning Dictionary
|
|
ret &= ( this.m_tuning.Count == clone.m_tuning.Count );
|
|
if ( ret ) {
|
|
for ( int i = 0; i < this.m_tuning.Count; i++ ) {
|
|
ret &= ( this.m_tuning.ElementAt( i ).Key == clone.m_tuning.ElementAt( i ).Key );
|
|
|
|
ret &= ( !object.ReferenceEquals( this.m_tuning.ElementAt( i ).Value, clone.m_tuning.ElementAt( i ).Value ) ); // shall not be the same object !!
|
|
ret &= ( this.m_tuning.ElementAt( i ).Value.CheckClone( clone.m_tuning.ElementAt( i ).Value ) );
|
|
}
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
|
|
|
|
|
|
// ctor
|
|
public OptionTree( DeviceCls device )
|
|
{
|
|
m_tuning.Add( "flight_move_pitch", new DeviceTuningParameter( "flight_move_pitch", device ) );
|
|
m_tuning.Add( "flight_move_yaw", new DeviceTuningParameter( "flight_move_yaw", device ) );
|
|
m_tuning.Add( "flight_move_roll", new DeviceTuningParameter( "flight_move_roll", device ) );
|
|
m_tuning.Add( "flight_move_strafe_vertical", new DeviceTuningParameter( "flight_move_strafe_vertical", device ) );
|
|
m_tuning.Add( "flight_move_strafe_lateral", new DeviceTuningParameter( "flight_move_strafe_lateral", device ) );
|
|
m_tuning.Add( "flight_move_strafe_longitudinal", new DeviceTuningParameter( "flight_move_strafe_longitudinal", device ) );
|
|
|
|
m_tuning.Add( "flight_throttle_abs", new DeviceTuningParameter( "flight_throttle_abs", device ) );
|
|
m_tuning.Add( "flight_throttle_rel", new DeviceTuningParameter( "flight_throttle_rel", device ) );
|
|
|
|
m_tuning.Add( "flight_aim_pitch", new DeviceTuningParameter( "flight_aim_pitch", device ) );
|
|
m_tuning.Add( "flight_aim_yaw", new DeviceTuningParameter( "flight_aim_yaw", device ) );
|
|
|
|
m_tuning.Add( "flight_view_pitch", new DeviceTuningParameter( "flight_view_pitch", device ) );
|
|
m_tuning.Add( "flight_view_yaw", new DeviceTuningParameter( "flight_view_yaw", device ) );
|
|
|
|
m_tuning.Add( "turret_aim_pitch", new DeviceTuningParameter( "turret_aim_pitch", device ) );
|
|
m_tuning.Add( "turret_aim_yaw", new DeviceTuningParameter( "turret_aim_yaw", device ) );
|
|
|
|
// Gamepad specific
|
|
if ( Devices.Gamepad.GamepadCls.IsDeviceClass( device.DevClass ) ) {
|
|
m_tuning.Add( "fps_view_pitch", new DeviceTuningParameter( "fps_view_pitch", device ) );
|
|
m_tuning.Add( "fps_view_yaw", new DeviceTuningParameter( "fps_view_yaw", device ) );
|
|
|
|
m_tuning.Add( "fps_move_lateral", new DeviceTuningParameter( "fps_move_lateral", device ) );
|
|
m_tuning.Add( "fps_move_longitudinal", new DeviceTuningParameter( "fps_move_longitudinal", device ) );
|
|
|
|
m_tuning.Add( "mgv_view_pitch", new DeviceTuningParameter( "mgv_view_pitch", device ) );
|
|
m_tuning.Add( "mgv_view_yaw", new DeviceTuningParameter( "mgv_view_yaw", device ) );
|
|
}
|
|
}
|
|
|
|
|
|
public int Count
|
|
{
|
|
get { return ( m_stringOptions.Count + 1 ); }
|
|
}
|
|
|
|
public void ResetDynamicItems()
|
|
{
|
|
foreach ( KeyValuePair<string, DeviceTuningParameter> kv in m_tuning ) {
|
|
DeviceTuningParameter item = kv.Value;
|
|
if ( item != null ) {
|
|
item.ResetDynamicItems( );
|
|
}
|
|
}
|
|
}
|
|
|
|
// provide access to Tuning items
|
|
|
|
|
|
/// <summary>
|
|
/// Returns a tuning item for the asked option
|
|
/// </summary>
|
|
/// <param name="optionName">The option to get</param>
|
|
/// <returns>A DeviceTuning item or null if it does not exist</returns>
|
|
public DeviceTuningParameter TuningItem( string optionName )
|
|
{
|
|
if ( m_tuning.ContainsKey( optionName ) )
|
|
return m_tuning[optionName];
|
|
else
|
|
return null;
|
|
}
|
|
|
|
|
|
|
|
private string[] FormatXml( string xml )
|
|
{
|
|
try {
|
|
XDocument doc = XDocument.Parse( xml );
|
|
return doc.ToString( ).Split( new string[] { string.Format( "\n" ) }, StringSplitOptions.RemoveEmptyEntries );
|
|
}
|
|
catch ( Exception ) {
|
|
return new string[] { xml };
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Dump the Options as partial XML nicely formatted
|
|
/// </summary>
|
|
/// <returns>the action as XML fragment</returns>
|
|
public string toXML()
|
|
{
|
|
string r = "";
|
|
|
|
// and dump the contents of plain string options
|
|
foreach ( string x in m_stringOptions ) {
|
|
|
|
if ( !string.IsNullOrWhiteSpace( x ) ) {
|
|
foreach ( string line in FormatXml( x ) ) {
|
|
r += string.Format( "\t{0}", line );
|
|
}
|
|
}
|
|
|
|
r += string.Format( "\n" );
|
|
}
|
|
|
|
// dump Tuning
|
|
foreach ( KeyValuePair<string, DeviceTuningParameter> kv in m_tuning ) {
|
|
r += kv.Value.Options_toXML( );
|
|
}
|
|
|
|
return r;
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
/// Read an Options from XML - do some sanity check
|
|
/// </summary>
|
|
/// <param name="xml">the XML action fragment</param>
|
|
/// <returns>True if an action was decoded</returns>
|
|
public bool fromXML( XElement options )
|
|
{
|
|
/*
|
|
* This can be a lot of the following options
|
|
* try to do our best....
|
|
*
|
|
* <options type="joystick" instance="1">
|
|
<pilot_rot_moveyaw instance="1" sensitivity="0.8" exponent="1.2" />
|
|
</options>
|
|
|
|
*
|
|
<options type="joystick" instance="1">
|
|
<flight>
|
|
<nonlinearity_curve>
|
|
<point in="0.1" out="0.001"/>
|
|
<point in="0.25" out="0.02"/>
|
|
<point in="0.5" out="0.1"/>
|
|
<point in="0.75" out="0.125"/>
|
|
<point in="0.85" out="0.15"/>
|
|
<point in="0.90" out="0.175"/>
|
|
<point in="0.925" out="0.25"/>
|
|
<point in="0.94" out="0.45"/>
|
|
<point in="0.95" out="0.75"/>
|
|
</nonlinearity_curve>
|
|
</flight>
|
|
</options>
|
|
|
|
*/
|
|
string instance = (string)options.Attribute( "instance" ); // mandadory
|
|
string type = (string)options.Attribute( "type" ); // mandadory
|
|
if ( !int.TryParse( instance, out int nInstance ) ) nInstance = 0;
|
|
|
|
// try to disassemble the items
|
|
/*
|
|
* <flight> instance="0/1" sensitivity="n.nn" exponent="n.nn" (instance should be invert)
|
|
* <flight_move>
|
|
* <flight_move_pitch>
|
|
* <flight_move_yaw>
|
|
* <flight_move_roll>
|
|
* <flight_move_strafe_vertical>
|
|
* <flight_move_strafe_lateral>
|
|
* <flight_move_strafe_longitudinal>
|
|
* <flight_throttle> invert="0/1"
|
|
* <flight_throttle_abs>
|
|
* <flight_throttle_rel>
|
|
* <flight_aim>
|
|
* <flight_aim_pitch>
|
|
* <flight_aim_yaw>
|
|
* <flight_view>
|
|
* <flight_view_pitch>
|
|
* <flight_view_yaw>
|
|
*
|
|
*
|
|
<nonlinearity_curve>
|
|
<point in="0.1" out="0.001"/>
|
|
* ..
|
|
</nonlinearity_curve>
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
foreach ( XElement item in options.Elements( ) ) {
|
|
if ( item.Name.LocalName == "flight_move_pitch" ) {
|
|
m_tuning["flight_move_pitch"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_move_yaw" ) {
|
|
m_tuning["flight_move_yaw"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_move_roll" ) {
|
|
m_tuning["flight_move_roll"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_move_strafe_vertical" ) {
|
|
m_tuning["flight_move_strafe_vertical"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_move_strafe_lateral" ) {
|
|
m_tuning["flight_move_strafe_lateral"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_move_strafe_longitudinal" ) {
|
|
m_tuning["flight_move_strafe_longitudinal"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_throttle_abs" ) {
|
|
m_tuning["flight_throttle_abs"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_throttle_rel" ) {
|
|
m_tuning["flight_throttle_rel"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
|
|
}
|
|
else if ( item.Name.LocalName == "flight_aim_pitch" ) {
|
|
m_tuning["flight_aim_pitch"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_aim_yaw" ) {
|
|
m_tuning["flight_aim_yaw"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
|
|
}
|
|
else if ( item.Name.LocalName == "flight_view_pitch" ) {
|
|
m_tuning["flight_view_pitch"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "flight_view_yaw" ) {
|
|
m_tuning["flight_view_yaw"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "fps_view_pitch" ) {
|
|
m_tuning["fps_view_pitch"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "fps_view__yaw" ) {
|
|
m_tuning["fps_view__yaw"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "fps_move_lateral" ) {
|
|
m_tuning["fps_move_lateral"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "fps_move_longitudinal" ) {
|
|
m_tuning["fps_move_longitudinal"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "mgv_view_pitch" ) {
|
|
m_tuning["mgv_view_pitch"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
else if ( item.Name.LocalName == "mgv_view_yaw" ) {
|
|
m_tuning["mgv_view_yaw"].Options_fromXML( item, type, int.Parse( instance ) );
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
}
|
|
}
|