SetElementBoneQuaternion - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:35:16Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:35, 7 November 2024
Line 50:		Line 50:
	)		)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.6.0-9.22741}}~~

	==See Also==		==See Also==
	{{Client_element_functions}}		{{Client_element_functions}}

Nico834: Add correct revision

2024-09-30T04:32:39Z

Add correct revision

← Older revision		Revision as of 04:32, 30 September 2024
Line 2:		Line 2:
	{{Client function}}		{{Client function}}

	{{New feature/item\|3.0161\|1.6.0\|~~22722~~\|		{{New feature/item\|3.0161\|1.6.0\|22741\|
	This function determines how a particular bone rotates in relation to the element.<br/>		This function determines how a particular bone rotates in relation to the element.<br/>
	The use of [https://en.wikipedia.org/wiki/Quaternion quaternions] are more effective and do not generate issues like gimbal lock that might arise with [https://en.wikipedia.org/wiki/Euler_angles Euler angles], so they are a preferable choice for rotation.		The use of [https://en.wikipedia.org/wiki/Quaternion quaternions] are more effective and do not generate issues like gimbal lock that might arise with [https://en.wikipedia.org/wiki/Euler_angles Euler angles], so they are a preferable choice for rotation.
Line 52:		Line 52:

	==Requirements==		==Requirements==
	{{Requirements\|n/a\|1.6.0-9.~~22722~~}}		{{Requirements\|n/a\|1.6.0-9.22741}}

	==See Also==		==See Also==
	{{Client_element_functions}}		{{Client_element_functions}}

Nico834: Add some space

2024-09-30T04:26:41Z

Add some space

← Older revision		Revision as of 04:26, 30 September 2024
Line 9:		Line 9:
	{{Tip\|If you want to attach an element to a bone, see [[attachElementToBone]].}}		{{Tip\|If you want to attach an element to a bone, see [[attachElementToBone]].}}
	{{Note\|If you want to apply the rotation, [[updateElementRpHAnim]] must be called after this function.}}		{{Note\|If you want to apply the rotation, [[updateElementRpHAnim]] must be called after this function.}}

	[[File:Cayley_Q8_multiplication_graph.png\|thumb\|[https://en.wikipedia.org/wiki/Cayley_graph Cayley Q8 graph] showing the six cycles of multiplication by <span style="color: red;">'''i'''</span>, <span style="color: green;">'''j'''</span> and <span style="color: blue;">'''k'''</span>.]]

	==Syntax==		==Syntax==
Line 16:		Line 14:
	bool setElementBoneQuaternion(element ped, int bone, float x, float y, float z, float w)		bool setElementBoneQuaternion(element ped, int bone, float x, float y, float z, float w)
	</syntaxhighlight>		</syntaxhighlight>

			[[File:Cayley_Q8_multiplication_graph.png\|thumb\|[https://en.wikipedia.org/wiki/Cayley_graph Cayley Q8 graph] showing the six cycles of multiplication by <span style="color: red;">'''i'''</span>, <span style="color: green;">'''j'''</span> and <span style="color: blue;">'''k'''</span>.]]

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

Nico834: Add Cayley Q8 graph

2024-09-30T04:25:21Z

Add Cayley Q8 graph

← Older revision		Revision as of 04:25, 30 September 2024
Line 9:		Line 9:
	{{Tip\|If you want to attach an element to a bone, see [[attachElementToBone]].}}		{{Tip\|If you want to attach an element to a bone, see [[attachElementToBone]].}}
	{{Note\|If you want to apply the rotation, [[updateElementRpHAnim]] must be called after this function.}}		{{Note\|If you want to apply the rotation, [[updateElementRpHAnim]] must be called after this function.}}

			[[File:Cayley_Q8_multiplication_graph.png\|thumb\|[https://en.wikipedia.org/wiki/Cayley_graph Cayley Q8 graph] showing the six cycles of multiplication by <span style="color: red;">'''i'''</span>, <span style="color: green;">'''j'''</span> and <span style="color: blue;">'''k'''</span>.]]

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

Nico834: Undo revision 80611 by Nico834 (talk)

2024-09-30T04:02:30Z

Undo revision 80611 by Nico834 (talk)

@@ Line 6: / Line 6: @@
 The use of [https://en.wikipedia.org/wiki/Quaternion quaternions] are more effective and do not generate issues like gimbal lock that might arise with [https://en.wikipedia.org/wiki/Euler_angles Euler angles], so they are a preferable choice for rotation.
 }}
 {{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}

Nico834 at 04:02, 30 September 2024

2024-09-30T04:02:08Z

@@ Line 6: / Line 6: @@
 The use of [https://en.wikipedia.org/wiki/Quaternion quaternions] are more effective and do not generate issues like gimbal lock that might arise with [https://en.wikipedia.org/wiki/Euler_angles Euler angles], so they are a preferable choice for rotation.
 }}
 {{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}

Nico834: Add some fixes

2024-09-16T20:54:31Z

Add some fixes

← Older revision		Revision as of 20:54, 16 September 2024
Line 33:		Line 33:

	==Example==		==Example==
	This example rotates the player's ~~head~~ 180 degrees around an arbitrary axis.<br/>		This example rotates the player's pelvis 180 degrees around an arbitrary axis.<br/>
	The use of [[updateElementRpHAnim]] is necessary here as it applies the rotation.		The use of [[updateElementRpHAnim]] is necessary here as it applies the rotation.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

FileEX: Stylistic corrections

2024-09-16T10:16:49Z

Stylistic corrections

← Older revision		Revision as of 10:16, 16 September 2024
Line 31:		Line 31:
	===Returns===		===Returns===
	Returns ''true'' if the set was successful, otherwise returns an error message and returns ''false''.		Returns ''true'' if the set was successful, otherwise returns an error message and returns ''false''.

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.6.0-9.22722}}~~

	==Example==		==Example==
	~~<section name="Client" class="client" show="true">~~
	This example rotates the player's head 180 degrees around an arbitrary axis.<br/>		This example rotates the player's head 180 degrees around an arbitrary axis.<br/>
	The use of [[updateElementRpHAnim]] is necessary here as it applies the rotation.		The use of [[updateElementRpHAnim]] is necessary here as it applies the rotation.
Line 51:		Line 47:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	</~~section>~~
			==Requirements==
			{{Requirements\|n/a\|1.6.0-9.22722}}

	==See Also==		==See Also==
	{{Client_element_functions}}		{{Client_element_functions}}

Nico834: Add documentation

2024-09-15T19:37:58Z

Add documentation

New page

__NOTOC__
{{Client function}}

{{New feature/item|3.0161|1.6.0|22722|
This function determines how a particular bone rotates in relation to the element.<br/>
The use of [https://en.wikipedia.org/wiki/Quaternion quaternions] are more effective and do not generate issues like gimbal lock that might arise with [https://en.wikipedia.org/wiki/Euler_angles Euler angles], so they are a preferable choice for rotation.
}}

{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}
{{Note|If you want to apply the rotation, [[updateElementRpHAnim]] must be called after this function.}}
==Syntax==
<syntaxhighlight lang="lua">
bool setElementBoneQuaternion(element ped, int bone, float x, float y, float z, float w)
</syntaxhighlight>

===Required Arguments===
* '''ped:''' The [[element]] (ped or player) on which the bone's rotation will be set.
* '''bone:''' The ID of the bone to set the quaternion of.
:* The bone ID corresponds to specific body parts like arms, legs, spine, head, etc.
:* The full list of bones is available in the [[Bone IDs]] reference.
* '''x:''' The quaternion's coefficient of the 𝑖 component.
:* This represents the rotation around the x-axis and is the first imaginary part of the quaternion.
* '''y:''' The quaternion's coefficient of the 𝑗 component.
:* This represents the rotation around the y-axis and is the second imaginary part of the quaternion.
* '''z:''' The quaternion's coefficient of the 𝑘 component.
:* This represents the rotation around the z-axis and is the third imaginary part of the quaternion.
* '''w:''' The real part of the quaternion.
:* This denotes the scalar component of the quaternion, which is linked to the angle of rotation.
:* The '''w''' value is derived by taking the cosine of half of the rotation angle, defined as the overall angle of rotation.

===Returns===
Returns ''true'' if the set was successful, otherwise returns an error message and returns ''false''.

==Requirements==
{{Requirements|n/a|1.6.0-9.22722}}

==Example==
<section name="Client" class="client" show="true">
This example rotates the player's head 180 degrees around an arbitrary axis.<br/>
The use of [[updateElementRpHAnim]] is necessary here as it applies the rotation.
<syntaxhighlight lang="lua">
local playerBone = 1
local playerBoneX, playerBoneY, playerBoneZ = 0.577, 0.577, 0.577
local playerBoneW = 0

addEventHandler("onClientPedsProcessed", root,
function()
setElementBoneQuaternion(localPlayer, playerBone, playerBoneX, playerBoneY, playerBoneZ, playerBoneW)
updateElementRpHAnim(localPlayer)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_element_functions}}