ctrlSetPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Sets wanted position and size for 2D control animation. Width and height are optional. [[ctrlCommit]] is required to complete the operation. For 3D control, param is relative [x,y,z] and no [[ctrlCommit]] is required as it cannot be animated. |= Description
| Sets wanted position and size for 2D control animation. Width and height are optional. [[ctrlCommit]] is required to complete the operation. For 3D control, param is relative [x,y,z] and no [[ctrlCommit]] is required as it cannot be animated. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| controlName '''ctrlSetPosition''' [x, y] |= Syntax
| controlName '''ctrlSetPosition''' [x, y] |SYNTAX=


|p1=  controlName: [[Control]] - 2D control|= Parameter 1
|p1=  controlName: [[Control]] - 2D control|PARAMETER1=


|p2= [x, y]: [[Array]] |= Parameter 2
|p2= [x, y]: [[Array]] |PARAMETER2=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=




| s2= controlName '''ctrlSetPosition''' [x, y, w, h] |= Syntax
| s2= controlName '''ctrlSetPosition''' [x, y, w, h] |SYNTAX=


|p21=  controlName: [[Control]] - 2D control|= Parameter 1
|p21=  controlName: [[Control]] - 2D control|PARAMETER1=


|p22= [x, y, w, h]: [[Array]] |= Parameter 2
|p22= [x, y, w, h]: [[Array]] |PARAMETER2=


| r2= [[Nothing]] |= Return value
| r2= [[Nothing]] |RETURNVALUE=




| s3= controlName '''ctrlSetPosition''' [x, y, z] |= Syntax
| s3= controlName '''ctrlSetPosition''' [x, y, z] |SYNTAX=


|p41=  controlName: [[Control]] - 3D control|= Parameter 1
|p41=  controlName: [[Control]] - 3D control|PARAMETER1=


|p42= [x, y, z]: [[Array]] - y is distance from the screen |= Parameter 2
|p42= [x, y, z]: [[Array]] - y is distance from the screen |PARAMETER2=


| r3= [[Nothing]] |= Return value
| r3= [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1= Move control: <code>_control2D [[ctrlSetPosition]] [0, 0];
|x1= Move control: <code>_control2D [[ctrlSetPosition]] [0, 0];
_control2D [[ctrlCommit]] 0;</code> |= Example 1
_control2D [[ctrlCommit]] 0;</code> |EXAMPLE1=
   
   
|x2= Move control and resize:<code>_control2D [[ctrlSetPosition]] [0, 0, 1, 1];
|x2= Move control and resize:<code>_control2D [[ctrlSetPosition]] [0, 0, 1, 1];
_control2D [[ctrlCommit]] 0;</code> |= Example 1
_control2D [[ctrlCommit]] 0;</code> |EXAMPLE1=


|x3= <code>_control3D [[ctrlSetPosition]] [0.5, 1, 0.5]; //centered and 1m away from screen</code> |= Example 1
|x3= <code>_control3D [[ctrlSetPosition]] [0.5, 1, 0.5]; //centered and 1m away from screen</code> |EXAMPLE1=


|x4= Typewriter effect: <code>[[with]] [[uiNamespace]] [[do]]
|x4= Typewriter effect: <code>[[with]] [[uiNamespace]] [[do]]
Line 83: Line 83:
[[ctrlDelete]] ctrl;
[[ctrlDelete]] ctrl;
};
};
};</code>|= Example 4
};</code>|EXAMPLE4=
____________________________________________________________________________________________
____________________________________________________________________________________________


|  [[ctrlCommit]], [[ctrlCreate]], [[ctrlDelete]], [[ctrlModel]], [[ctrlSetModel]], [[ctrlPosition]], [[ctrlClassName]], [[displayCtrl]], [[ctrlModelScale]], [[ctrlSetModelScale]], [[ctrlModelDirAndUp]], [[ctrlSetModelDirAndUp]]  |= See also
|  [[ctrlCommit]], [[ctrlCreate]], [[ctrlDelete]], [[ctrlModel]], [[ctrlSetModel]], [[ctrlPosition]], [[ctrlClassName]], [[displayCtrl]], [[ctrlModelScale]], [[ctrlSetModelScale]], [[ctrlModelDirAndUp]], [[ctrlSetModelDirAndUp]]  |SEEALSO=


}}
}}

Revision as of 15:36, 7 April 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Sets wanted position and size for 2D control animation. Width and height are optional. ctrlCommit is required to complete the operation. For 3D control, param is relative [x,y,z] and no ctrlCommit is required as it cannot be animated.
Groups:
Uncategorised

Syntax 1

Syntax:
controlName ctrlSetPosition [x, y]
Parameters:
controlName: Control - 2D control
[x, y]: Array
Return Value:
Nothing

Syntax 2

Syntax:
controlName ctrlSetPosition [x, y, w, h]
Parameters:
controlName: Control - 2D control
[x, y, w, h]: Array
Return Value:
Nothing

Syntax 3

Syntax:
controlName ctrlSetPosition [x, y, z]
Parameters:
controlName: Control - 3D control
[x, y, z]: Array - y is distance from the screen
Return Value:
Nothing

Examples

Example 1:
Move control: _control2D ctrlSetPosition [0, 0]; _control2D ctrlCommit 0;
Example 2:
Move control and resize:_control2D ctrlSetPosition [0, 0, 1, 1]; _control2D ctrlCommit 0;
Example 3:
_control3D ctrlSetPosition [0.5, 1, 0.5]; //centered and 1m away from screen
Example 4:
Typewriter effect: with uiNamespace do { [] spawn { _text1 = "This is a simple demo of typewriter text effect with various speed."; _text2 = "This took 10 seconds."; _text3 = "This is a fast one, set for 2 seconds."; ctrl = findDisplay 46 ctrlCreate ["RscStructuredText", -1]; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text1 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 8; waitUntil {ctrlCommitted ctrl}; sleep 0.5; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text2 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 2; waitUntil {ctrlCommitted ctrl}; sleep 2; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#00ff00' size='2.1'>%1</t>", _text3 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 2; waitUntil {ctrlCommitted ctrl}; sleep 2; ctrlDelete ctrl; }; };

Additional Information

See also:
ctrlCommitctrlCreatectrlDeletectrlModelctrlSetModelctrlPositionctrlClassNamedisplayCtrlctrlModelScalectrlSetModelScalectrlModelDirAndUpctrlSetModelDirAndUp

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

Notes

Posted on January 27, 2007 - 19:13
Giova
IMPORTANT You have to use ctrlCommit command to apply this effect(Arma v1.02.5103GER)

Bottom Section

Posted on May 22, 2017 - 23:04 (UTC)
Lucian
If the target ctrl is part of a ctrlGroup, the position needs to be relative to the ctrlGroup position.
Posted on July 20, 2017 - 11:56 (UTC)
Yuval
If the target control is a controls' group, all the child controls of that group will be moved automatically (as their position is relative to the control group rather than the display)