Difference between revisions of "API Panel.Position.GetScale"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Panel|Panel]]
+
====Class hierarchy====
 +
[[API Panel|Panel]]
 
:[[API Panel.Position|Position]]
 
:[[API Panel.Position|Position]]
 
::[[API Panel.Position|GetScale]]
 
::[[API Panel.Position|GetScale]]
Line 10: Line 11:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Handle''
+
[[Variable types|HANDLE]] ''Handle''
 
:The position or component to read
 
:The position or component to read
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
  
''[[Variable types|HANDLE]] Target''
+
[[Variable types|HANDLE]] ''Target''
 
:The position or component to convert relative to
 
:The position or component to convert relative to
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
Line 24: Line 25:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 30: Line 32:
 
* Declare a variable 'result' of type FLOAT[]
 
* Declare a variable 'result' of type FLOAT[]
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetScale(handle, target)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetScale(handle, target)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:08, 11 May 2013

<sidebar>API contents</sidebar> Returns the positions scale in {X,Y,Z} array

Class hierarchy

Panel

Position
GetScale

Parameters

HANDLE Handle

The position or component to read
The default value for this parameter is: this

HANDLE Target

The position or component to convert relative to
The default value for this parameter is: this

Return value

FLOAT[]

Returns the positions scale in {X,Y,Z} array

Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type FLOAT[]
  • Add to a calculation icon:
    result = ::Panel.Position.GetScale(handle, target)

No additional information