This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 10:39, 18 April 2007 (edit) Sandman (Talk | contribs) m ← Previous diff		Revision as of 14:31, 7 May 2007 (edit) (undo) Sandman (Talk | contribs) Next diff →
Line 3:		Line 3:
	==Definition==		==Definition==
		+	'''INT''' Start_scroll ( <'''INT''' scrollnumber> , <'''INT''' fileID> , <'''INT''' graphID> , <'''INT''' backgroundgraphID> , <'''INT''' regionnumber> , <'''INT''' lockindicator> )
-	'''INT''' Start_scroll ( <'''INT''' scrollnumber> , <'''INT''' file> , <'''INT''' graphic> , <'''INT''' backgroundgraphic> , <'''INT''' regionnumber> , <'''INT''' locking indicator> )	+	This creates a scroll window in which it will perform a view against a background [[graph]]. That is, by using a graph bigger than the display window, a part of this graphic can be shown and shifted in any direction.
-		+
-	This creates a scroll window in which it will perform a view against a background [[graphic]]. That is, by using a graphic bigger than the display window, a part of this graphic can be shown and shifted in any direction.	+
-		+
	== Parameters ==		== Parameters ==
-
	{|		{|
-	| '''INT''' Number of scroll || - the id for the new scroll window, so it can be referenced to later	+	| '''INT''' scrollnumber || - The ID for the new scroll window, so it can be referenced to later
	|-		|-
-	| '''INT''' File || - the [[fpg]] containing the scroll graphics	+	| '''INT''' fileID || - The [[fileID]] of the [[file]] containing the scroll graphics
	|-		|-
-	| '''INT''' Graphic || - the [[graphic code]] of the main graphic to be scrolled	+	| '''INT''' graphID || - The [[graphID]] of the [[graph]] of the main graphic to be scrolled
	|-		|-
-	| '''INT''' Background graphic || - the [[graphic code]] for the background of the scroll window (deeper than the main graphic)	+	| '''INT''' backgroundgraphID || - The [[graphID]] of the [[graph]] for the background of the scroll window
	|-		|-
-	| '''INT''' Number of region || - the [[region]] in which to put the scroll window	+	| '''INT''' regionnumber || - The [[region]] in which to put the scroll window
-	|-	+
-	| '''INT''' Locking indicator || - A value defining whether each of the two scroll planes is horizontally and vertically cyclical	+
	|-		|-
		+	| '''INT''' lockindicator || - A value defining whether each of the two scroll planes is horizontally/vertically cyclical
	|}		|}
-
	== Returns ==		== Returns ==
-		+	'''INT''' : [[true]]
-	{|	+
-	| '''INT''' - Nothing	+
-	|}	+
	== Notes ==		== Notes ==
-
	The locking indicator can be combinations of the following flags:		The locking indicator can be combinations of the following flags:
	{|		{|
Line 45:		Line 36:
	| 8 || - The background will be displayed vertically cycical		| 8 || - The background will be displayed vertically cycical
	|}		|}
-
	== Using Scrolling ==		== Using Scrolling ==
-		+	For each [[process]] that you want to be part of a [[scroll window]], you must set the [[local variable]] [[ctype]] to value [[C_SCROLL]]. Additionally, you must set the camera property of the [[scroll_(global)|scroll structure]] to the [[processID]] of the process you wish to be followed.
-	For each [[process]] that you want to be part of a [[scroll window]], you must set the [[variable]] [[c_type]] to value 'c_scroll'. Additionally, you must set the camera property of the [[scroll structure]] to the [[identifying code]] of the [[process]] you wish to be followed.	+

---

Revision as of 14:31, 7 May 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Notes 5 Using Scrolling

Definition

INT Start_scroll ( <INT scrollnumber> , <INT fileID> , <INT graphID> , <INT backgroundgraphID> , <INT regionnumber> , <INT lockindicator> )

This creates a scroll window in which it will perform a view against a background graph. That is, by using a graph bigger than the display window, a part of this graphic can be shown and shifted in any direction.

Parameters

INT scrollnumber	- The ID for the new scroll window, so it can be referenced to later
INT fileID	- The fileID of the file containing the scroll graphics
INT graphID	- The graphID of the graph of the main graphic to be scrolled
INT backgroundgraphID	- The graphID of the graph for the background of the scroll window
INT regionnumber	- The region in which to put the scroll window
INT lockindicator	- A value defining whether each of the two scroll planes is horizontally/vertically cyclical

Returns

INT : true

Notes

The locking indicator can be combinations of the following flags:

1	- The foreground will be displayed horizontally cycical
2	- The foreground will be displayed vertically cycical
4	- The background will be displayed horizontally cycical
8	- The background will be displayed vertically cycical

Using Scrolling

For each process that you want to be part of a scroll window, you must set the local variable ctype to value C_SCROLL. Additionally, you must set the camera property of the scroll structure to the processID of the process you wish to be followed.