Difference between revisions of "API Panel.Position.ScaleDown"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Divides the objects scale by a value | Divides the objects scale by a value | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|ScaleDown]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The position or component to update | :The position or component to update | ||
| − | + | [[Variable Types|FLOAT]] ''X'' | |
:The local X scale to divide by | :The local X scale to divide by | ||
| − | + | [[Variable Types|FLOAT]] ''Y'' | |
:The local Y scale to divide by | :The local Y scale to divide by | ||
| − | + | [[Variable Types|FLOAT]] ''Z'' | |
:The local Z scale to divide by | :The local Z scale to divide by | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This divides the scale of the ''Handle'' object by an absolute value. Note the difference between [[Object Scale|scale and size]]. An objects scale is only equal to its size if it has no child objects to define its boundary. | |
| − | * Add to a calculation icon: ::Panel.Position.ScaleDown(handle, x, y, z) | + | |
| + | |||
| + | If any of ''X'', ''Y'' or ''Z'' is zero, that parameter is ignored. | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleDown(handle, x, y, z)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Divides the objects scale by a value
Contents
Parameters
HANDLE Handle
- The position or component to update
FLOAT X
- The local X scale to divide by
FLOAT Y
- The local Y scale to divide by
FLOAT Z
- The local Z scale to divide by
Return value
This call does not return a value
Detailed description
This divides the scale of the Handle object by an absolute value. Note the difference between scale and size. An objects scale is only equal to its size if it has no child objects to define its boundary.
If any of X, Y or Z is zero, that parameter is ignored.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.ScaleDown(handle, x, y, z)
No additional examples
