GetElementMatrix - Revision history

Zangomangu: Undo revision 67564 by Daddy (talk)

2020-12-25T22:08:41Z

Undo revision 67564 by Daddy (talk)

← Older revision		Revision as of 22:08, 25 December 2020
Line 14:		Line 14:

	===Optional Arguments===		===Optional Arguments===
	*'''legacy:''' Set to ''false'' to return correctly setup [[~~'''~~matrix~~'''~~]] (i.e. Last column in the first 3 rows set to zero).		*'''legacy:''' Set to ''false'' to return correctly setup [[matrix]] (i.e. Last column in the first 3 rows set to zero).

	===Returns===		===Returns===

Daddy: /* Syntax */

2020-10-16T22:06:49Z

Syntax

← Older revision		Revision as of 22:06, 16 October 2020
Line 14:		Line 14:

	===Optional Arguments===		===Optional Arguments===
	*'''legacy:''' Set to ''false'' to return correctly setup [[matrix]] (i.e. Last column in the first 3 rows set to zero).		*'''legacy:''' Set to ''false'' to return correctly setup [['''matrix''']] (i.e. Last column in the first 3 rows set to zero).

	===Returns===		===Returns===

El Zorro: /* Example */

2017-08-10T20:35:34Z

Example

← Older revision		Revision as of 20:35, 10 August 2017
Line 98:		Line 98:


	<section name="Front to Front" class="server" show="true">		<section name="Server side: Front to Front" class="server" show="true">
	-- create a Ped (0, 0, 5, 0) and put the player to 10 m of distance, front to front		-- create a Ped (0, 0, 5, 0) and put the player to 10 m of distance, front to front
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

El Zorro: /* Example */

2017-08-10T20:34:40Z

Example

← Older revision		Revision as of 20:34, 10 August 2017
Line 98:		Line 98:


	<section name="~~Testing~~" class="server" show="true">		<section name="Front to Front" class="server" show="true">
	-- create a Ped (0, 0, 5, 0) and put the player to 10 m of distance, front to front		-- create a Ped (0, 0, 5, 0) and put the player to 10 m of distance, front to front
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

El Zorro: /* Example */

2017-08-10T20:33:48Z

Example

@@ Line 94: / Line 94: @@
 end
 </syntaxhighlight>
 ==Changelog==

Qaisjp: shared!

2016-07-31T02:41:15Z

shared!

← Older revision		Revision as of 02:41, 31 July 2016
Line 1:		Line 1:
	{{~~Client~~ function}}		{{Shared function}}
	__NOTOC__		__NOTOC__
	This function gets an [[element]]'s transform [[matrix]]. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.		This function gets an [[element]]'s transform [[matrix]]. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.

Arezu: Why was this text changed? the regular getElementMatrix returns false for objects that are not streamed in.

2015-03-10T09:55:43Z

Why was this text changed? the regular getElementMatrix returns false for objects that are not streamed in.

← Older revision		Revision as of 09:55, 10 March 2015
Line 63:		Line 63:
	</syntaxhighlight>		</syntaxhighlight>

	This example function ~~shows~~ you ~~what getElementMatrix does internally~~.		This example function allows you to get the element matrix of an element that is not streamed in.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getElementMatrix(element)		function getElementMatrix(element)

HuX: /* Example */

2015-03-09T23:12:12Z

Example

← Older revision		Revision as of 23:12, 9 March 2015
Line 30:		Line 30:
	end		end

	-- Get the position of a point 3 units to the ~~left~~ of the element:		-- Get the position of a point 3 units to the right of the element:
	x,y,z = getPositionFromElementOffset(element,3,0,0)		x,y,z = getPositionFromElementOffset(element,3,0,0)

Strix at 00:09, 10 December 2014

2014-12-10T00:09:08Z

← Older revision		Revision as of 00:09, 10 December 2014
Line 8:		Line 8:
	table getElementMatrix ( element theElement [, bool legacy = true ] )		table getElementMatrix ( element theElement [, bool legacy = true ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:getMatrix\|matrix}}		{{OOP\|\|[[element]]:getMatrix\|matrix\|setElementMatrix}}

	===Required Arguments===		===Required Arguments===

AlexTMjugador: Added OOP syntax, fixed tabs in examples and some minor changes

2014-11-26T16:32:51Z

Added OOP syntax, fixed tabs in examples and some minor changes

