The Positioning Sequence - Revision history

Rob at 08:36, 22 November 2008

2008-11-22T08:36:55Z

← Older revision		Revision as of 08:36, 22 November 2008
Line 1:		Line 1:
	~~[[Category:~~Basic Concepts and Terminology]]		{{context\|Basic Concepts and Terminology\|Manipulation of Visual Elements}}
	~~[Context: [[Home~~\|~~HL Kit]] [[Basic Concepts and Terminology]] [[~~Manipulation of Visual Elements~~]]]~~

	==The Position Script==		==The Position Script==

Rob: /* Positioning Scenes (Panels, Forms, and Sheets) */

2008-11-21T14:05:07Z

Positioning Scenes (Panels, Forms, and Sheets)

← Older revision		Revision as of 14:05, 21 November 2008
Line 20:		Line 20:
	Rendering a layout does not place anything on the screen or page. All it does is trigger appropriate sizing, positioning, and state configuration. It is perfectly valid to render a layout multiple times. In fact, there will be situations where you will want to do this to optimally position information. You can render a layout, find out about size of the layout, force a change to the layout, then render the layout again.		Rendering a layout does not place anything on the screen or page. All it does is trigger appropriate sizing, positioning, and state configuration. It is perfectly valid to render a layout multiple times. In fact, there will be situations where you will want to do this to optimally position information. You can render a layout, find out about size of the layout, force a change to the layout, then render the layout again.

	~~'''NOTE!'''~~ Rendering a layout multiple times is computationally expensive. Consequently, you should limit re-rendering to only be used when it is truly needed.		{{note}}Rendering a layout multiple times is computationally expensive. Consequently, you should limit re-rendering to only be used when it is truly needed.

	==Positioning Layouts==		==Positioning Layouts==

Rob: /* Positioning Panels and Sheets */

2008-11-21T00:38:14Z

Positioning Panels and Sheets

← Older revision		Revision as of 00:38, 21 November 2008
Line 12:		Line 12:
	Prior to doing the recursive positioning, all visual elements within the scene are properly reset. This entails setting their position to (0,0), performing default sizing, and initializing their default state. In general, only portals possess default sizing and state.		Prior to doing the recursive positioning, all visual elements within the scene are properly reset. This entails setting their position to (0,0), performing default sizing, and initializing their default state. In general, only portals possess default sizing and state.

	==Positioning Panels and Sheets==		==Positioning Scenes (Panels, Forms, and Sheets)==

	All positioning starts with a top-level visual element: either a panel or a sheet. Within the ~~top-level element~~, the Position script is invoked. After the script returns, any child layout that has not yet been rendered is now rendered.		All positioning starts with a top-level visual element: either a panel, a form, or a sheet. Within the scene, the Position script is invoked. After the script returns, any child layout that has not yet been rendered is now rendered.

	Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to the first one. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout invokes the Position script for that layout immediately. Since each layout is automatically rendered at the end, triggering the render from the Position script is only necessary if the rendered results are needed within the script.		Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to the first one. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout invokes the Position script for that layout immediately. Since each layout is automatically rendered at the end, triggering the render from the Position script is only necessary if the rendered results are needed within the script.

Rob: /* Recursive Descent Through Hierarchy */

2008-11-21T00:36:35Z

Recursive Descent Through Hierarchy

← Older revision		Revision as of 00:36, 21 November 2008
Line 8:		Line 8:
	==Recursive Descent Through Hierarchy==		==Recursive Descent Through Hierarchy==

	The HL engine utilizes a consistent process for positioning all of the visual elements. Each top-level element (i.e. ~~panel or sheet~~) is handled independently. Within the context of each ~~top-level element~~, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent. How this works is ~~details~~ in the sections below.		The HL engine utilizes a consistent process for positioning all of the visual elements. Each top-level element (i.e. scene) is handled independently. Within the context of each scene, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent. How this works is detailed in the sections below.

	Prior to doing the recursive positioning, all visual elements within the ~~top-level element~~ are properly reset. This entails setting their position to (0,0), performing default sizing, and initializing their default state. In general, only portals possess default sizing and state.		Prior to doing the recursive positioning, all visual elements within the scene are properly reset. This entails setting their position to (0,0), performing default sizing, and initializing their default state. In general, only portals possess default sizing and state.

	==Positioning Panels and Sheets==		==Positioning Panels and Sheets==

Rob at 11:29, 20 November 2008

2008-11-20T11:29:18Z

← Older revision		Revision as of 11:29, 20 November 2008
Line 31:		Line 31:

	'''NOTE!''' Rendering a template multiple times is computationally expensive. Consequently, you should limit re-rendering to only be used when it is truly needed.		'''NOTE!''' Rendering a template multiple times is computationally expensive. Consequently, you should limit re-rendering to only be used when it is truly needed.

			==Positioning Templates and Portals==

			When a template is positioned, its Position script is invoked. This orchestrates the sizing and positioning of all portals within the template. Unlike the above visual elements, when the Position script returns for a template, there is nothing more to do for that template and/or its contents.

Rob at 11:26, 20 November 2008

2008-11-20T11:26:18Z

