API Component.GetVisible: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetVisible
Gets whether a component can be seen on the panel
- HANDLE	Target
The component to read the state from
- BOOL	Return

Detailed description

An invisible component may still respond to mouse click events, but can not be seen on any panel during simulation. When not simulating, invisible components are displayed as a grey outline.

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Component.GetVisible(target)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets whether a component can be seen on the panel
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''GetVisible'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Gets whether a component can be seen on the panel&nbsp;
-:[[API Component|GetVisible]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
-==Parameters==
+|-
-[[Variable types|HANDLE]] ''Target''
+| colspan="2" | The component to read the state from&nbsp;
-:The component to read the state from
+|-
-:''The default value for this parameter is: '''''this'''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-[[Variable types|BOOL]]
-Returns true if the operation is a success, else false
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+An invisible component may still respond to mouse click events, but can not be seen on any panel during simulation. When not simulating, invisible components are displayed as a grey outline.
@@ Line 28: / Line 25: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetVisible(target)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation