ResetHead

from tdw.replicant.actions.reset_head import ResetHead

Reset the head to its neutral rotation.

The head will continuously move over multiple communicate() calls until it is at its neutral rotation.

Fields

duration The duration of the motion in seconds.
scale_duration If True, duration will be multiplied by framerate / 60), ensuring smoother motions at faster-than-life simulation speeds.
status The current status of the action. By default, this is ongoing (the action isn't done).
initialized If True, the action has initialized. If False, the action will try to send get_initialization_commands(resp) on this frame.
done If True, this action is done and won't send any more commands.
duration The duration of the motion in seconds.
scale_duration If True, duration will be multiplied by framerate / 60), ensuring smoother motions at faster-than-life simulation speeds.
status The current status of the action. By default, this is ongoing (the action isn't done).
initialized If True, the action has initialized. If False, the action will try to send get_initialization_commands(resp) on this frame.
done If True, this action is done and won't send any more commands.
status The current status of the action. By default, this is ongoing (the action isn't done).
initialized If True, the action has initialized. If False, the action will try to send get_initialization_commands(resp) on this frame.
done If True, this action is done and won't send any more commands.

ResetHead(duration, scale_duration)

Parameter	Type	Default	Description
duration	float		The duration of the motion in seconds.
scale_duration	bool		If True, `duration` will be multiplied by `framerate / 60)`, ensuring smoother motions at faster-than-life simulation speeds.

self.get_initialization_commands(resp, static, dynamic, image_frequency)

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.
image_frequency	ImageFrequency	An `ImageFrequency` value describing how often image data will be captured.

Returns: A list of commands to initialize this action.

self.get_ongoing_commands(resp, static, dynamic)

Evaluate an action per-frame to determine whether it's done.

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.

Returns: A list of commands to send to the build to continue the action.

self.get_end_commands(resp, static, dynamic, image_frequency)

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.
image_frequency	ImageFrequency	An `ImageFrequency` value describing how often image data will be captured.

Returns: A list of commands that must be sent to end any action.