In order to be able to use this module import it like this:
import mpacts.commands.geometry.freedirection #or assign it to a shorter name import mpacts.commands.geometry.freedirection as fre
- Computes the ‘free’ (no contact) direction of a composed particle submerged in other composed particlesDefault location: ‘loop_cmds/post_contact_cmds’
- Required keywords:
dir— Array of vectors in the parent which keeps a ‘free’ direction of (pointing away from contact).
pc— Particle container on which the command is applied
- Optional keywords:
gate(default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
predicate(default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
restrict_to_plane(default value = 0 0 0) — If given, the direction will be restricted to the plane with given normal vector
- object __init__(tuple args, dict kwds) :
- args: name, parent kwds: pc, dir, [gate, predicate, restrict_to_plane]
ComputeFreeDirectionCommand(name, parent, **kwargs)¶