AttachElementsOffsets - Revision history

FileEX at 10:42, 13 July 2024

2024-07-13T10:42:19Z

← Older revision		Revision as of 10:42, 13 July 2024
Line 71:		Line 71:
	return x, y, z		return x, y, z
	end</syntaxhighlight>		end</syntaxhighlight>

			[[Category:Scripting Concepts]]

Ransom at 01:07, 10 April 2011

2011-04-10T01:07:47Z

← Older revision		Revision as of 01:07, 10 April 2011
Line 2:		Line 2:

	==Problem==		==Problem==
	The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates ~~between~~ "theElement" and "theAttachToObject".		The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates for "theElement" and "theAttachToObject".

			For example, if "theAttachToElement" has XYZ rotations, then "theElement" will inherit these rotations. The specified rotation offsets will then be performed from these starting rotation points. Simply put, "theElement" will be rotated twice.

	==Solution==		==Solution==

Ransom at 00:46, 10 April 2011

2011-04-10T00:46:44Z

← Older revision		Revision as of 00:46, 10 April 2011
Line 1:		Line 1:
	'''This article concerns the note left in [[attachElements]].'''		'''This article concerns the note left in [[attachElements]].'''

	==~~Explanation~~==		==Problem==
	The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates between "theElement" and "theAttachToObject".		The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates between "theElement" and "theAttachToObject".

	==Solution==		==Solution==
	The ~~follow~~ code shows how to use offsets calculated in the map editor with 'attachElements':		The following code shows how to use offsets calculated in the map editor with 'attachElements':
	<syntaxhighlight lang="lua">addEventHandler( "onResourceStart", resourceRoot,		<syntaxhighlight lang="lua">addEventHandler( "onResourceStart", resourceRoot,
	function()		function()

Ccw at 00:46, 10 April 2011

2011-04-10T00:46:07Z

← Older revision		Revision as of 00:46, 10 April 2011
Line 55:		Line 55:

	-- unrotate each axis		-- unrotate each axis
	local tempY = y;		local tempY = y
	y = math.cos ( rx ) * tempY + math.sin ( rx ) * z;		y = math.cos ( rx ) * tempY + math.sin ( rx ) * z
	z = -math.sin ( rx ) * tempY + math.cos ( rx ) * z;		z = -math.sin ( rx ) * tempY + math.cos ( rx ) * z

	local tempX = x;		local tempX = x
	x = math.cos ( ry ) * tempX - math.sin ( ry ) * z;		x = math.cos ( ry ) * tempX - math.sin ( ry ) * z
	z = math.sin ( ry ) * tempX + math.cos ( ry ) * z;		z = math.sin ( ry ) * tempX + math.cos ( ry ) * z

	tempX = x;		tempX = x
	x = math.cos ( rz ) * tempX + math.sin ( rz ) * y;		x = math.cos ( rz ) * tempX + math.sin ( rz ) * y
	y = -math.sin ( rz ) * tempX + math.cos ( rz ) * y;		y = -math.sin ( rz ) * tempX + math.cos ( rz ) * y

	return x, y, z		return x, y, z
	end</syntaxhighlight>		end</syntaxhighlight>

Ccw at 00:42, 10 April 2011

2011-04-10T00:42:49Z

← Older revision		Revision as of 00:42, 10 April 2011
Line 4:		Line 4:
	The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates between "theElement" and "theAttachToObject".		The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates between "theElement" and "theAttachToObject".

	==~~Example~~==		==Solution==
	~~Start freeroam resource and paste this into~~ the ~~console~~:		The follow code shows how to use offsets calculated in the map editor with 'attachElements':
	<syntaxhighlight lang="lua">~~setpos 1904.7426757813~~ -~~2411~~.~~1262207031 13.53911781311</syntaxhighlight>~~		<syntaxhighlight lang="lua">addEventHandler( "onResourceStart", resourceRoot,
			function()
			-- Postion and rotations from the map editor:
			local mainPos = { -756, 995, 14 }
			local mainRot = { 0, 0, 90 } -- Two rotations are zero. See note in attachRotationAdjusted

	~~Now~~, ~~use the following script and look at the plane on the rocket~~. See how it is off center? It is off center despite the fact you found the positions in the map editor and calculated the offsets. If you commented out the [[attachElements]] line you will see that the plane is created in the correct position in ~~relation to the rocket in terms of '''world coordinates'''.~~		local subPos = { -756, 999, 24 }
			local subRot = { 89, 0, 177 } -- One rotation is zero. See note in attachRotationAdjusted

	~~In this example~~, ~~if you make "rocketRZ~~ = ~~0" you will have the correct coordinates. Again~~, ~~because the offsets are based off "theAttachToElement". If you kept any rotations in the object~~, ~~it would change the XYZ coordinates "theElement" would need to be attached at.~~		-- Create the objects
			mainObject = createObject ( 17050, mainPos[1], mainPos[2], mainPos[3], mainRot[1], mainRot[2], mainRot[3] )
			subObject = createVehicle ( 519, subPos[1], subPos[2], subPos[3], subRot[1], subRot[2], subRot[3] )

	~~<syntaxhighlight lang="lua">~~		-- Attach so they look like what they do in the map editor
	--~~This example illustrates~~ the ~~problem with using the world coordinate math to calculate offsets.~~		attachRotationAdjusted ( subObject, mainObject )
	~~--Change rocketRZ to 0 to get the correct position.~~		end
			)

	~~local rocketX = 1925.022705~~
	~~local rocketY = -2450.944336~~
	~~local rocketZ = 18.053474~~
	~~local rocketRX = 0~~
	~~local rocketRY = 0~~
	~~local rocketRZ = 69.61437~~

	~~local vehX = 1925.112793~~ --~~more is forward~~		function attachRotationAdjusted ( from, to )
	~~local vehY =~~ -~~2446.260742~~ -- ~~less is forward~~		-- Note: Objects being attached to ('to') should have at least two of their rotations set to zero
	~~local vehZ = 26.692139~~		-- Objects being attached ('from') should have at least one of their rotations set to zero
	~~local vehRX = 89.38142~~		-- Otherwise it will look all funny
	~~local vehRY = 0.030000~~
	~~local vehRZ = 177.90356~~

	~~shuttletable~~ = {}		local frPosX, frPosY, frPosZ = getElementPosition( from )
	~~shuttletable[1]~~ = ~~createObject~~ ( ~~17050~~, ~~rocketX~~, ~~rocketY~~, ~~rocketZ~~, ~~rocketRX, rocketRY, rocketRZ )~~		local frRotX, frRotY, frRotZ = getElementRotation( from )
	~~shuttletable[2]~~ = ~~createVehicle~~ ( ~~519, vehX, vehY, vehZ, vehRX, vehRY, vehRZ~~ )		local toPosX, toPosY, toPosZ = getElementPosition( to )
			local toRotX, toRotY, toRotZ = getElementRotation( to )
	~~attachOffsetX~~ = ~~vehX~~-~~rocketX~~		local offsetPosX = frPosX - toPosX
	~~attachOffsetY~~ = ~~vehY~~-~~rocketY~~		local offsetPosY = frPosY - toPosY
	~~attachOffsetZ~~ = ~~vehZ~~-~~rocketZ~~		local offsetPosZ = frPosZ - toPosZ
	~~attachOffsetRX~~ = ~~vehRX~~-~~rocketRX~~		local offsetRotX = frRotX - toRotX
	~~attachOffsetRY~~ = ~~vehRY~~-~~rocketRY~~		local offsetRotY = frRotY - toRotY
	~~attachOffsetRZ~~ = ~~vehRZ~~-~~rocketRZ~~		local offsetRotZ = frRotZ - toRotZ

	attachElements( ~~shuttletable[2]~~, ~~shuttletable[1]~~, ~~attachOffsetX~~, ~~attachOffsetY~~, ~~attachOffsetZ~~, ~~attachOffsetRX~~, ~~attachOffsetRY~~, ~~attachOffsetRZ~~ )</syntaxhighlight>		offsetPosX, offsetPosY, offsetPosZ = applyInverseRotation ( offsetPosX, offsetPosY, offsetPosZ, toRotX, toRotY, toRotZ )

			attachElements( from, to, offsetPosX, offsetPosY, offsetPosZ, offsetRotX, offsetRotY, offsetRotZ )
			end


			function applyInverseRotation ( x,y,z, rx,ry,rz )
			-- Degress to radians
			local DEG2RAD = (math.pi * 2) / 360
			rx = rx * DEG2RAD
			ry = ry * DEG2RAD
			rz = rz * DEG2RAD

			-- unrotate each axis
			local tempY = y;
			y = math.cos ( rx ) * tempY + math.sin ( rx ) * z;
			z = -math.sin ( rx ) * tempY + math.cos ( rx ) * z;

			local tempX = x;
			x = math.cos ( ry ) * tempX - math.sin ( ry ) * z;
			z = math.sin ( ry ) * tempX + math.cos ( ry ) * z;

			tempX = x;
			x = math.cos ( rz ) * tempX + math.sin ( rz ) * y;
			y = -math.sin ( rz ) * tempX + math.cos ( rz ) * y;

			return x, y, z
			end</syntaxhighlight>

Ransom: /* Example */

2011-03-21T04:13:20Z

Example

← Older revision		Revision as of 04:13, 21 March 2011
Line 8:		Line 8:
	<syntaxhighlight lang="lua">setpos 1904.7426757813 -2411.1262207031 13.53911781311</syntaxhighlight>		<syntaxhighlight lang="lua">setpos 1904.7426757813 -2411.1262207031 13.53911781311</syntaxhighlight>

	Now, use the following script and look at the rocket. See how it is off center? ~~Despite~~ the fact you found the positions in the map editor and calculated the offsets. If you commented out [[attachElements]] you will see that it is in the correct position in terms of world coordinates.		Now, use the following script and look at the plane on the rocket. See how it is off center? It is off center despite the fact you found the positions in the map editor and calculated the offsets. If you commented out the [[attachElements]] line you will see that the plane is created in the correct position in relation to the rocket in terms of '''world coordinates'''.

	If you make "rocketRZ = 0" you will have the correct coordinates. Again, because the offsets are based off "theAttachToElement". If you kept any rotations in the object, it would change the XYZ coordinates "theElement" would need to be attached at.		In this example, if you make "rocketRZ = 0" you will have the correct coordinates. Again, because the offsets are based off "theAttachToElement". If you kept any rotations in the object, it would change the XYZ coordinates "theElement" would need to be attached at.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ransom: To be checked...

2011-03-21T04:09:17Z

To be checked...

← Older revision		Revision as of 04:09, 21 March 2011
Line 1:		Line 1:
	'''This article concerns the note left in [[attachElements]].'''		'''This article concerns the note left in [[attachElements]].'''


	==Explanation==		==Explanation==

Ransom at 04:08, 21 March 2011

2011-03-21T04:08:54Z

← Older revision		Revision as of 04:08, 21 March 2011
Line 1:		Line 1:
	'''This article concerns the note left in [[attachElements]].'''		'''This article concerns the note left in [[attachElements]].'''


	==Explanation==		==Explanation==
	The offset coordinates reflect the object space, not the world space. This means that if you ~~were to calculate coordinate and rotation offsets between "theElement" and "theAttachToElement", they would not always be correct.~~		The offset coordinates reflect the object space, not the world space. This means that you cannot simply visualize the attachment in the map editor and calculate the offsets between the 2 sets of world coordinates between "theElement" and "theAttachToObject".

	~~The example script below places a plane facing upward on a silo. The positioning was done manually~~ in the map editor and the ~~coordinates were saved to~~ the ~~script. These coordinates are reflected in the initial creation of objects "shuttletable[1]" and "shuttletable[~~2~~]".~~

	~~The problem is we will need the offsets~~ of ~~the~~ "theElement" ~~in relation to "theAttachToElement". "theAttachToElement" becomes 0,0,0,0,0,0~~ and "~~theElement~~" ~~will inherit the exact same coordinates and rotation, unless offsets are specified when using the [[attachElements]] function~~.

	==Example==		==Example==
Line 12:		Line 9:
	<syntaxhighlight lang="lua">setpos 1904.7426757813 -2411.1262207031 13.53911781311</syntaxhighlight>		<syntaxhighlight lang="lua">setpos 1904.7426757813 -2411.1262207031 13.53911781311</syntaxhighlight>

	Now, use the following script and look at the rocket. See how it is off center? ~~This means~~ the ~~relation to~~ the ~~actual game~~ world ~~coordinate system has changed~~.		Now, use the following script and look at the rocket. See how it is off center? Despite the fact you found the positions in the map editor and calculated the offsets. If you commented out [[attachElements]] you will see that it is in the correct position in terms of world coordinates.

	If you ~~change~~ rocketRZ to 0 ~~(the silo object that the plane in attached to), this~~ will ~~put the rocket in~~ the correct ~~position~~. ~~So what happened? The silo is~~ "theAttachToElement" ~~and it becomes 0,0,0,0,0,0~~. ~~This example is unusual~~ in ~~that you have essentially fixed your problem. The silo looks~~ the ~~same all the way around. Although~~ it ~~is no longer rotated~~ the ~~application still works. However, you will find that to use the correct rotation of the silo (~~"~~theAttachToElement~~"~~), you will~~ need ~~a different set of X,Y,Z coordinates~~.		If you make "rocketRZ = 0" you will have the correct coordinates. Again, because the offsets are based off "theAttachToElement". If you kept any rotations in the object, it would change the XYZ coordinates "theElement" would need to be attached at.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ransom: Created page with "'''This article concerns the note left in attachElements.''' ==Explanation== The offset coordinates reflect the object space, not the world space. This means that if you wer..."

2011-03-21T03:35:00Z

Created page with "'''This article concerns the note left in attachElements.''' ==Explanation== The offset coordinates reflect the object space, not the world space. This means that if you wer..."

New page

'''This article concerns the note left in [[attachElements]].'''

==Explanation==
The offset coordinates reflect the object space, not the world space. This means that if you were to calculate coordinate and rotation offsets between "theElement" and "theAttachToElement", they would not always be correct.

The example script below places a plane facing upward on a silo. The positioning was done manually in the map editor and the coordinates were saved to the script. These coordinates are reflected in the initial creation of objects "shuttletable[1]" and "shuttletable[2]".

The problem is we will need the offsets of the "theElement" in relation to "theAttachToElement". "theAttachToElement" becomes 0,0,0,0,0,0 and "theElement" will inherit the exact same coordinates and rotation, unless offsets are specified when using the [[attachElements]] function.

==Example==
Start freeroam resource and paste this into the console:
<syntaxhighlight lang="lua">setpos 1904.7426757813 -2411.1262207031 13.53911781311</syntaxhighlight>

Now, use the following script and look at the rocket. See how it is off center? This means the relation to the actual game world coordinate system has changed.

If you change rocketRZ to 0 (the silo object that the plane in attached to), this will put the rocket in the correct position. So what happened? The silo is "theAttachToElement" and it becomes 0,0,0,0,0,0. This example is unusual in that you have essentially fixed your problem. The silo looks the same all the way around. Although it is no longer rotated the application still works. However, you will find that to use the correct rotation of the silo ("theAttachToElement"), you will need a different set of X,Y,Z coordinates.

<syntaxhighlight lang="lua">
--This example illustrates the problem with using the world coordinate math to calculate offsets.
--Change rocketRZ to 0 to get the correct position.

local rocketX = 1925.022705
local rocketY = -2450.944336
local rocketZ = 18.053474
local rocketRX = 0
local rocketRY = 0
local rocketRZ = 69.61437

local vehX = 1925.112793 --more is forward
local vehY = -2446.260742 -- less is forward
local vehZ = 26.692139
local vehRX = 89.38142
local vehRY = 0.030000
local vehRZ = 177.90356

shuttletable = {}
shuttletable[1] = createObject ( 17050, rocketX, rocketY, rocketZ, rocketRX, rocketRY, rocketRZ )
shuttletable[2] = createVehicle ( 519, vehX, vehY, vehZ, vehRX, vehRY, vehRZ )

attachOffsetX = vehX-rocketX
attachOffsetY = vehY-rocketY
attachOffsetZ = vehZ-rocketZ
attachOffsetRX = vehRX-rocketRX
attachOffsetRY = vehRY-rocketRY
attachOffsetRZ = vehRZ-rocketRZ

attachElements( shuttletable[2], shuttletable[1], attachOffsetX, attachOffsetY, attachOffsetZ, attachOffsetRX, attachOffsetRY, attachOffsetRZ )</syntaxhighlight>