Component: Port Matrix (Misc): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..." |
No edit summary |
||
| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| Line 28: | Line 30: | ||
==Examples== | ==Examples== | ||
Revision as of 14:42, 16 January 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Misc |
Port Matrix component
Create an accurately spaced array of up to eight components, each corresponding to a pin of the chosen port. If the cloned component has a property called 'pin', this will be set the the corresponding pin of the matrix port, and the component will behave as if it were connected directly to that pin. If there are less than eight clones, the unused upper bits of the port will be masked out to allow them to be used by other components.
Component Source Code
Please click here for the component source code: FC_Comp_Source_Port_Matrix.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Industrial Tanks
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
Downloadable macro reference
|
BarGraph |
| Turns on the first N pins of the array - for generating bar graph meters etc. | |
 - BYTE
|
Length |
| How many pins to enable. | |
 - VOID
|
Return |
|
|
AllOn |
| Turn on all of the pins in the array (unused port pins are unaffected) | |
| - VOID
|
Return |
|
|
PinOn |
| Turn on the selected pin of the port. | |
| - BYTE
|
Index |
| Index of the pin to set within the port. | |
| - VOID
|
Return |
|
|
PinOff |
| Turn off the chosen pin of the port. | |
| - BYTE
|
Index |
| Index of the pin to set within the port. | |
| - VOID
|
Return |
|
|
PinToggle |
| Toggles the state of the selected pin of the port. | |
| - BYTE
|
Index |
| - VOID
|
Return |
|
|
GetPin |
| Read the state of the selected pin of the port. Returns false if the index is out of range (0..7) | |
| - BYTE
|
Index |
| Index of the pin to read. | |
 - BOOL
|
Return |
|
|
GetHandle |
| Retrieves the object handle of the indexed clone. Returns zero for out of range indexes. | |
| - BYTE
|
Index |
| Index of the object to get a handle for. | |
 - HANDLE
|
Return |
|
|
AllOff |
| Turn off all used pins of the port (unused port pins are unaffected) | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Simulation |
|
Target Object |
| Choose an object that will be duplicated for each required pin of the chosen port. The object should have a property called 'pin' to which the pins of the port will automatically be attached. | |
|
Count |
| Number of objects in the matrix. They will be assigned pins from the chosen port sequentially, beginning with pin0. | |
|
Alignment |
| Which 3D axis the cloned objects will be arranged along. | |
|
Spacing |
| The distance between cloned objects in the matrix. | |
|
|
Connections |
|
Port |
| Choose a port to connect the matrix of objects to. Each will be assigned a single pin of the port automatically by the Port Matrix component. | |