src/Tizen.NUI.Physics2D/src/public/chipmunk/Shapes/Circle.cs

   1 /*
   2  * Copyright (c) 2023 Codefoco (codefoco@codefoco.com)
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in all
  12  * copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 using System.ComponentModel;
  24
  25 namespace Tizen.NUI.Physics2D.Chipmunk
  26 {
  27     /// <summary>
  28     /// A circle shape defined by a radius
  29     /// This is the fastest and simplest collision shape
  30     /// </summary>
  31     [EditorBrowsable(EditorBrowsableState.Never)]
  32     public class Circle : Shape
  33     {
  34         /// <summary>
  35         /// Create and initialize a circle polygon shape.
  36         /// </summary>
  37         /// <param name="body">The body to attach the circle to.</param>
  38         /// <param name="radius">The radius of the circle.</param>
  39         [EditorBrowsable(EditorBrowsableState.Never)]
  40         public Circle(Body body, double radius)
  41             : this(body, radius, Vect.Zero)
  42         {
  43         }
  44
  45         /// <summary>
  46         /// Create and initialize an offset circle polygon shape.
  47         /// </summary>
  48         /// <param name="body">The body to attach the circle to.</param>
  49         /// <param name="radius">The radius of the circle.</param>
  50         /// <param name="offset">
  51         /// The offset from the body's center of gravity in coordinates local to the body.
  52         /// </param>
  53         [EditorBrowsable(EditorBrowsableState.Never)]
  54         public Circle(Body body, double radius, Vect offset)
  55             : base(NativeMethods.cpCircleShapeNew(body.Handle, radius, offset))
  56         {
  57         }
  58
  59         /// <summary>
  60         /// Get the offset of the circle.
  61         /// </summary>
  62         [EditorBrowsable(EditorBrowsableState.Never)]
  63         public Vect Offset => NativeMethods.cpCircleShapeGetOffset(Handle);
  64
  65         /// <summary>
  66         ///  Get the radius of the circle.
  67         /// </summary>
  68         [EditorBrowsable(EditorBrowsableState.Never)]
  69         public double Radius => NativeMethods.cpCircleShapeGetRadius(Handle);
  70
  71         /// <summary>
  72         /// Get the calculated area of the circle.
  73         /// </summary>
  74         [EditorBrowsable(EditorBrowsableState.Never)]
  75         public new double Area => AreaForCircle(0.0, Radius);
  76
  77         /// <summary>
  78         /// Calculate the moment of the circle for the given mass.
  79         /// </summary>
  80         [EditorBrowsable(EditorBrowsableState.Never)]
  81         public double MomentForMass(double mass)
  82         {
  83             return MomentForCircle(mass, Radius, Offset);
  84         }
  85
  86         /// <summary>
  87         /// Calculate the moment of inertia for the circle.
  88         /// </summary>
  89         [EditorBrowsable(EditorBrowsableState.Never)]
  90         public static double MomentForCircle(double mass, double innerRadius, double radius, Vect offset)
  91         {
  92             return NativeMethods.cpMomentForCircle(mass, innerRadius, radius, offset);
  93         }
  94
  95         /// <summary>
  96         /// Calculate the moment of inertia for the circle.
  97         /// </summary>
  98         [EditorBrowsable(EditorBrowsableState.Never)]
  99         public static double MomentForCircle(double mass, double radius, Vect offset)
 100         {
 101             return NativeMethods.cpMomentForCircle(mass, 0.0, radius, offset);
 102         }
 103
 104         /// <summary>
 105         /// Calculate the area of a circle or donut.
 106         /// </summary>
 107         /// <param name="innerRadius">
 108         /// The radius of the 'donut hole', which defines the area missing.
 109         /// </param>
 110         /// <param name="radius">
 111         /// The outer radius of the donut. This should be greater than the
 112         /// <paramref name="innerRadius"/>.
 113         /// </param>
 114         [EditorBrowsable(EditorBrowsableState.Never)]
 115         public static double AreaForCircle(double innerRadius, double radius)
 116         {
 117             return NativeMethods.cpAreaForCircle(innerRadius, radius);
 118         }
 119     }
 120 }