Difference between revisions of "Component: Collision Detector Template (Sensors)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray...") |
|||
| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| Line 96: | Line 100: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:# | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" style="background-color:# | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections |
|- | |- | ||
|- | |- | ||
| Line 110: | Line 114: | ||
| colspan="2" | Active High = Pin is high when objects collide, low when they are separate. Active Low = Pin is low when objects collide, high when they are separate. | | colspan="2" | Active High = Pin is high when objects collide, low when they are separate. Active Low = Pin is low when objects collide, high when they are separate. | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:# | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" style="background-color:# | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation |
|- | |- | ||
|- | |- | ||
Latest revision as of 17:19, 9 November 2022
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | Sensors |
Contents
Collision Detector Template component
Polls a chosen panel object to see if it has collided with another object. When collisions happen, a user notification event is generated and a pin is set or reset. Another event is sent when the two objects separate.
Component Pack
SENSORS
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
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 |
Property reference
|
Properties |
|
Connections |
|
Pin |
| The pin that should change state when objects collide or separate. | |
|
Polarity |
| Active High = Pin is high when objects collide, low when they are separate. Active Low = Pin is low when objects collide, high when they are separate. | |
|
|
Simulation |
|
Test Object |
| The object to test for collisions. A user event is sent each time this object collides with any other, or when the two object separate. | |
|
|
Mouse Object |
| Choose an object that the user can clock on to simulate a collision when testing. | |
|
Detector Ident |
| An ID value to identify this particular detector. Will be sent as the 'Ident' value for the notification events sent out so that multiple detectors can be told apart. | |
|
|
Timer Interval (ms) |
| Time in milliseconds between collision scans. Small time = Greater CPU load Large time = More like to miss brief collisions. | |
