Mouse Point Array
Method #
This node takes the position and state of the mouse cursor and converts it into an array. When the left mouse button is pressed a new point is created at the cursor location; that point will be moved to follow the cursor until the button is released. As such, if easing is used, it is possible to have multiple points visible at once.
The cursor’s viewport position is mapped to the node’s bounding rectangle, as defined by the Bounds properties, in 3D space: if the cursor is in the top left of the viewport it will map to the top left of the bounding rectangle, and so on. If the goal is to have points appear in screen space exactly where the mouse cursor is located, the node’s bounding rectangle should be mapped to fill the screen for the appropriate camera view.
Transform manipulators are disabled for this node as they conflict with using the mouse in the viewport to generate points.
Whilst in Builder, the Mouse Point Array node must be selected in the nodegraph for mouse points to be recognised.
This node will not function in a media server, as the media server captures all mouse inputs.
See the Array Sources node to see how this node is used in the nodegraph to multi-instance child nodes.
The output transform array may be used directly with a Clone To Transform Array, or to clone other nodes within a Field System or Particle System.
Parameters
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
Parameter Details Position X Move along the local x-axis.
Position Y Move along the local y-axis.
Position Z Move along the local z-axis.
Rotation Heading Rotate around the local y-axis.
Rotation Pitch Rotate around the local x-axis.
Rotation Bank Rotate around the local z-axis.
Scale X Scale along the local x-axis.
Scale Y Scale along the local y-axis.
Scale Z Scale along the local z-axis.
Control the inheritance of the transforms from the parent.
Parameter Details Position Toggle inheritance of the Position from the parent.
Rotation Toggle inheritance of the Rotation from the parent.
Scale Toggle inheritance of the Scale from the parent.
World Position Only Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties.
Inherit Time Toggle inheritance of time from the parent.
These properties control the core behaviours of the node.
Parameter Details Axis Select which axis the touch array should appear along
Flip X Axis Flip the X axis of the incoming Windows Touch data.
Flip Y Axis Flip the Y axis of the incoming Windows Touch data.
Apply Node Transforms To Array Elements Only When Enabled, transform changes applied to this nodes transform properties will also be applied to the array elements, and carried onto any nodes this data is used.
These properties control how an element is eased into an array.
Parameter Details Ease Points On Enable Point Easing in, so new points don’t immediately appear.
Ease Points On Mode Edit the easing curve for how the new points will appear.
- Linear,
- Pow2,
- Pow4,
Ease Points On Duration How long the points should take to fully appear.
Ease Points Off Enable Point Easing out, so removed points don’t immediately disappear.
Ease Points Off Mode Edit the easing curve for how the removed points will disappear.
- Linear,
- Pow2,
- Pow4,
Ease Points Off Duration How long the points should take to fully disappear.
Easing Points Affects Point Scales Allow the points to scale in size while easing.
Easing Points Affects Point Opacities Allow the points to fade the opacity of objects while easing.
Set the bounding dimensions of the incoming data, and the area within which points will be generated.
Inputs
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
| Parameter | Details |
|---|---|
| Position X | Move along the local x-axis. |
| Position Y | Move along the local y-axis. |
| Position Z | Move along the local z-axis. |
| Rotation Heading | Rotate around the local y-axis. |
| Rotation Pitch | Rotate around the local x-axis. |
| Rotation Bank | Rotate around the local z-axis. |
| Scale X | Scale along the local x-axis. |
| Scale Y | Scale along the local y-axis. |
| Scale Z | Scale along the local z-axis. |
Control the inheritance of the transforms from the parent.
| Parameter | Details |
|---|---|
| Position | Toggle inheritance of the Position from the parent. |
| Rotation | Toggle inheritance of the Rotation from the parent. |
| Scale | Toggle inheritance of the Scale from the parent. |
| World Position Only | Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties. |
| Inherit Time | Toggle inheritance of time from the parent. |
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| Axis | Select which axis the touch array should appear along |
| Flip X Axis | Flip the X axis of the incoming Windows Touch data. |
| Flip Y Axis | Flip the Y axis of the incoming Windows Touch data. |
| Apply Node Transforms To Array Elements Only | When Enabled, transform changes applied to this nodes transform properties will also be applied to the array elements, and carried onto any nodes this data is used. |
These properties control how an element is eased into an array.
| Parameter | Details |
|---|---|
| Ease Points On | Enable Point Easing in, so new points don’t immediately appear. |
| Ease Points On Mode | Edit the easing curve for how the new points will appear.
|
| Ease Points On Duration | How long the points should take to fully appear. |
| Ease Points Off | Enable Point Easing out, so removed points don’t immediately disappear. |
| Ease Points Off Mode | Edit the easing curve for how the removed points will disappear.
|
| Ease Points Off Duration | How long the points should take to fully disappear. |
| Easing Points Affects Point Scales | Allow the points to scale in size while easing. |
| Easing Points Affects Point Opacities | Allow the points to fade the opacity of objects while easing. |
Set the bounding dimensions of the incoming data, and the area within which points will be generated.
| Name | Description | Typical Input |
|---|---|---|
| 2D Bounds Source | Sets the 2D area the point will appear within. | Region Camera |
| Transform Modifiers | Apply the transforms of another node to this node. | Null |
| Target Node | Modifiy the rotations of the node to always direct the z axis towards the input. | Null |
| Local Transform Override | Apply the transforms of another node to this node, relative to its parent. | Null |