boundingBox: Difference between revisions

Latest revision as of 18:11, 15 March 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Returns a bounding box of given object in model coordinate space, adjusted according to destruction/animation of an object. This command is rather generous on the size estimation, for more precise coordinates use boundingBoxReal.
ⓘ
In 1.92 The output of both syntaxes got extended to include bounding sphere diameter. See also sizeOf.
Groups:: Object Manipulation

Syntax

Syntax:: boundingBox object
Parameters:: object: Object
Return Value:: Array - an array with the extreme points of the model in format PositionRelative, as well as bounding box sphere diameter.
Format [[xmin, ymin, zmin], [xmax, ymax, zmax], boundingSphereDiameter].

1.92

Alternative Syntax

Syntax:

clippingType boundingBox object

Parameters:

clippingType: Number - clipping type could be:

0 - ClipVisual (could significantly reduce the size of bounding boxes on buildings)
1 - ClipShadow
2 - ClipGeometry
3 - ClipGeneral (Default, the same type that is used in main syntax)

object: Object

Return Value:

Array - an array with the extreme points of the model bounding box in format PositionRelative, as well as bounding box sphere diameter.
Format [[xmin, ymin, zmin], [xmax, ymax, zmax], boundingSphereDiameter].

Examples

Example 1:: private _box = boundingBox _abrams;
Example 2:: hint str (0 boundingBox cursorObject);

Additional Information

See also:: sizeOf boundingBoxReal boundingCenter BIS_fnc_boundingBoxDimensions

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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= arma1
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2
-____________________________________________________________________________________________
+|version2= 1.00
-|[[Image:Boundingbox.jpg|right|200px]] Returns a bounding box of given object in model coordinate space, adjusted according to destruction/animation of an object. This command is rather generous on the size estimation, for more precise coordinates use [[boundingBoxReal]]. With Arma 3 v1.92 an alternative syntax is added allowing to specify clipping type to be used, which in some cases could make bounding boxes even more precise. The output of both syntaxes was also extended to include bounding sphere diameter. One other command that provides such information is [[sizeOf]], which is quite limited in its application. |DESCRIPTION=
+|game3= arma2oa
-____________________________________________________________________________________________
+|version3= 1.50
-| '''boundingBox''' object |SYNTAX=
+|game4= tkoh
+|version4= 1.00
-|p1=object : [[Object]]  |PARAMETER1=
+|game5= arma3
+|version5= 0.50
-| [[Array]] - An array with the extreme points of the model. Format <nowiki>[[</nowiki>xmin,ymin,zmin],[xmax,ymax,zmax<nowiki>],boundingSphereDiameter]</nowiki>.|RETURNVALUE=
+|gr1= Object Manipulation
-| s2= clippingType '''boundingBox''' object |SYNTAX=
+|descr= [[File:Boundingbox.jpg|right|200px]] Returns a bounding box of given object in model coordinate space, adjusted according to destruction/animation of an object. This command is rather generous on the size estimation, for more precise coordinates use [[boundingBoxReal]].
+{{Feature|informative|In {{GVI|arma3|1.92}} The output of both syntaxes got extended to include bounding sphere diameter. See also [[sizeOf]].}}
-|p21= clippingType: [[Number]] - Clipping type could be:
+|s1= [[boundingBox]] object
-* 0 - ClipVisual (could significantly reduce the size of bounding boxes on buildings)
-* 1 - ClipShadow
-* 2 - ClipGeometry
-* 3 - ClipGeneral (Default, the same type that is used in main syntax)|PARAMETER1=
-|p22= object: [[Object]]  |PARAMETER1=
-| r2 = [[Array]] - An array with the extreme points of the model bounding box as well as bounding box sphere diameter.Format <nowiki>[[</nowiki>xmin,ymin,zmin],[xmax,ymax,zmax<nowiki>],boundingSphereDiameter]</nowiki>.|RETURNVALUE=
+|p1= object: [[Object]]
+|r1= [[Array]] - an array with the extreme points of the model in format [[Position#PositionRelative|PositionRelative]], as well as bounding box sphere diameter.<br>Format [<nowiki/>[xmin, ymin, zmin], [xmax, ymax, zmax], boundingSphereDiameter].
-____________________________________________________________________________________________
+|s2= clippingType [[boundingBox]] object
-|x1= <code>_box = [[boundingBox]] _abrams</code>|EXAMPLE1=
+|s2since= arma3 1.92
-|x2= <code>[[hint]] [[str]] (0 [[boundingBox]] [[cursorObject]]);</code>|EXAMPLE2=
+|p21= clippingType: [[Number]] - clipping type could be:
-____________________________________________________________________________________________
+* 0 - ClipVisual (could significantly reduce the size of bounding boxes on buildings)
+* 1 - ClipShadow
-| [[sizeOf]], [[boundingBoxReal]], [[boundingCenter]]|SEEALSO=
+* 2 - ClipGeometry
+* 3 - ClipGeneral (Default, the same type that is used in main syntax)
-}}
+|p22= object: [[Object]]
-<h3 style="display:none">Notes</h3>
+|r2= [[Array]] - an array with the extreme points of the model bounding box in format [[Position#PositionRelative|PositionRelative]], as well as bounding box sphere diameter.<br>Format [<nowiki/>[xmin, ymin, zmin], [xmax, ymax, zmax], boundingSphereDiameter].
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>private _box = boundingBox _abrams;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x2= <sqf>hint str (0 boundingBox cursorObject);</sqf>
-[[Category:Scripting Commands|BOUNDINGBOX]]
+|seealso= [[sizeOf]] [[boundingBoxReal]] [[boundingCenter]] [[BIS_fnc_boundingBoxDimensions]]
-[[Category:Scripting Commands ArmA|BOUNDINGBOX]]
+}}
-[[Category:Scripting Commands ArmA2|BOUNDINGBOX]]
-[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]