db&w documentation wiki

finest software | finest docs

Site Tools


tools:instance_filter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
tools:instance_filter [2020/09/12 19:00] – created lightwolftools:instance_filter [2020/10/03 15:44] (current) – [Refresh / Refresh Current Frame] lightwolf
Line 1: Line 1:
 +
 +====== Instance Filter ======
 +{{:tools:pasted:20201003-154012.png}}
 +
 +The Instance Filter node allows you to select instances in the viewport and filter in a node graph depending on the selection.
 +
 +The passing through of values depending on the selection is similar to the [[tools:bool_switch|]] Node.
 +
 +===== Controls =====
 +
 +==== Instancer ====
 +
 +The node needs to know which Instancer in the scene to work on. This pop-up allows you to select any item with an attached Instancer.
 +
 +==== Selection ====
 +
 +This displays the current selection as a comma separated list of index number, from 0 to the total number of instances - 1((Yeah, that's a computer thing ;) )).
 +
 +You can change this list as well to modify the current selection.
 +
 +==== Invert ====
 +
 +This inverts the output of the node. What is tagged as selected will be tagged as un-selected and vice versa.
 +
 +==== Instance Picker ====
 +
 +{{ :tools:pasted:20200924-143124.png?480}}
 +
 +
 +Enables the ability to pick instances in any viewport. This will draw the instance index at the pivot point of every index. Un-selected indices will be drawn in the item colour, selected indices at a bright yellow.
 +
 +You can use the left mouse button to select individual instances by clicking on the respective index. Use the next control to change that behaviour to a toggle.
 +
 +A right click will remove the index from the selection.
 +
 +
 +==== Left Mouse Button ====
 +
 +This changes the behaviour of the left mouse button to either select an instance or toggle the selection for it.
 +
 +==== Refresh / Refresh Current Frame ====
 +
 +Unfortunately we didn't manage to find a safe way to refresh the viewport in all cases when an instance has been picked by the user. Especially given many cases where the node can be used as well as VPR interfering.
 +
 +That's why these two controls exist.
 +
 +**Refresh** Basically triggers a redraw of the current viewports, which is sufficient in most cases including VPR renders.
 +
 +**Refresh Current Frame** performs a **next frame -> previous frame** jig to refresh motions for the current frame. This needs to be used if the node is used to control Instance weights in the Instancer.
 +
 +
 +
 +
 +===== Node Inputs =====
 +
 +==== Index ====
 +
 +You can use this input to override the current index number to filter against. On most cases this is not necessary.
 +
 +==== new ====
 +
 +If you connect any output from another node to this input, it will create a pair of inputs as well as an output on this node.
 +
 +The name and type of these will be defined by the output that has been connected to the node. The two inputs will have "True" and "False" appended to their names, where "True" is used if the instance is a part of the selection, "False" if it's not. The output connected to the node will be connected to the "True" input.
 +
 +Depending on the current instance being selected, either the "True" or the "False" input will be passed through to the output.
 +
 +You can add multiple inputs/outputs to the node - which may also have different types.
 +
 +To remove any of the input/output pairs, right click on either of them and use the Node Menu.
 +
 +
 +
 +===== Node Outputs =====
 +
 +==== Filter ====
 +
 +The filter output is set to 0 if the current instances is not in the selection or 1 if it us.
 +
 +This can be used in conjunction with the [[tools:bool_logic|]], [[tools:bool_compare|]] or [[tools:bool_switch|]] nodes to create more complex networks.
 +
 +
 +
 +
 +
 +
 ---- ----
 [[https://www.patreon.com/dbw|{{  ::become_a_patron_button.png?nolink|}}]] [[https://www.patreon.com/dbw|{{  ::become_a_patron_button.png?nolink|}}]]
 This plugin is our Plugin of the Month for September 2020, made possible by the finest patrons on [[https://www.patreon.com/dbw|Patreon]]. This plugin is our Plugin of the Month for September 2020, made possible by the finest patrons on [[https://www.patreon.com/dbw|Patreon]].
tools/instance_filter.1599930017.txt.gz · Last modified: 2020/09/12 19:00 by lightwolf