Difference between revisions of "Component: Beam Breaker (Light)"

Latest revision as of 13:08, 7 February 2023

Automatically sets and resets a pin depending on whether a panel object breaks the 'light beam'. Can also send simulation notification events.

Please click here to download the component source project: FC_Comp_Source_Beam_breaker.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Beam_breaker.fcfx

No detailed description exists yet for this component

No additional examples

	ReadState
Get the current collision state. The 'Polarity' property will affect whether a collision is represented by a high or low state.
- BYTE	Return

	SetTarget
Set the object that you want to test for collision with. If this is not called, or is called with handle = 0, collisions will be tested against every panel object that has 'Solid' status. NB) Specifying an object will save CPU power!!
- HANDLE	Target
The object to test for collision with.
- VOID	Return

	WaitUntilHigh
Pause the program until the detector goes high. 'Polarity' will affect whether high value represents a collision or separation. NB) In simulation, only use this macro if testing for collision with animated or timer driven objects!!
- VOID	Return

	WaitUntilLow
Pause the program until the detector goes low. 'Polarity' will affect whether low value represents a collision or separation. NB) In simulation, only use this macro if testing for collision with animated or timer driven objects!!
- VOID	Return

	Properties
	Connections
	Pin
Chip pin that the beam breaker is connected to,.
	Polarity
Active High = Pin is on when beam is broken, off when beam is intact. Active Low = Pin is off when beam is broken, on when beam is intact.
	Simulation
	Target
Choose a specific object to test for breaking the beam. If none is chosen, will check against any other object with 'Solid' status - note, checking all objects increases the CPU load!!
	Range
Set the distance between the transmitter and receiver
	Show Beam
Shows the 'light beam' on screen - arrow points from transmitter to receiver.
	Timer Interval (ms)
Time in milliseconds between collision scans. Small time = Greater CPU load Large time = More like to miss brief collisions.
	Notification
	Notify
Whether or not to notify the component parent of any changes. Data will be zero or one (the current pin value).

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Beam_breaker.fcfx FC_Comp_Source_Beam_breaker.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Beam_breaker.fcfx FC_Comp_Source_Beam_breaker.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Beam_breaker.fcfx FC_Comp_Source_Beam_breaker.fcfx]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
+==Macro reference==
+===ReadState===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 42: / Line 79: @@
+===SetTarget===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 60: / Line 98: @@
+===WaitUntilHigh===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 73: / Line 112: @@
+===WaitUntilLow===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 84: / Line 124: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}