unreal.RigUnit_TimeLoop

class unreal.RigUnit_TimeLoop(speed: float = 0.0, duration: float = 0.0, normalize: bool = False, absolute: float = 0.0, relative: float = 0.0, flip_flop: float = 0.0, even: bool = False)

Bases: RigUnit_SimBase

Simulates a time value - and outputs loop information

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_Timeline.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute (float): [Read-Write] Absolute: the overall time in seconds

  • duration (float): [Read-Write] Duration: the duration of a single loop in seconds

  • even (bool): [Read-Write] Even: true if the iteration of the loop is even

  • flip_flop (float): [Read-Write] Flip Flop: the relative time in seconds (within the loop), going from 0 to duration and then back from duration to 0, or 0 to 1 and 1 to 0 if Normalize is turned on

  • normalize (bool): [Read-Write] Normalize: if set to true the output relative and flipflop will be normalized over the duration.

  • relative (float): [Read-Write] Relative: the relative time in seconds (within the loop)

  • speed (float): [Read-Write] Speed

property absolute: float

[Read-Only] Absolute: the overall time in seconds

Type:

(float)

property duration: float

[Read-Write] Duration: the duration of a single loop in seconds

Type:

(float)

property even: bool

[Read-Only] Even: true if the iteration of the loop is even

Type:

(bool)

property flip_flop: float

[Read-Only] Flip Flop: the relative time in seconds (within the loop), going from 0 to duration and then back from duration to 0, or 0 to 1 and 1 to 0 if Normalize is turned on

Type:

(float)

property normalize: bool

[Read-Write] Normalize: if set to true the output relative and flipflop will be normalized over the duration.

Type:

(bool)

property relative: float

[Read-Only] Relative: the relative time in seconds (within the loop)

Type:

(float)

property speed: float

[Read-Write] Speed

Type:

(float)