Difference between revisions of "API Panel.PCloud.SetPos"
From Flowcode Help
Jump to navigationJump to search| (3 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;" | '''SetPos''' | |
| − | + | |- | |
| − | + | | colspan="2" | Sets the position for the point cloud to be located at | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | :: | + | | width="90%" | PCloud |
| − | + | |- | |
| − | + | | colspan="2" | The handle to the cloud to adjust the position of | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | [[ | + | | width="90%" | Pos |
| − | + | |- | |
| − | + | | colspan="2" | The position to display the cloud at | |
| − | [[ | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | |
| − | + | | width="90%" | Track | |
| − | [[ | + | |- |
| − | + | | colspan="2" | Automatically update the cloud to match changes in the position | |
| − | + | |- | |
| − | + | | 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'' |
| − | '' | + | |} |
| Line 40: | Line 40: | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.PCloud.SetPos(pcloud, pos, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.PCloud.SetPos(pcloud, pos, false)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
SetPos |
| Sets the position for the point cloud to be located at | |
 - HANDLE
|
PCloud |
| The handle to the cloud to adjust the position of | |
| - HANDLE
|
Pos |
| The position to display the cloud at | |
 - BOOL
|
Track |
| Automatically update the cloud to match changes in the position | |
 - NONE
|
Return |
Detailed description
This sets the position the point cloud will fill in. That is for any axis the range -1 to 1 in the point cloud will be mapped to the opposite walls of the positions bounding box.
If Track is true, the point clouds position will automatically be updated when the position changes, otherwise the point cloud remains at the specified position even if the owning object moves.
Note that for component positions the point cloud will redraw when the components position is altered, as moving a component invokes a redraw of the screen. However, adjusting dynamic position objects does not redraw the screen, and Update must be called to force a redraw of the point cloud.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.PCloud.SetPos(pcloud, pos, false)
