Component: Port Matrix (Misc): Difference between revisions
No edit summary |
Tag: Undo |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 80: | Line 80: | ||
===AllOff=== | ===AllOff=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''AllOff''' | ||
|- | |- | ||
| colspan="2" | Turn off all used pins of the port (unused port pins are unaffected) | | colspan="2" | Turn off all used pins of the port (unused port pins are unaffected) | ||
| Line 94: | Line 94: | ||
===AllOn=== | ===AllOn=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''AllOn''' | ||
|- | |- | ||
| colspan="2" | Turn on all of the pins in the array (unused port pins are unaffected) | | colspan="2" | Turn on all of the pins in the array (unused port pins are unaffected) | ||
| Line 108: | Line 108: | ||
===BarGraph=== | ===BarGraph=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''BarGraph''' | ||
|- | |- | ||
| colspan="2" | Turns on the first N pins of the array - for generating bar graph meters etc. | | colspan="2" | Turns on the first N pins of the array - for generating bar graph meters etc. | ||
| Line 127: | Line 127: | ||
===GetHandle=== | ===GetHandle=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetHandle''' | ||
|- | |- | ||
| colspan="2" | Retrieves the object handle of the indexed clone. Returns zero for out of range indexes. | | colspan="2" | Retrieves the object handle of the indexed clone. Returns zero for out of range indexes. | ||
| Line 146: | Line 146: | ||
===GetPin=== | ===GetPin=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetPin''' | ||
|- | |- | ||
| colspan="2" | Read the state of the selected pin of the port. Returns false if the index is out of range (0..7) | | colspan="2" | Read the state of the selected pin of the port. Returns false if the index is out of range (0..7) | ||
| Line 165: | Line 165: | ||
===PinOff=== | ===PinOff=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PinOff''' | ||
|- | |- | ||
| colspan="2" | Turn off the chosen pin of the port. | | colspan="2" | Turn off the chosen pin of the port. | ||
| Line 184: | Line 184: | ||
===PinOn=== | ===PinOn=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PinOn''' | ||
|- | |- | ||
| colspan="2" | Turn on the selected pin of the port. | | colspan="2" | Turn on the selected pin of the port. | ||
| Line 203: | Line 203: | ||
===PinToggle=== | ===PinToggle=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PinToggle''' | ||
|- | |- | ||
| colspan="2" | Toggles the state of the selected pin of the port. | | colspan="2" | Toggles the state of the selected pin of the port. | ||
| Line 223: | Line 223: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
| Line 253: | Line 253: | ||
| colspan="2" | The distance between cloned objects in the matrix. | | colspan="2" | The distance between cloned objects in the matrix. | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 15:38, 13 July 2026
| 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 to download the component source project: FC_Comp_Source_Port_Matrix.fcfx
Please click here to view the component source code (Beta): 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.
Macro reference
AllOff
|
AllOff |
| Turn off all used pins of the port (unused port pins are unaffected) | |
 - VOID
|
Return |
AllOn
|
|
AllOn |
| Turn on all of the pins in the array (unused port pins are unaffected) | |
| - VOID
|
Return |
BarGraph
|
|
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 |
GetHandle
|
|
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 |
GetPin
|
|
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 |
PinOff
|
|
PinOff |
| Turn off the chosen pin of the port. | |
| - BYTE
|
Index |
| Index of the pin to set within the port. | |
| - VOID
|
Return |
PinOn
|
|
PinOn |
| Turn on the selected pin of the port. | |
| - BYTE
|
Index |
| Index of the pin to set within the port. | |
| - VOID
|
Return |
PinToggle
|
|
PinToggle |
| Toggles the state of the selected pin of the port. | |
| - BYTE
|
Index |
| - 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. | |