@@ Line 19: / Line 19: @@
 Rendering a layout does not place anything on the screen or page. All it does is trigger appropriate sizing, positioning, and state configuration. It is perfectly valid to render a layout multiple times. In fact, there will be situations where you will want to do this to optimally position information. You can render a layout, find out about size of the layout, force a change to the layout, then render the layout again.
 ==Positioning Layouts==
--Layouts possess a single "position" script that can be used for all positioning
+In the same way that layout rendering does not actually output anything, template rendering simply determines the position, size, and state of the template and its contents. Nothing is actually output, so it is valid to render a template multiple times, and there may be situations where you need to do that.
-==Rendering Layouts and Templates==
+'''NOTE!''' Rendering a template multiple times is computationally expensive. Consequently, you should limit re-rendering to only be used when it is truly needed.

Rob at 11:14, 20 November 2008

2008-11-20T11:14:25Z

← Older revision		Revision as of 11:14, 20 November 2008
Line 14:		Line 14:
	==Positioning Panels and Sheets==		==Positioning Panels and Sheets==

	All positioning starts with a top-level visual element: either a panel or a sheet. ~~For each~~ top-level element, the Position script is invoked. After the script returns, any child layout that has not yet been rendered is now rendered.		All positioning starts with a top-level visual element: either a panel or a sheet. Within the top-level element, the Position script is invoked. After the script returns, any child layout that has not yet been rendered is now rendered.

	Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to the first one. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout invokes the Position script for that layout immediately.		Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to the first one. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout invokes the Position script for that layout immediately. Since each layout is automatically rendered at the end, triggering the render from the Position script is only necessary if the rendered results are needed within the script.

			Rendering a layout does not place anything on the screen or page. All it does is trigger appropriate sizing, positioning, and state configuration. It is perfectly valid to render a layout multiple times. In fact, there will be situations where you will want to do this to optimally position information. You can render a layout, find out about size of the layout, force a change to the layout, then render the layout again.

			==Positioning Layouts==

	~~rendering does not put anything on the screen or page - it only triggers appropriate sizing, positioning, and state configuration~~

Rob at 11:06, 20 November 2008

2008-11-20T11:06:22Z

← Older revision		Revision as of 11:06, 20 November 2008
Line 8:		Line 8:
	==Recursive Descent Through Hierarchy==		==Recursive Descent Through Hierarchy==

	The HL engine utilizes a consistent process for positioning all of the visual elements. Each top-level element (i.e. panel or sheet) is handled independently. Within the context of each top-level element, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent.		The HL engine utilizes a consistent process for positioning all of the visual elements. Each top-level element (i.e. panel or sheet) is handled independently. Within the context of each top-level element, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent. How this works is details in the sections below.

	~~The overall~~ positioning ~~sequence can be defined as follows for a given~~ top-level ~~visual~~ element.		Prior to doing the recursive positioning, all visual elements within the top-level element are properly reset. This entails setting their position to (0,0), performing default sizing, and initializing their default state. In general, only portals possess default sizing and state.

	~~#Recursively process all visual elements within the top-level element to reset their position to (0,0), perform default sizing,~~ and ~~initialize the default state. In general, only portals possess default sizing and state.~~		==Positioning Panels and Sheets==
	~~#Invoke the Position script for the top-level visual element.~~
	~~#Any child layout of the top-level element that has not yet been rendered is now rendered.~~

	Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to it. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout		All positioning starts with a top-level visual element: either a panel or a sheet. For each top-level element, the Position script is invoked. After the script returns, any child layout that has not yet been rendered is now rendered.

			Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to the first one. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout invokes the Position script for that layout immediately.

			rendering does not put anything on the screen or page - it only triggers appropriate sizing, positioning, and state configuration

Rob: /* Recursive Descent Through Hierarchy */

2008-11-20T10:57:50Z

Recursive Descent Through Hierarchy

← Older revision		Revision as of 10:57, 20 November 2008
Line 8:		Line 8:
	==Recursive Descent Through Hierarchy==		==Recursive Descent Through Hierarchy==

	The HL engine utilizes a ~~strict~~ process for positioning all of the visual elements. Each top-level element (i.e. panel or sheet) is handled independently. Within the context of each top-level element, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent.		The HL engine utilizes a consistent process for positioning all of the visual elements. Each top-level element (i.e. panel or sheet) is handled independently. Within the context of each top-level element, a recursive descent is performed upon all of the visual elements it contains, invoking the Position script within each visual element during the descent.

	The overall positioning sequence can be defined as follows for a given top-level visual element.		The overall positioning sequence can be defined as follows for a given top-level visual element.
Line 15:		Line 15:
	#Invoke the Position script for the top-level visual element.		#Invoke the Position script for the top-level visual element.
	#Any child layout of the top-level element that has not yet been rendered is now rendered.		#Any child layout of the top-level element that has not yet been rendered is now rendered.

			Within the Position script, the panel or sheet may need to force a layout to properly calculate its size before another layout can be positioned relative to it. When this occurs, the panel or sheet can explicitly tell the layout to render itself by using the "render" target reference on that layout. Rendering a layout

Rob: /* Recursive Descent Through Hierarchy */

2008-11-20T10:49:31Z

Recursive Descent Through Hierarchy

@@ Line 15: / Line 15: @@
 #Invoke the Position script for the top-level visual element.
 #Any child layout of the top-level element that has not yet been rendered is now rendered.
 ==Rendering Layouts and Templates==