| Value | Meaning |
|---|---|
| yesIsOpaqueMask(0) | The point is in bounds of this node. |
| noIsOpaqueMask(1) | The point is *not* in bounds of this node. |
| onlySelfIsOpaqueMask(2) | The point is in bounds, but not in the bounds of any of the children nodes. |
| notInBranchIsOpaqueMask(3) | Indicates that the point is *not* in bounds of any of the nodes in the branch; neither of self, nor any of the children nodes. |
InBounds is used as a return value of Node.inBounds. For most use-cases, InBounds.yes and InBounds.no are the most appropriate, specifying that the point in question is, or is not, in the node's bounds. This defines the way nodes interact with mouse, touchscreen or other hover events (fluid.io.hover).
The node is not normally responsible for the bounds of its children. The node's should only specify its own bounds, so neither a yes or no answer prevent children nodes from overriding the answer.
Despite the above, it is sometimes desirable to keep children from occupying space, for example to hijack and control mouse input. To specify that children nodes *cannot* be in bounds, use InBounds.notInBranch (to indicate none of the nodes include the point) or InBounds.onlySelf (the node captures all events, including of its children).