Difference between revisions of "API System.ShowHandle"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
(XML import) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | |||
| − | <sidebar>API | ||
Given a handle to an object with viewable presence, shows that object on screen | Given a handle to an object with viewable presence, shows that object on screen | ||
| Line 23: | Line 21: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | This tells Flowcode to show whatever object is represented by ''Handle''. |
| + | |||
| + | |||
| + | The types of object that are supported are: | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | !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 | ||
| + | |} | ||
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Given a handle to an object with viewable presence, shows that object on screen
Contents
Parameters
HANDLE Handle
- The object to display on screen
Return value
Returns true if the operation is a success, else false
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)
No additional examples