← Older revision		Revision as of 16:32, 26 November 2014
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function gets an element's transform matrix. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.		This function gets an [[element]]'s transform [[matrix]]. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.
	{{Note\|The matrix returned by this function is [http://bugs.mtasa.com/view.php?id{{=}}6984 not setup correctly for some calculations.] unless the '''legacy''' argument is set to '''false'''}}		{{Note\|The [[matrix]] returned by this function is [http://bugs.mtasa.com/view.php?id{{=}}6984 not setup correctly for some calculations] unless the '''legacy''' argument is set to '''''false'''''.}}
	{{Tip\|''For matrix manipulation which goes beyond the basic examples given on this page, see the [[Lua matrix library]].''}}		{{Tip\|''For [[matrix]] manipulation which goes beyond the basic examples given on this page, see the [[Lua matrix library]].'' If you are using MTA: SA 1.4 or higher, using the built-in [[matrix]] class is also recommended.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getElementMatrix ( element theElement [, bool legacy = true ] )		table getElementMatrix ( element theElement [, bool legacy = true ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[element]]:getMatrix\|matrix}}

	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The element which you wish to retrieve the matrix for		*'''theElement:''' The [[element]] which you wish to retrieve the [[matrix]] for.

	===Optional Arguments===		===Optional Arguments===
	*'''legacy :''' Set to false to return correctly setup matrix. (i.e. Last column in the first 3 rows set to zero.)		*'''legacy:''' Set to ''false'' to return correctly setup [[matrix]] (i.e. Last column in the first 3 rows set to zero).

	===Returns===		===Returns===
	Returns a multi-dimensional array containing a 4x4 matrix. Returns false if the element is not streamed in, and not a vehicle or ~~ped~~.		Returns a multi-dimensional array (which can be transformed into a proper [[matrix]] class using ''Matrix.create'' method) containing a 4x4 matrix. Returns ''false'' if the element is not streamed in, and not a [[vehicle]], [[ped]] or [[object]].

	==Example==		==Example==
Line 22:		Line 23:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getPositionFromElementOffset(element,offX,offY,offZ)		function getPositionFromElementOffset(element,offX,offY,offZ)
	local m = getElementMatrix ( element ) -- Get the matrix		local m = getElementMatrix ( element ) -- Get the matrix
	local x = offX * m[1][1] + offY * m[2][1] + offZ * m[3][1] + m[4][1] -- Apply transform		local x = offX * m[1][1] + offY * m[2][1] + offZ * m[3][1] + m[4][1] -- Apply transform
	local y = offX * m[1][2] + offY * m[2][2] + offZ * m[3][2] + m[4][2]		local y = offX * m[1][2] + offY * m[2][2] + offZ * m[3][2] + m[4][2]
	local z = offX * m[1][3] + offY * m[2][3] + offZ * m[3][3] + m[4][3]		local z = offX * m[1][3] + offY * m[2][3] + offZ * m[3][3] + m[4][3]
	return x, y, z -- Return the transformed point		return x, y, z -- Return the transformed point
	end		end

Line 43:		Line 44:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getMatrixLeft(m)		function getMatrixLeft(m)
	return m[1][1], m[1][2], m[1][3]		return m[1][1], m[1][2], m[1][3]
	end		end
	function getMatrixForward(m)		function getMatrixForward(m)
	return m[2][1], m[2][2], m[2][3]		return m[2][1], m[2][2], m[2][3]
	end		end
	function getMatrixUp(m)		function getMatrixUp(m)
	return m[3][1], m[3][2], m[3][3]		return m[3][1], m[3][2], m[3][3]
	end		end
	function getMatrixPosition(m)		function getMatrixPosition(m)
	return m[4][1], m[4][2], m[4][3]		return m[4][1], m[4][2], m[4][3]
	end		end

Line 62:		Line 63:
	</syntaxhighlight>		</syntaxhighlight>

	This example function shows you what getElementMatrix does internally		This example function shows you what getElementMatrix does internally.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getElementMatrix(element)		function getElementMatrix(element)
	local rx, ry, rz = getElementRotation(element, "ZXY")		local rx, ry, rz = getElementRotation(element, "ZXY")
	rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)		rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)
	local matrix = {}		local matrix = {}
	matrix[1] = {}		matrix[1] = {}
	matrix[1][1] = math.cos(rz)math.cos(ry) - math.sin(rz)math.sin(rx)*math.sin(ry)		matrix[1][1] = math.cos(rz)math.cos(ry) - math.sin(rz)math.sin(rx)*math.sin(ry)
	matrix[1][2] = math.cos(ry)math.sin(rz) + math.cos(rz)math.sin(rx)*math.sin(ry)		matrix[1][2] = math.cos(ry)math.sin(rz) + math.cos(rz)math.sin(rx)*math.sin(ry)
	matrix[1][3] = -math.cos(rx)*math.sin(ry)		matrix[1][3] = -math.cos(rx)*math.sin(ry)
	matrix[1][4] = 1		matrix[1][4] = 1

	matrix[2] = {}		matrix[2] = {}
	matrix[2][1] = -math.cos(rx)*math.sin(rz)		matrix[2][1] = -math.cos(rx)*math.sin(rz)
	matrix[2][2] = math.cos(rz)*math.cos(rx)		matrix[2][2] = math.cos(rz)*math.cos(rx)
	matrix[2][3] = math.sin(rx)		matrix[2][3] = math.sin(rx)
	matrix[2][4] = 1		matrix[2][4] = 1

	matrix[3] = {}		matrix[3] = {}
	matrix[3][1] = math.cos(rz)math.sin(ry) + math.cos(ry)math.sin(rz)*math.sin(rx)		matrix[3][1] = math.cos(rz)math.sin(ry) + math.cos(ry)math.sin(rz)*math.sin(rx)
	matrix[3][2] = math.sin(rz)math.sin(ry) - math.cos(rz)math.cos(ry)*math.sin(rx)		matrix[3][2] = math.sin(rz)math.sin(ry) - math.cos(rz)math.cos(ry)*math.sin(rx)
	matrix[3][3] = math.cos(rx)*math.cos(ry)		matrix[3][3] = math.cos(rx)*math.cos(ry)
	matrix[3][4] = 1		matrix[3][4] = 1

	matrix[4] = {}		matrix[4] = {}
	matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)		matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)
	matrix[4][4] = 1		matrix[4][4] = 1

	return matrix		return matrix
	end		end
	</syntaxhighlight>		</syntaxhighlight>