@quenty/sunpositionutils 2.0.1-canary.9c1fd3b.0 → 2.1.1

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [2.0.1-canary.9c1fd3b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sunpositionutils@2.0.0...@quenty/sunpositionutils@2.0.1-canary.9c1fd3b.0) (2021-09-11)
+## [2.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sunpositionutils@2.1.0...@quenty/sunpositionutils@2.1.1) (2021-12-30)
 
 **Note:** Version bump only for package @quenty/sunpositionutils
 
@@ -11,6 +11,22 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
+# [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sunpositionutils@2.0.0...@quenty/sunpositionutils@2.1.0) (2021-12-18)
+
+
+### Bug Fixes
+
+* Selene linting Vector3.zAxis ([6a24a62](https://github.com/Quenty/NevermoreEngine/commit/6a24a62975d92665b1291e3fbb8a1ea49ee4f69d))
+
+
+### Features
+
+* Add SunPositionUtils.getSunPosition(clockTime, geoLatitude), SunPositionUtils.getClockTimeFromMoonDirection(direction), and SunPositionUtils.getGeographicalLatitudeFromMoonDirection ([4adeb92](https://github.com/Quenty/NevermoreEngine/commit/4adeb92ecb6a9093062bd4659a8423d16f897454))
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sunpositionutils@1.2.0...@quenty/sunpositionutils@2.0.0) (2021-09-05)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## SunPositionUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
 
 Utility to position the sun
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/SunPositionUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/sunpositionutils --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sunpositionutils",
-  "version": "2.0.1-canary.9c1fd3b.0",
+  "version": "2.1.1",
   "description": "Utility to position the sun",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c1fd3b43a16f8bc00caafbbb3f7092b4e5cc9eb"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/SunPositionUtils.lua

@@ -1,25 +1,57 @@
---- Utility to position the sun
--- @module SunPositionUtils
-
+--[=[
+	Utility to position the sun
+	@class SunPositionUtils
+]=]
 local SunPositionUtils = {}
 
 local EARTH_TILT = 23.5
 local NORTH = Vector3.new(0, 0, -1)
+local ZAXIS = Vector3.new(0, 0, 1)
 
 function SunPositionUtils.getGeographicalLatitudeFromDirection(direction)
 	local angle = math.atan2(direction.z, math.sqrt(direction.x^2 + direction.y^2))
 	return angle/(math.pi*2)*360+EARTH_TILT
 end
 
+SunPositionUtils.getGeographicalLatitudeFromMoonDirection = SunPositionUtils.getGeographicalLatitudeFromDirection
+
 function SunPositionUtils.getClockTimeFromDirection(direction)
 	local altitude = math.atan2(-direction.y, -direction.x)
 
 	return (altitude/(math.pi*2)*24-6) % 24
 end
 
+function SunPositionUtils.getClockTimeFromMoonDirection(direction)
+	local altitude = math.atan2(direction.y, direction.x)
+
+	return (altitude/(math.pi*2)*24-6) % 24
+end
+
 function SunPositionUtils.getDirection(azimuthRad, altitudeRad, north)
 	local cframe = (CFrame.Angles(0, azimuthRad, 0) * CFrame.Angles(altitudeRad, 0, 0))
 	return cframe:vectorToWorldSpace(north or NORTH)
 end
 
+function SunPositionUtils.getSunPosition(clockTime, geoLatitude)
+	local seconds = clockTime*60*60
+	local DAY = 24 * 60 * 60
+	local YEAR = 365.2564 * DAY
+	local HALFYEAR = 182.6282
+	local EARTHTILT = math.rad(23.5)
+
+	local modTime = seconds - math.floor(seconds / DAY) * DAY
+	local sourceAngle = 2 * math.pi * modTime / DAY
+	local sunPosition = Vector3.new(math.sin(sourceAngle), -math.cos(sourceAngle), 0)
+	local moonPosition = Vector3.new(math.sin(sourceAngle + math.pi), math.cos(sourceAngle + math.pi), 0)
+	local dayOfYearOffset = (seconds - (seconds * math.floor(seconds / YEAR))) / DAY
+
+	local latRad = math.rad(geoLatitude)
+	local sunOffset = -EARTHTILT * math.cos(math.pi * (dayOfYearOffset - HALFYEAR) / HALFYEAR) - latRad
+
+	local trueSunPosition = CFrame.fromAxisAngle(ZAXIS:Cross(sunPosition), sunOffset) * sunPosition
+	local trueMoonPosition = CFrame.fromAxisAngle(ZAXIS:Cross(moonPosition), sunOffset) * moonPosition
+
+	return trueSunPosition, trueMoonPosition*Vector3.new(1, -1, 1)
+end
+
 return SunPositionUtils