Kill Box Effector
Updated: 4 Dec 2023
Removes Clones from a cloner system within a specified area.
Kill Box Effector
Method #
This node limits areas that clones can be generated in and removes clones which move into its region from the scene. The killbox area is described using the Falloffs defined in the Falloff section.
Connect the output to the effector input of any cloner node to apply it to the camera system. Multiple effectors connected to the same output will stack, and order of operations chosen by position on the nodegraph.
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
The objects position along the local x-axis.
Position Y
The objects position along the local y-axis.
Position Z
The objects position along the local z-axis.
Rotation Heading
The objects rotation around the local y-axis.
Rotation Pitch
The objects rotation around the local x-axis.
Rotation Bank
The objects rotation around the local z-axis.
Scale X
The objects scale along the local x-axis.
Scale Y
The objects scale along the local y-axis.
Scale Z
The objects 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 Blend Amount
Controls the amount the resulting transforms of each clone after the effector is applied is blended with the original transform.
Space
The transform space in which the Effector is processed.
- Effector - World : use the effector’s transforms in world space.
- Cloner : use the cloner’s transform space.
- Object : Use the transforms in object space to influence the clones.
These properties control where an effector can affect the clones.
Parameter Details Falloff Mode
Change how the falloff from the original object is calculated.
- Infinite : There is no falloff, all objects will be affected equally.
- Linear : Falloff is based on distance from an infinite plane along a chose axis.
- Sphere : Falloff is based on distance from the plain effectors origin.
- Procedural : Uses a connected procedural system to describe the falloff area. A procedural node must be input for this property to function.
- Box : Falloff is based on the distance around a box based at the effectors origin.
Linear Falloff Axis
The falloff axis to use when the effector is in linear mode.
- +X : The positive x axis.
- -X : The negative x axis.
- +Y : The positive y axis
- -Y : The negative y axis.
- +Z : The positive z axis.
- -Z : The negative z axis.
Falloff
The outer radius of the falloff, where the effector no longer effects the clones.
Inner Falloff
The inner radius of the falloff, where the effector effects the clones strongest.
Falloff Power
Change how quickly the nodes falloff from the effector
Falloff Size
The X size of the falloff when in box mode.
Invert Falloff
Invert the direction of the falloff.
These properties control the selection of clones that you want the effector to influence.
Parameter Details Selection Mode
Set the mode for Index-Based Weighting.
- Disabled : Effector influences all clones.
- ID : Use clone IDs to define which clones the effector influences.
- Index : Use clone indexes to define which clones the effector influences.
Selection Operation
Set how you want top define the selection.
- Index : Select a specific clone that will be influenced by the effector.
- Range : Select a range of clones that will be influenced by the effector.
- Step : Select every n clone to be influenced by the effector.
- Random In Range : Clones will be selected randomly to be influenced within a set range.
Index
The first clone index in the range.
Max Index
The last clone index in the range.
Index Step
The increment used in “Step” mode.
Index Seed
The seed used in “Random In Range” mode.
Index Falloff Range
Falloff amount for Index-Based Weighting.
Index Falloff Power
The curve power of the falloff for Index-Based Weighting.
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 | The objects position along the local x-axis. |
| Position Y | The objects position along the local y-axis. |
| Position Z | The objects position along the local z-axis. |
| Rotation Heading | The objects rotation around the local y-axis. |
| Rotation Pitch | The objects rotation around the local x-axis. |
| Rotation Bank | The objects rotation around the local z-axis. |
| Scale X | The objects scale along the local x-axis. |
| Scale Y | The objects scale along the local y-axis. |
| Scale Z | The objects 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 |
|---|---|
| Blend Amount | Controls the amount the resulting transforms of each clone after the effector is applied is blended with the original transform. |
| Space |
The transform space in which the Effector is processed.
|
These properties control where an effector can affect the clones.
| Parameter | Details |
|---|---|
| Falloff Mode |
Change how the falloff from the original object is calculated.
|
| Linear Falloff Axis |
The falloff axis to use when the effector is in linear mode.
|
| Falloff | The outer radius of the falloff, where the effector no longer effects the clones. |
| Inner Falloff | The inner radius of the falloff, where the effector effects the clones strongest. |
| Falloff Power | Change how quickly the nodes falloff from the effector |
| Falloff Size | The X size of the falloff when in box mode. |
| Invert Falloff | Invert the direction of the falloff. |
These properties control the selection of clones that you want the effector to influence.
| Parameter | Details |
|---|---|
| Selection Mode |
Set the mode for Index-Based Weighting.
|
| Selection Operation |
Set how you want top define the selection.
|
| Index | The first clone index in the range. |
| Max Index | The last clone index in the range. |
| Index Step | The increment used in “Step” mode. |
| Index Seed | The seed used in “Random In Range” mode. |
| Index Falloff Range | Falloff amount for Index-Based Weighting. |
| Index Falloff Power | The curve power of the falloff for Index-Based Weighting. |
| Name | Description | Typical Input |
|---|---|---|
| Procedural Falloff | Use a procedural system to generate falloff from. Useful for creating complex and unconventional falloffs from an Effector. | Procedural Root |
| 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 |
