IPhysicsParameters.cs 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections.Generic;
  29. using OpenSim.Framework;
  30. using OpenMetaverse;
  31. namespace OpenSim.Region.Physics.Manager
  32. {
  33. public struct PhysParameterEntry
  34. {
  35. // flags to say to apply to all or no instances (I wish one could put consts into interfaces)
  36. public const uint APPLY_TO_ALL = 0xfffffff3;
  37. public const uint APPLY_TO_NONE = 0xfffffff4;
  38. // values that denote true and false values
  39. public const float NUMERIC_TRUE = 1f;
  40. public const float NUMERIC_FALSE = 0f;
  41. public string name;
  42. public string desc;
  43. public PhysParameterEntry(string n, string d)
  44. {
  45. name = n;
  46. desc = d;
  47. }
  48. }
  49. // Interface for a physics scene that implements the runtime setting and getting of physics parameters
  50. public interface IPhysicsParameters
  51. {
  52. // Get the list of parameters this physics engine supports
  53. PhysParameterEntry[] GetParameterList();
  54. // Set parameter on a specific or all instances.
  55. // Return 'false' if not able to set the parameter.
  56. bool SetPhysicsParameter(string parm, string value, uint localID);
  57. // Get parameter.
  58. // Return 'false' if not able to get the parameter.
  59. bool GetPhysicsParameter(string parm, out string value);
  60. // Get parameter from a particular object
  61. // TODO:
  62. // bool GetPhysicsParameter(string parm, out string value, uint localID);
  63. }
  64. }