API Panel.PCloud.UnitScale: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	UnitScale
Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two
- FLOAT[]	Axis
The X, Y or Z axis to adjust
- ULONG	Offset
The first item in the array to adjust
- LONG	ArrayStep
The number of elements from the first to the second
- ULONG	Elements
The number of points to adjust
- FLOAT	OrigOffset
Returns the center of the original object
- FLOAT	OrigRange
Returns the range of the original object
- 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)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''UnitScale'''
+|-
+| colspan="2" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT[]
+| width="90%" | Axis
+|-
+| colspan="2" | The X, Y or Z axis to adjust&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Offset
+|-
+| colspan="2" | The first item in the array to adjust&nbsp;
+|-
+| 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
+|-
+| colspan="2" | The number of points to adjust&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | OrigOffset
+|-
+| colspan="2" | Returns the center of the original object&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | OrigRange
+|-
+| colspan="2" | Returns the range of the original object&nbsp;
+|-
+| 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===
 * 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>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation