Difference between revisions of "API Panel.Position.ScaleTo"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
Sets the objects scale to a value | Sets the objects scale to a value | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|ScaleTo]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The position or component to update | :The position or component to update | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| − | + | [[Variable Types|FLOAT]] ''X'' | |
:The local X scale to set to | :The local X scale to set to | ||
| − | + | [[Variable Types|FLOAT]] ''Y'' | |
:The local Y scale to set to | :The local Y scale to set to | ||
| − | + | [[Variable Types|FLOAT]] ''Z'' | |
:The local Z scale to set to | :The local Z scale to set to | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This sets the scale of the ''Handle'' object to 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.ScaleTo(handle, x, y, z) | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleTo(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> Sets the objects scale to a value
Contents
Parameters
HANDLE Handle
- The position or component to update
- The default value for this parameter is: this
FLOAT X
- The local X scale to set to
FLOAT Y
- The local Y scale to set to
FLOAT Z
- The local Z scale to set to
Return value
This call does not return a value
Detailed description
This sets the scale of the Handle object to 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.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.ScaleTo(handle, x, y, z)
No additional examples
