Difference between revisions of "API Panel.PCloud.UnitScale"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UnitScale'''
 +
|-
 +
| colspan="2" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT[]
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | The X, Y or Z axis to adjust 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Offset
 +
|-
 +
| colspan="2" | The first item in the array to adjust 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | ArrayStep
 +
|-
 +
| colspan="2" | The number of elements from the first to the second 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Elements
 +
|-
 +
| colspan="2" | The number of points to adjust 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | OrigOffset
 +
|-
 +
| colspan="2" | Returns the center of the original object 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | OrigRange
 +
|-
 +
| colspan="2" | Returns the range of the original object 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
<sidebar>API Contents</sidebar>
+
==Detailed description==
−
Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two
 
−
 
 
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Panel|Panel]]
 
−
:[[API Panel.PCloud|PCloud]]
 
−
::[[API Panel.PCloud|UnitScale]]
 
−
</div>
 
−
__TOC__
 
−
 
 
−
==Parameters==
 
−
[[Variable Types|FLOAT[]]] ''Axis''
 
−
:The X, Y or Z axis to adjust
 
  
−
[[Variable Types|ULONG]] ''Offset''
 
−
:The first item in the array to adjust
 
−
:''The default value for this parameter is: '''''0'''
 
−
 
−
[[Variable Types|LONG]] ''ArrayStep''
 
−
:The number of elements from the first to the second
 
−
:''The default value for this parameter is: '''''1'''
 
−
 
−
[[Variable Types|ULONG]] ''Elements''
 
−
:The number of points to adjust
 
−
 
−
[[Variable Types|FLOAT]] ''OrigOffset''
 
−
:Returns the center of the original object
 
−
:''This parameter is returned back to the caller''
 
−
 
−
[[Variable Types|FLOAT]] ''OrigRange''
 
−
:Returns the range of the original object
 
−
:''This parameter is returned back to the caller''
 
−
 
−
 
−
==Return value==
 
−
''This call does not return a value''
 
−
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 47: Line 49:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.PCloud.UnitScale(_arrayaxis, offset, arraystep, elements, return_origoffset, return_origrange)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.PCloud.UnitScale(_arrayaxis, offset, arraystep, elements, return_origoffset, return_origrange)</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png UnitScale
Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two 
Fc9-f32-icon.png - FLOAT[] Axis
The X, Y or Z axis to adjust 
Fc9-u32-icon.png - ULONG Offset
The first item in the array to adjust 
Fc9-s32-icon.png - LONG ArrayStep
The number of elements from the first to the second 
Fc9-u32-icon.png - ULONG Elements
The number of points to adjust 
Fc9-f32-icon.png - FLOAT OrigOffset
Returns the center of the original object 
Fc9-f32-icon.png - FLOAT OrigRange
Returns the range of the original object 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Panel.PCloud.UnitScale(_arrayaxis, offset, arraystep, elements, return_origoffset, return_origrange)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.PCloud.UnitScale&oldid=30186"