BIS fnc scaleAndTranslate: Difference between revisions

Latest revision as of 22:40, 4 June 2024

1.78

Hover & click on the images for description

Description

Description:: Translates, scales (with pivot) and fades a picture control over time.
Execution:: call
Groups:: Systems

Syntax

Syntax:

[picture, scaleFactor, pivot, translation, durationOrSpeed, isDuration, fade] call BIS_fnc_scaleAndTranslate

Parameters:

picture: Control - picture that has to be modified

scaleFactor: Number - (Optional, default 1) how much the picture has to be scaled (> 1 makes it bigger, 1 keeps it the same, < 1 makes it smaller)

pivot: String - (Optional, default "center") select the pivot's position (i.e. center of the scaling process); can be one of:

"topLeft"
"topCenter"
"topRight"
"centerLeft"
"center"
"centerRight"
"bottomLeft"
"bottomCenter"
"bottomRight"

translation: Array format [x, y] - (Optional, default [0, 0]) how much the picture has to be moved

durationOrSpeed: Number - (Optional, default 2) either the duration of the animation(default) or the speed of the translation, depending on what the next parameter is set to

isDuration: Boolean - (Optional, default true) if true, durationOrSpeed is considered duration; if false it is considered speed

fade: Number - (Optional, default 0) transparency of the image at the end of the animation (in range 0..1: 0 = visible, 1 = invisible)

Return Value:

Number - duration of the animation; useful for determining how much sleep time is needed between animations

Examples

Example 1:: [_controlFront, 0.8, "topLeft"] call BIS_fnc_scaleAndTranslate; private _t = [_controlFront, 1, "bottomRight", [0.1, 0.1], 0.5, false] call BIS_fnc_scaleAndTranslate; sleep (_t * 2); [_controlFront, 0.8, "topRight", [0.5, 0.3]] call BIS_fnc_scaleAndTranslate;

Additional Information

See also:: ctrlSetPosition ctrlSetFade ctrlCommit

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.78
-|1.78|Game version=
+|gr1= Systems
-<!---|arg= local |Multiplayer Arguments=--->
+|descr= Translates, scales (with pivot) and fades a picture control over time.
-<!---|eff= local |Multiplayer Effects=--->
+|s1= [picture, scaleFactor, pivot, translation, durationOrSpeed, isDuration, fade] call [[BIS_fnc_scaleAndTranslate]]
-| <pre>/*
+|p1= picture: [[Control]] - picture that has to be modified
-	Author: Riccardo Argiolas
-	Description:
+|p2= scaleFactor: [[Number]] - (Optional, default 1) how much the picture has to be scaled (> 1 makes it bigger, 1 keeps it the same, < 1 makes it smaller)
-    	Translates and scales (with pivot) and fades a picture over time.
-	Parameters:
+|p3= pivot: [[String]] - (Optional, default "center") select the pivot's position (i.e. center of the scaling process); can be one of:
-	Select 0 - CONTROL: picture that has to be modified
+{{Columns|3|
-	Select 1 - NUMBER: how much the picture has to be scaled (>1 makes it bigger, 1 keeps it the same, <1 makes it smaller)
+* "topLeft"
-	Select 2 - STRING: select the pivot's position (i.e. center of the scaling process)
+* "topCenter"
-	Select 3 - ARRAY: how much the picture has to be translated/moved in [X,Y] format
+* "topRight"
-	Select 4 - NUMBER: either the duration of the animation(default) or the speed of the translation, depending on what the next parameter is set to.
+* "centerLeft"
-	Select 5 - BOOL: true = duration will be used, false = speed will be used.
+* "center"
-	Select 6 - NUMBER: transparency of the image at the end of the animation (1 = invisible)
+* "centerRight"
+* "bottomLeft"
+* "bottomCenter"
+* "bottomRight"
+}}
-	Returns:
+|p4= translation: [[Array]] format [x, y] - (Optional, default [0, 0]) how much the picture has to be moved
-	NUMBER: Duration of the animation. (Useful for determining how much sleep time is needed between animations)
-	Examples:
+|p5= durationOrSpeed: [[Number]] - (Optional, default 2) either the duration of the animation(default) or the speed of the translation, depending on what the next parameter is set to
-	[_controlFront, 0.8, "topLeft"] call BIS_fnc_scaleAndTranslate;
-	_t = [_controlFront, 1, "bottomRight", [0.1, 0.1], 0.5, false] call BIS_fnc_scaleAndTranslate;
-	sleep (_t * 2);
-	[_controlFront, 0.8, "topRight", [0.5, 0.3]] call BIS_fnc_scaleAndTranslate;
-*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
-|[] call [[BIS_fnc_scaleAndTranslate]]|Syntax=
+|p6= isDuration: [[Boolean]] - (Optional, default [[true]]) if [[true]], ''durationOrSpeed'' is considered duration; if [[false]] it is considered speed
-|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+|p7= fade: [[Number]] - (Optional, default 0) transparency of the image at the end of the animation (in range 0..1: 0 = visible, 1 = invisible)
-|Datatype - description|Return value=
+|r1= [[Number]] - duration of the animation; useful for determining how much sleep time is needed between animations
-|x1= <code></code>|Example 1=
+|x1= <sqf>
+[_controlFront, 0.8, "topLeft"] call BIS_fnc_scaleAndTranslate;
+private _t = [_controlFront, 1, "bottomRight", [0.1, 0.1], 0.5, false] call BIS_fnc_scaleAndTranslate;
+sleep (_t * 2);
+[_controlFront, 0.8, "topRight", [0.5, 0.3]] call BIS_fnc_scaleAndTranslate;
+</sqf>
-|exec= call |Execution=
+|seealso= [[ctrlSetPosition]] [[ctrlSetFade]] [[ctrlCommit]]
-| |See also=
 }}
-[[Category:Function Group: Systems|{{uc:scaleAndTranslate}}]]
-[[Category:Functions|{{uc:scaleAndTranslate}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:scaleAndTranslate}}]]