diff options
| author | Aaron Franke <arnfranke@yahoo.com> | 2020-07-21 14:07:00 -0400 |
|---|---|---|
| committer | Aaron Franke <arnfranke@yahoo.com> | 2020-07-21 14:44:53 -0400 |
| commit | 83e324d670ca05993403c5d0ad7762aa096a7978 (patch) | |
| tree | e011b47e7cf86301c72668a2e6c3a2e8ec13255d /doc/classes/AABB.xml | |
| parent | 41d6c965907730debb2bd6dcc7ccbe6f1ba5d015 (diff) | |
Update core documentation to match recent C# changes
Also a few minor API changes like adding AABB.abs()
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Diffstat (limited to 'doc/classes/AABB.xml')
| -rw-r--r-- | doc/classes/AABB.xml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 3f2f27d121..ae80abc5d2 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -18,7 +18,14 @@ <argument index="1" name="size" type="Vector3"> </argument> <description> - Optional constructor, accepts position and size. + Constructs an [AABB] from a position and size. + </description> + </method> + <method name="abs"> + <return type="AABB"> + </return> + <description> + Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive. </description> </method> <method name="encloses"> @@ -197,13 +204,14 @@ </methods> <members> <member name="end" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )"> - Ending corner. This is calculated as [code]position + size[/code]. Changing this property changes [member size] accordingly. + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. </member> <member name="position" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )"> - Beginning corner. + Beginning corner. Typically has values lower than [member end]. </member> <member name="size" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )"> - Size from position to end. + Size from [member position] to [member end]. Typically all components are positive. + If the size is negative, you can use [method abs] to fix it. </member> </members> <constants> |