Pocket #3584
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| --[[ | ||
| This file is part of Courseplay (https://github.com/Courseplay/FS22_Courseplay) | ||
| Copyright (C) 2024 Courseplay Dev Team | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
|
|
||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| ]]-- | ||
|
|
||
| -- A helper node is a temporary node to help with relative vehicle position calculations. | ||
| -- It wraps the creation of the Giant's engine node. | ||
| -- NOTE: it must be destroyed explicitly to avoid node leak. | ||
|
|
||
| ---@class HelperNode | ||
| HelperNode = CpObject() | ||
|
|
||
| --- Create a new helper node, linking it to the given rootNode. | ||
| ---@param name string | ||
| ---@param rootNode number|nil | ||
| function HelperNode:init(name, rootNode) | ||
| self.node = createTransformGroup(name) | ||
| self.rootNode = rootNode | ||
| link(self.rootNode, self.node) | ||
|
There was a problem hiding this comment. What happens here if rootNode is nil? |
||
| end | ||
|
|
||
| --- Safely destroy a node | ||
| function HelperNode:destroy() | ||
| if self.node and entityExists(self.node) then | ||
| unlink(self.node) | ||
| delete(self.node) | ||
| end | ||
| end | ||
|
|
||
| --- Place the node at the given position and rotation. | ||
| ---@param x number | ||
| ---@param y number if the node is linked to the terrain, this is relative to the terrain height at x, z | ||
| ---@param z number | ||
| ---@param yRotation number|nil Rotation set only if not nil | ||
| function HelperNode:place(x, y, z, yRotation) | ||
| setTranslation(self.node, x, y, z) | ||
| if yRotation then | ||
| setRotation(self.node, 0, yRotation, 0) | ||
| end | ||
| end | ||
|
|
||
| ---@param text string|nil | ||
| function HelperNode:draw(text) | ||
| if entityExists(self.node) then | ||
| DebugUtil.drawDebugNode(self.node, text or getName(self.node), false, 0) | ||
| end | ||
| end | ||
|
|
||
| -- A helper node that is linked to the terrain root node, and the y coordinate is always | ||
| -- the terrain height at the x, z position. | ||
| ---@class HelperTerrainNode : HelperNode | ||
| HelperTerrainNode = CpObject(HelperNode) | ||
|
There was a problem hiding this comment. Not sure if inheritence is the best approach here. -- Creates a new helper node linked to the terrain root node.
function HelperNode.createTerrainNode(name )
return HelperNode(name, g_currentMission.terrainRootNode)
endThere was a problem hiding this comment. I had something similar first, the reason I don't like it, is that the behavior/interpretation for the y coordinate is different. |
||
|
|
||
| --- Create a new terrain helper node, linking it to the terrain root node. | ||
| ---@param name string | ||
| function HelperTerrainNode:init(name) | ||
| HelperNode.init(self, name, g_currentMission.terrainRootNode) | ||
| end | ||
|
|
||
| --- Place the node at the given position and rotation. | ||
| ---@param x number | ||
| ---@param y number if the node is linked to the terrain, this is relative to the terrain height at x, z | ||
| ---@param z number | ||
| ---@param yRotation number|nil Rotation set only if not nil | ||
| function HelperTerrainNode:place(x, y, z, yRotation) | ||
|
There was a problem hiding this comment. I would prefer this functionality in a separate function like so maybe: ---@param yRotation number|nil
---@param yOffset number|nil
function HelperNode:placeTerrain(x, z, yRotation, yOffset)
endThere was a problem hiding this comment. Was struggling with this as well, probably we don't even need a generic HelperNode (at least as of now, I'm not aware of a use case), and should only implement a HelperTerrainNode. |
||
| setTranslation(self.node, x, getTerrainHeightAtWorldPos(g_currentMission.terrainRootNode, x, 0, z) + y, z) | ||
| if yRotation then | ||
| -- leave z/x rotation as is | ||
| local xRotation, _, zRotation = getWorldRotation(node) | ||
| setRotation(self.node, xRotation, yRotation, zRotation) | ||
| end | ||
| end | ||
|
|
||
| --- Place the node at the same world position and rotation as the given node. | ||
| --- An optional local position can be given to offset the helper node from the given node. | ||
| ---@param node number | ||
| ---@param y number|nil relative height to terrain | ||
| ---@param lx number|nil x coordinate of the point relative to node | ||
| ---@param ly number|nil y coordinate of the point relative to node | ||
| ---@param lz number|nil z coordinate of the point relative to node | ||
| function HelperTerrainNode:placeAtNode(node, y, lx, ly, lz) | ||
| local x, _, z = localToWorld(node, lx or 0, ly or 0, lz or 0) | ||
| local xRotation, yRotation, zRotation = getWorldRotation(node) | ||
| setRotation(self.node, xRotation, yRotation, zRotation) | ||
| self:place(x, y or 0, z) | ||
| end | ||
|
|
||
| --- Get the position of a point relative to node, in the helper node's coordinate system. | ||
| ---@param node number | ||
| ---@param lx number x coordinate of the point relative to the node | ||
| ---@param ly number y coordinate of the point relative to the node | ||
| ---@param lz number z coordinate of the point relative to the node | ||
| ---@return number, number, number | ||
| function HelperTerrainNode:localToLocal(node, lx, ly, lz) | ||
|
There was a problem hiding this comment. This function is only working for HelperTerrainNode and not for the base HelperNode |
||
| return localToLocal(node, self.node, lx, ly, lz) | ||
| end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a fantastic idea :)
Maybe you got the motivation to add missing commanly used functions, like worldToLocal(), localDirectionToWorld().