Difference between revisions of "API System.ShowHandle"
From Flowcode Help
Jump to navigationJump to search| Line 52: | Line 52: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ShowHandle(handle)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ShowHandle(handle)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
ShowHandle |
| Given a handle to an object with viewable presence, shows that object on screen | |
 - HANDLE
|
Handle |
| The object to display on screen | |
 - BOOL
|
Return |
Detailed description
This tells Flowcode to show whatever object is represented by Handle.
The types of object that are supported are:
| Handle type | Result of this call |
|---|---|
| Component | Moves the camera in its current viewing plane over the components position
If the panel (system or dashboard) the component exists on is not shown, this will open that window |
| Position | Behaves as though a component, and moves the camera to look at that position |
| LinkBar | Behaves as though a component, and moves the camera to look at the center of the link |
| Point cloud | Behaves as though a component, and moves the camera to look at the center of the cloud |
| Console | Opens the console window and selects the appropriate console tab |
| Scope group/stream | Opens the data scope window to show the scope |
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::System.ShowHandle(handle)
