Creating HUDs - Revision history

Ivanova Shostakovich: Added a note about mesh use in constructing HUDs.

2024-07-28T00:55:43Z

Added a note about mesh use in constructing HUDs.

← Older revision		Revision as of 17:55, 27 July 2024
Line 40:		Line 40:
	If '''Move & View''' > '''Automatic position for: Sidebar''' is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third-party themes may ignore this setting.)		If '''Move & View''' > '''Automatic position for: Sidebar''' is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third-party themes may ignore this setting.)

	Since HUD attachments cannot be clicked through even if they're invisible, the common solutions to getting them out of the way are moving, shrinking, or rotating.		Since standard prim HUD attachments cannot be clicked through even if they're invisible, the common solutions to getting them out of the way are moving, shrinking, or rotating.

			HUD attachments can be made from mesh in such a way as to have a side that will present no face to the screen when rotated, which allows them to be clicked through. Small buttons can be included in their construction to trigger the rotation.

	Use [[llGetLocalPos\|llGetLocalPos()]] to learn an attachment's position on the screen, [[llSetPos\|llSetPos()]] to move it. ([[llGetPos\|llGetPos()]] looks tempting, but for attachments that tells us the ''avatar's'' position.)		Use [[llGetLocalPos\|llGetLocalPos()]] to learn an attachment's position on the screen, [[llSetPos\|llSetPos()]] to move it. ([[llGetPos\|llGetPos()]] looks tempting, but for attachments that tells us the ''avatar's'' position.)

Gwyneth Llewelyn: /* Differences in coordinates */ Minor typos, added some bolds on the descriptions (maybe there is an appropriate template for that? TBD)

2023-02-03T23:38:56Z

Differences in coordinates: Minor typos, added some bolds on the descriptions (maybe there is an appropriate template for that? TBD)

← Older revision		Revision as of 16:38, 3 February 2023
Line 33:		Line 33:
	HUD attachments are rendered with an orthographic projection, meaning that everything looks flat and there is no perspective. The objects are still 3D, and they can move in XYZ space and be rotated.		HUD attachments are rendered with an orthographic projection, meaning that everything looks flat and there is no perspective. The objects are still 3D, and they can move in XYZ space and be rotated.
	* The X coordinate moves away from and toward the wearer, a higher number is farther away and can hide a HUD prim behind others. You can use X changes in a single HUD object to reveal and hide buttons, for one example. There is no good way to grab the red X axis with the viewer editor, but scripts do not have this problem.		* The X coordinate moves away from and toward the wearer, a higher number is farther away and can hide a HUD prim behind others. You can use X changes in a single HUD object to reveal and hide buttons, for one example. There is no good way to grab the red X axis with the viewer editor, but scripts do not have this problem.
	* Y moves right to left on the screen, a higher number is more to the left.		* Y moves right to left on the screen; a higher number is more to the left.
	* Z moves bottom to top on the screen, a higher number is, well, higher up!		* Z moves bottom to top on the screen; a higher number is, well, higher up!

	In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The (0,0,0) position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [[FindScreenWidth]] script example can return the display width on touch, if the attachment is on one of the corner HUD slots.)		In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The (0,0,0) position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [[FindScreenWidth]] script example can return the display width on touch, if the attachment is on one of the corner HUD slots.)

	If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)		If '''Move & View''' > '''Automatic position for: Sidebar''' is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third-party themes may ignore this setting.)

	Since HUD attachments cannot be clicked through even if they're invisible, the common solutions to getting them out of the way are moving, shrinking, or rotating.		Since HUD attachments cannot be clicked through even if they're invisible, the common solutions to getting them out of the way are moving, shrinking, or rotating.

Gwyneth Llewelyn: Replaced with

2023-02-03T23:35:41Z

Replaced <source> with <syntaxhighlight>

← Older revision		Revision as of 16:35, 3 February 2023
Line 46:		Line 46:
	This example moves the HUD away from the wearer, possibly behind other HUD attachments:		This example moves the HUD away from the wearer, possibly behind other HUD attachments:

	<~~source~~ lang="lsl2">llSetPos(llGetLocalPos() + (<0.25, 0.0, 0.0> * llGetLocalRot()));</~~source~~>		<syntaxhighlight lang="lsl2">llSetPos(llGetLocalPos() + (<0.25, 0.0, 0.0> * llGetLocalRot()));</syntaxhighlight>


	[[Category:Content creation]]		[[Category:Content creation]]

Madi Melodious: replaced the missing images.

2021-09-10T16:56:43Z

replaced the missing images.

