Refactor/unity package (#22)

* refactor: seperate unity package into new project

* task: update readme

* feat: Added IsInteger method in Fixed64.cs and Fixed64.Extensions.cs (#21)

* feat: Added IsInteger method in Fixed64.cs and Fixed64.Extensions.cs

* fix: using MAX_SHIFTED_AMOUNT_UI instead of uint.MaxValue

---------

Co-authored-by: Lucas S. Tomazetto <145228338+ltomazetto@users.noreply.github.com>

Author: mrdav30

.assets/scripts/create-unity-package.ps1

@@ -1,6 +1,5 @@
 param (
-    [string]$BuildType = "Release",
-	[string]$UnityVersion = "2022.3.20f1"
+    [string]$BuildType = "Release"
 )
 
 # Import shared functions
@@ -12,7 +11,7 @@ $solutionDir = Get-SolutionDirectory
 Set-Location $solutionDir
 
 # Ensure GitVersion environment variables are set
-Ensure-GitVersion-Environment $UnityVersion 
+Ensure-GitVersion-Environment
 
 # Build the project with the version information applied
 Build-Project -Configuration $BuildType

.assets/scripts/set-version-and-build.ps1

@@ -14,8 +14,6 @@ function Get-SolutionDirectory {
 }
 
 function Ensure-GitVersion-Environment {
-    param ([string]$UnityVersion = "2022.3.20f1")
-
 	# Ensure GitVersion is installed and available
 	if (-not (Get-Command "dotnet-gitversion" -ErrorAction SilentlyContinue)) {
 		Write-Host "GitVersion is not installed. Install it with:"
@@ -44,14 +42,12 @@ function Ensure-GitVersion-Environment {
     [System.Environment]::SetEnvironmentVariable('GitVersion_AssemblySemVer', $assemblySemVer, 'Process')
     [System.Environment]::SetEnvironmentVariable('GitVersion_AssemblySemFileVer', $assemblySemFileVer, 'Process')
     [System.Environment]::SetEnvironmentVariable('GitVersion_InformationalVersion', $infoVersion, 'Process')
-    [System.Environment]::SetEnvironmentVariable('UnityVersion', $UnityVersion, 'Process')
 
     Write-Host "Environment variables set:"
     Write-Host "  GitVersion_FullSemVer = $semVer"
     Write-Host "  GitVersion_AssemblySemVer = $assemblySemVer"
     Write-Host "  GitVersion_AssemblySemFileVer = $assemblySemFileVer"
     Write-Host "  GitVersion_InformationalVersion = $infoVersion"
-    Write-Host "  UnityVersion = $UnityVersion"
 }
 
 function Build-Project {

.assets/scripts/utilities.ps1

@@ -16,27 +16,17 @@ EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
-		DebugUnity|Any CPU = DebugUnity|Any CPU
 		Release|Any CPU = Release|Any CPU
-		ReleaseUnity|Any CPU = ReleaseUnity|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{61834921-141D-4BD5-9E75-31188DF32E93}.DebugUnity|Any CPU.ActiveCfg = DebugUnity|Any CPU
-		{61834921-141D-4BD5-9E75-31188DF32E93}.DebugUnity|Any CPU.Build.0 = DebugUnity|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Release|Any CPU.Build.0 = Release|Any CPU
-		{61834921-141D-4BD5-9E75-31188DF32E93}.ReleaseUnity|Any CPU.ActiveCfg = ReleaseUnity|Any CPU
-		{61834921-141D-4BD5-9E75-31188DF32E93}.ReleaseUnity|Any CPU.Build.0 = ReleaseUnity|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.DebugUnity|Any CPU.ActiveCfg = DebugUnity|Any CPU
-		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.DebugUnity|Any CPU.Build.0 = DebugUnity|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Release|Any CPU.Build.0 = Release|Any CPU
-		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.ReleaseUnity|Any CPU.ActiveCfg = ReleaseUnity|Any CPU
-		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.ReleaseUnity|Any CPU.Build.0 = ReleaseUnity|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

FixedMathSharp.sln

@@ -10,15 +10,14 @@ Ideal for simulations, games, and physics engines requiring reliable arithmetic
 
 ## 🛠️ Key Features
 
-- **Deterministic Calculations:** Perfect for simulations, multiplayer games, and physics engines.
+- **Deterministic Calculations:** Ensures consistent results across different platforms. 
 - **High Precision Arithmetic:** Uses fixed-point math to eliminate floating-point inaccuracies.
 - **Comprehensive Vector Support:** Includes 2D and 3D vector operations (`Vector2d`, `Vector3d`).
 - **Quaternion Rotations:** Leverage `FixedQuaternion` for smooth rotations without gimbal lock.
 - **Matrix Operations:** Supports transformations with `Fixed4x4` and `Fixed3x3` matrices.
 - **Bounding Shapes:** Includes `IBound` structs `BoundingBox`, `BoundingSphere`, and `BoundingArea` for lightweight spatial calculations.
 - **Advanced Math Functions:** Includes trigonometry and common math utilities.
-- **Unity Integration:** Seamless interoperability with Unity using `FixedMathSharp.Editor`.
-
+- **Framework Agnostic:** Works with **.NET, Unity, and other game engines**.
 
 ---
 
@@ -47,19 +46,11 @@ Clone the repository and add it to your project:
 
    - Include the FixedMathSharp project or its DLLs in your build process.
 
-### Unity
-
-To integrate **FixedMathSharp** into your Unity project:
-
-1. **Download the Package**:
-   - Obtain the latest `FixedMathSharp{{VERSION}}.unitypackage` from the [Releases](https://github.com/mrdav30/FixedMathSharp/releases) section of the repository.
+### Unity Integration
 
-2. **Import into Unity**:
-   - In Unity, navigate to **Assets > Import Package > Custom Package...**.
-   - Select the downloaded `FixedMathSharp{{VERSION}}.unitypackage` file.
+FixedMathSharp is now maintained as a separate Unity package.For Unity-specific implementations, refer to:
 
-3. **Verify the Integration**:
-   - After importing, confirm that the `FixedMathSharp` namespace is accessible in your scripts.
+🔗 [FixedMathSharp-Unity Repository](https://github.com/mrdav30/FixedMathSharp-Unity).
 
 ---
 
@@ -137,10 +128,10 @@ configurable `SHIFT_AMOUNT`.
 
 ## ⚡ Performance Considerations
 
-This library leverages **inline methods** and **fixed-point arithmetic** 
-to ensure high precision without the pitfalls of floating-point numbers. 
-It is optimized for **deterministic behavior**, making it ideal for physics 
-engines, multiplayer simulations, and other time-sensitive applications.
+FixedMathSharp is optimized for high-performance deterministic calculations:
+- **Inline methods and bit-shifting optimizations** ensure minimal overhead.
+- **Eliminates floating-point drift**, making it ideal for lockstep simulations.
+- **Supports fuzzy equality comparisons** for handling minor precision deviations.
 
 ---
 
@@ -159,9 +150,10 @@ dotnet test --configuration Release
 
 ## 🛠️ Compatibility
 
-- **.NET Framework:** 4.7.1+
-- **Unity3D:** Fully compatible with Unity using the `FixedMathSharp.Editor` extension.
-- **Platforms:** Windows, Linux, macOS
+- **.NET Framework** 4.7.2+
+- **.NET Core / .NET** 6+
+- **Unity 2020+** (via [FixedMathSharp-Unity](https://github.com/mrdav30/FixedMathSharp-Unity))
+- **Cross-Platform Support** (Windows, Linux, macOS)
 
 ---
 

README.md

@@ -16,6 +16,13 @@ public static int Sign(this Fixed64 value)
             return Fixed64.Sign(value);
         }
 
+        /// <inheritdoc cref="Fixed64.IsInteger(Fixed64)" />
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool IsInteger(this Fixed64 value)
+        {
+            return Fixed64.IsInteger(value);
+        }
+        
         /// <inheritdoc cref="FixedMath.Squared(Fixed64)" />
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static Fixed64 Squared(this Fixed64 value)

src/FixedMathSharp/Fixed64.Extensions.cs

@@ -150,6 +150,15 @@ public static int Sign(Fixed64 value)
             // Return the sign of the value, optimizing for branchless comparison
             return value.m_rawValue < 0 ? -1 : (value.m_rawValue > 0 ? 1 : 0);
         }
+        
+        /// <summary>
+        /// Returns true if the number has no decimal part (i.e., if the number is equivalent to an integer) and False otherwise. 
+        /// </summary>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool IsInteger(Fixed64 value)
+        {
+            return ((ulong)value.m_rawValue & FixedMath.MAX_SHIFTED_AMOUNT_UI) == 0;
+        }
 
         #endregion
 

src/FixedMathSharp/Fixed64.cs

@@ -33,31 +33,18 @@
     <Deterministic>true</Deterministic>
     <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
 	<UnityBuild>false</UnityBuild>
-	<Configurations>Debug;Release;DebugUnity;ReleaseUnity</Configurations>
+	<Configurations>Debug;Release</Configurations>
   </PropertyGroup>
   <!-- Debug and Release-specific Properties -->
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
-    <DebugType>full</DebugType>
     <Optimize>false</Optimize>
     <DefineConstants>DEBUG;TRACE</DefineConstants>
   </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='DebugUnity|AnyCPU'">
-    <DebugSymbols>true</DebugSymbols>
-    <DebugType>full</DebugType>
-    <Optimize>false</Optimize>
-    <DefineConstants>DEBUG;TRACE;UNITY_EDITOR</DefineConstants>
-    <UnityBuild>true</UnityBuild>
-  </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <Optimize>true</Optimize>
     <DefineConstants>TRACE</DefineConstants>
   </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='ReleaseUnity|AnyCPU'">
-    <Optimize>true</Optimize>
-    <DefineConstants>TRACE;UNITY_EDITOR</DefineConstants>
-	<UnityBuild>true</UnityBuild>
-  </PropertyGroup>
   <!-- NuGet Packaging Metadata -->
   <PropertyGroup>
     <PackageId>FixedMathSharp</PackageId>
@@ -79,50 +66,8 @@
     <ProjectGuid>{61834921-141D-4BD5-9E75-31188DF32E93}</ProjectGuid>
     <OutputPath>bin\$(Configuration)\</OutputPath>
   </PropertyGroup>
-  <!-- Set OS-specific Unity Editor absolute/relative folder paths -->
-  <Choose>
-    <When Condition="$(UnityBuild)And$([MSBuild]::IsOsPlatform(Windows))">
-      <PropertyGroup>
-        <OSInstallRootPath Condition="'$(OSInstallRootPath)'==''">C:\Program Files</OSInstallRootPath>
-        <UnityManagedDir Condition="'$(UnityManagedDir)'==''">Editor\Data\Managed</UnityManagedDir>
-      </PropertyGroup>
-    </When>
-    <When Condition="$(UnityBuild)And$([MSBuild]::IsOsPlatform(OSX))">
-      <PropertyGroup>
-        <OSInstallRootPath Condition="'$(OSInstallRootPath)'==''">/Applications</OSInstallRootPath>
-        <UnityManagedDir Condition="'$(UnityManagedDir)'==''">Unity.app\Contents\Managed</UnityManagedDir>
-      </PropertyGroup>
-    </When>
-    <When Condition="$(UnityBuild)And$([MSBuild]::IsOsPlatform(Linux))">
-      <PropertyGroup>
-        <OSInstallRootPath Condition="'$(OSInstallRootPath)'==''">$([System.Environment]::GetFolderPath('System.Environment+SpecialFolder.UserProfile'))</OSInstallRootPath>
-        <UnityManagedDir Condition="'$(UnityManagedDir)'==''">Editor\Data\Managed</UnityManagedDir>
-      </PropertyGroup>
-    </When>
-  </Choose>
-  <!-- Unity Configuration -->
-  <PropertyGroup Condition="$(UnityBuild)">
-    <UnityVersion Condition="'$(UnityVersion)'==''">2022.3.20f1</UnityVersion>
-    <!-- Target Version of Unity -->
-    <UnityInstallRootDir Condition="'$(UnityInstallRootDir)'==''">Unity\Hub\Editor</UnityInstallRootDir>
-    <UnityInstallRootPath Condition="'$(UnityInstallRootPath)'==''">$(OSInstallRootPath)\$(UnityInstallRootDir)</UnityInstallRootPath>
-    <UnityVersionInstallPath Condition="'$(UnityVersionInstallPath)'==''">$(UnityInstallRootPath)\$(UnityVersion)</UnityVersionInstallPath>
-    <UnityManagedPath Condition="'$(UnityManagedPath)'==''">$(UnityVersionInstallPath)\$(UnityManagedDir)</UnityManagedPath>
-    <UnityEnginePath Condition="'$(UnityEnginePath)'==''">$(UnityManagedPath)\UnityEngine.dll</UnityEnginePath>
-    <UnityEditorPath Condition="'$(UnityEditorPath)'==''">$(UnityManagedPath)\UnityEditor.dll</UnityEditorPath>
-  </PropertyGroup>
   <!-- Dependencies and Package References -->
   <ItemGroup>
-	<Reference Condition="$(UnityBuild)" Include="UnityEngine">
-      <HintPath>$(UnityEnginePath)</HintPath>
-	  <Private>false</Private>
-	  <PrivateAssets>all</PrivateAssets>
-    </Reference>
-    <Reference Condition="$(UnityBuild)" Include="UnityEditor">
-      <HintPath>$(UnityEditorPath)</HintPath>
-	  <Private>false</Private>
-	  <PrivateAssets>all</PrivateAssets>
-    </Reference>
 	<PackageReference Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'" Include="Microsoft.NETFramework.ReferenceAssemblies.net48" Version="1.0.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
@@ -135,8 +80,4 @@
     <None Include="..\..\icon.png" Pack="true" PackagePath="\" Visible="false" />
 	<None Remove=".gitignore" />
   </ItemGroup>
-  <ItemGroup Condition="'$(Configuration)|$(Platform)'=='ReleaseUnity|AnyCPU'">
-	<Compile Remove="Integration\**" />
-	<Content Include="Integration\**" />
-  </ItemGroup>
 </Project>