API Panel.PCloud.SetPoints: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetPoints
Sets the X,Y,Z point lists
- HANDLE	PCloud
The handle to the cloud to set the points of
- FLOAT[]	XYZ
The array of (X,Y,Z) coordinates to use
- ULONG	Elements
The number of (X,Y,Z) points to set
- NONE	Return

Detailed description

Sets the points in the cloud in a chain layout.

The points specified will form the points on a line - this is typically the format used for graphs and clouds rendered with Mode_Point. XYZ is an array with index 0 representing X, 1 representing Y, 2 representing Z and 3 representing the next X point (and so on). If the X, Y and Z are in different locations use SetPointsEx. The Elements represents the number ofpoints to display.

Examples

Calling in a calculation

Add to a calculation icon:

::Panel.PCloud.SetPoints(pcloud, _arrayxyz, elements)

@@ 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" | '''SetPoints'''
+|-
+| colspan="2" | Sets the X,Y,Z point lists&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | PCloud
+|-
+| colspan="2" | The handle to the cloud to set the points of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT[]
+| width="90%" | XYZ
+|-
+| colspan="2" | The array of (X,Y,Z) coordinates to use&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
+|-
+| colspan="2" | The number of (X,Y,Z) points to set&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==
-Sets the X,Y,Z point lists
+Sets the points in the cloud in a ''chain'' layout.
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.PCloud|PCloud]]
-::[[API Panel.PCloud|SetPoints]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''PCloud''
-:The handle to the cloud to set the points of
-[[Variable Types|FLOAT[]]] ''XYZ''
-:The array of (X,Y,Z) coordinates to use
-[[Variable Types|ULONG]] ''Elements''
-:The number of (X,Y,Z) points to set
-==Return value==
+[[File:SIMAPI Panel.PCloud PointOrder.svg|thumb|none|400px|Ordering of points in a chain and grid]]
-''This call does not return a value''
-==Detailed description==
+The points specified will form the points on a line - this is typically the format used for graphs and clouds rendered with ''Mode_Point''. ''XYZ'' is an array with index 0 representing X, 1 representing Y, 2 representing Z and 3 representing the next X point (and so on). If the X, Y and Z are in different locations use [[API Panel.PCloud.SetPointsEx|SetPointsEx]]. The ''Elements'' represents the number ofpoints to display.
-''<span style="color:red;">No additional information</span>''
@@ Line 34: / Line 39: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.PCloud.SetPoints(pcloud, _arrayxyz, elements)</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