← Older revision		Revision as of 09:56, 10 September 2021
Line 29:		Line 29:

	==== Differences in coordinates ====		==== Differences in coordinates ====
	[[Image:HUD-center-coordinates.~~png~~\|thumb\|300px\|HUD center coordinates]]		[[Image:HUD-center-coordinates 2.jpg\|thumb\|300px\|HUD center coordinates]]
	[[Image:HUD-bottomright-coordinates.~~png~~\|thumb\|right\|300px\|HUD bottom right coordinates]]		[[Image:300px-HUD-bottomright-coordinates.jpg\|thumb\|right\|300px\|HUD bottom right coordinates]]
	HUD attachments are rendered with an orthographic projection, meaning that everything looks flat and there is no perspective. The objects are still 3D, and they can move in XYZ space and be rotated.		HUD attachments are rendered with an orthographic projection, meaning that everything looks flat and there is no perspective. The objects are still 3D, and they can move in XYZ space and be rotated.
	* The X coordinate moves away from and toward the wearer, a higher number is farther away and can hide a HUD prim behind others. You can use X changes in a single HUD object to reveal and hide buttons, for one example. There is no good way to grab the red X axis with the viewer editor, but scripts do not have this problem.		* The X coordinate moves away from and toward the wearer, a higher number is farther away and can hide a HUD prim behind others. You can use X changes in a single HUD object to reveal and hide buttons, for one example. There is no good way to grab the red X axis with the viewer editor, but scripts do not have this problem.

ObviousAltIsObvious Resident: /* Building and Texturing HUDs */ note that fullbright is now forced to on

2015-12-27T16:21:37Z

Building and Texturing HUDs: note that fullbright is now forced to on

← Older revision		Revision as of 09:21, 27 December 2015
Line 7:		Line 7:
	It is easiest to keep the root prim rotation at <0., 0., 0.> while building. That way, you can know that the west side of the object will be the one facing the screen when attached. For a box prim, that is [[face]] 4.		It is easiest to keep the root prim rotation at <0., 0., 0.> while building. That way, you can know that the west side of the object will be the one facing the screen when attached. For a box prim, that is [[face]] 4.

	HUD attachments ~~use the same lighting~~ as ~~everything else in SL. Full~~ bright ~~can help make your interface more readable, but it can also work nicely to let the "natural" lighting through for less intrusion on the world beyond the screen~~.		Since an update about 2012 ({{JIRA\|SH-2646}}), HUD attachments are always rendered as full bright.

	Prim alpha and texture transparency work as expected. If you want your HUD to be totally transparent, consider making only the front faces that way. The flat projection will keep the other sides hidden, and it will be easier for residents to find the object if accidentally dropped or forgotten on the ground.		Prim alpha and texture transparency work as expected. If you want your HUD to be totally transparent, consider making only the front faces that way. The flat projection will keep the other sides hidden, and it will be easier for residents to find the object if accidentally dropped or forgotten on the ground.

ObviousAltIsObvious Resident: tag to , switch example to local copy

2015-01-24T21:56:31Z

<lsl> tag to <source>, switch example to local copy

← Older revision		Revision as of 14:56, 24 January 2015
Line 36:		Line 36:
	* Z moves bottom to top on the screen, a higher number is, well, higher up!		* Z moves bottom to top on the screen, a higher number is, well, higher up!

	In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The (0,0,0) position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [~~http://lslwiki.net/lslwiki/wakka.php?wakka=HeadsUpDisplay HeadsUpDisplay~~] ~~page on lslwiki.net has an interesting snippet that~~ can return the display width on touch, if the attachment is on one of the corner HUD slots.)		In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The (0,0,0) position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [[FindScreenWidth]] script example can return the display width on touch, if the attachment is on one of the corner HUD slots.)

	If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)		If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)
Line 46:		Line 46:
	This example moves the HUD away from the wearer, possibly behind other HUD attachments:		This example moves the HUD away from the wearer, possibly behind other HUD attachments:

	<~~lsl~~>llSetPos(llGetLocalPos() + (<0.25, 0.0, 0.0> * llGetLocalRot()));</~~lsl~~>		<source lang="lsl2">llSetPos(llGetLocalPos() + (<0.25, 0.0, 0.0> * llGetLocalRot()));</source>


	[[Category:Content creation]]		[[Category:Content creation]]

Cerise Resident: /* Differences in behavior */ sometimes duct tape is the right tool for the job.

2014-01-27T16:33:50Z

Differences in behavior: sometimes duct tape is the right tool for the job.

← Older revision		Revision as of 09:33, 27 January 2014
Line 25:		Line 25:
	* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at (0, 0, 0) globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>		* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at (0, 0, 0) globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>
	* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>		* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>
	* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great ~~effect~~.		* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great advantage.
	* [[Shared Media]] works on the HUD in Viewer 2.2 and later. On earlier 2.x viewers, clicks and audio may not be available.		* [[Shared Media]] works on the HUD in Viewer 2.2 and later. On earlier 2.x viewers, clicks and audio may not be available.

Omei Qunhua: /* Differences in coordinates */ well this is

2014-01-21T15:17:25Z

Differences in coordinates: well this is

← Older revision		Revision as of 08:17, 21 January 2014
Line 36:		Line 36:
	* Z moves bottom to top on the screen, a higher number is, well, higher up!		* Z moves bottom to top on the screen, a higher number is, well, higher up!

	In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The ~~[[ZERO_VECTOR]]~~ position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [http://lslwiki.net/lslwiki/wakka.php?wakka=HeadsUpDisplay HeadsUpDisplay] page on lslwiki.net has an interesting snippet that can return the display width on touch, if the attachment is on one of the corner HUD slots.)		In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The (0,0,0) position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [http://lslwiki.net/lslwiki/wakka.php?wakka=HeadsUpDisplay HeadsUpDisplay] page on lslwiki.net has an interesting snippet that can return the display width on touch, if the attachment is on one of the corner HUD slots.)

	If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)		If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)

Cerise Sorbet: This is a viewer coordinate.

2014-01-21T03:39:37Z

This is a viewer coordinate.

← Older revision		Revision as of 20:39, 20 January 2014
Line 23:		Line 23:
	** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.		** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.
	* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.		* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.
	* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at ~~[[ZERO_VECTOR]]~~ globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>		* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at (0, 0, 0) globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>
	* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>		* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>
	* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.		* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.

Kireji Haiku at 23:27, 20 January 2014

2014-01-20T23:27:17Z

← Older revision		Revision as of 16:27, 20 January 2014
Line 17:		Line 17:
	=== Scripting HUDs ===		=== Scripting HUDs ===

	Most scripted functionality works with HUDs. They mostly work like any other attachment, but there are some special exceptions.		Most scripted functionality works with HUDs. They mostly work like any other attachment, but there are some special exceptions. A page with an [[HTML_HUD_Demo]] can be found on this wiki as well.

	==== Differences in behavior ====		==== Differences in behavior ====
Line 23:		Line 23:
	** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.		** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.
	* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.		* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.
	* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at ~~(0, 0, 0) in~~ the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>		* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at [[ZERO_VECTOR]] globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>
	* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>		* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>
	* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.		* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.
Line 36:		Line 36:
	* Z moves bottom to top on the screen, a higher number is, well, higher up!		* Z moves bottom to top on the screen, a higher number is, well, higher up!

	In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The ~~<code><0., 0., 0.></code>~~ position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [http://lslwiki.net/lslwiki/wakka.php?wakka=HeadsUpDisplay HeadsUpDisplay] page on lslwiki.net has an interesting snippet that can return the display width on touch, if the attachment is on one of the corner HUD slots.)		In HUD space, 1 meter is the height of the viewer window, ''including'' the menus and tool bar. The [[ZERO_VECTOR]] position depends on the HUD attachment point. For the Center and Center 2 points, zero is the center of the screen. For the four corner HUD points, zero is that corner of the viewer window. Zero for the top and bottom is centered on the window, again hidden behind the menu or toolbar. There is no way provided to learn the ''width'' of the viewer window, or the pixel dimensions. (The [http://lslwiki.net/lslwiki/wakka.php?wakka=HeadsUpDisplay HeadsUpDisplay] page on lslwiki.net has an interesting snippet that can return the display width on touch, if the attachment is on one of the corner HUD slots.)

	If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)		If "Move & View>Automatic position for: Sidebar" is ''checked'', the HUD coordinates will automatically be scaled to exclude the sidebar when it is open. If this feature is ''unchecked'', the entire window width is used regardless. (Some third party themes may ignore this setting.)
Line 46:		Line 46:
	This example moves the HUD away from the wearer, possibly behind other HUD attachments:		This example moves the HUD away from the wearer, possibly behind other HUD attachments:

	<lsl>llSetPos(llGetLocalPos() + (<0.25,0,0> * llGetLocalRot()));</lsl>		<lsl>llSetPos(llGetLocalPos() + (<0.25, 0.0, 0.0> * llGetLocalRot()));</lsl>


	[[Category:Content creation]]		[[Category:Content creation]]

← Older revision		Revision as of 20:39, 20 January 2014
Line 23:		Line 23:
	** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.		** If a sound is triggered using [[llTriggerSound\|llTriggerSound()]], the wearer and any bystanders will hear it.
	* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.		* Like with all attachments, [[llSensor\|llSensor()]] will not detect the attachment or its wearer.
	* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at ~~[[ZERO_VECTOR]]~~ globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>		* Particles do not generally work. Since Viewer 1.23 there is an experimental debug setting '''RenderHUDParticles''' that you can try, but it is incomplete and switched off by default. On very old viewers (before 1.23) HUD particles would show in world, at (0, 0, 0) globally within the region (the southwest corner). <sup>{{Jira\|SVC-2396}}</sup>
	* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>		* [[Glow]] is not supported on HUD attachments. <sup>{{Jira\|VWR-3167}}</sup>
	* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.		* [[llSetText\|llSetText()]] is supported, but be aware that the text does not scale with the HUD or screen size, and the text size is under user control. Despite the limitations, some HUD objects use it to great effect.