FieldSequence
Properties
containerClass : str
defaultValue : ReflectionValue (Read-Only)
disableSequencing : bool
expression : Expression
isPatched : bool (Read-Only)
layer : Layer (Read-Only)
name : str
noSequence : bool (Read-Only)
notSequencable : bool (Read-Only)
sequence : KeySequence
type : Type (Read-Only)
typeName : str (Read-Only)
userName : str
Methods
eval(self, t: float, ttl: int) -> float
FieldSequence.eval() will be restricted from plugins in a future Designer release. Please update your plugins to switch to FieldSequence.getSequencedValue().
externallyControlled(self, t: float) -> bool
getSequencedValue(self, t: float) -> SequencedValue
Preferred method to retrieve the sequenced value at the specified time.
If the FieldSequence is expression or sockpuppet-controlled, this does not represent the external control value, only sequencing.
Parameters:
- t The time at which to obtain the sequence value.
Returns The sequence value corresponding to the given time.
notifyEdit(self)
options(self) -> List[str]
setExpression(self, expr: str)
setRange(self, min: float, max: float, gran: float)
setSockpuppetDisabled(self, disable: bool)
Disable or enable this field for sockpuppet control.
Parameters:
- disable: When True, disables the field, when False enables the field.
setSockpuppetIsolated(self, isolate: bool)
Isolate or deisolate this field when the layer is driven by sockpuppet.
When isolated, no other fields in this layer will respond to sockpuppet control.
If a field is both isolated and disabled, isolated takes precedence and the field
will be driven by sockpuppet.
Parameters:
- isolate: When True, isolates the field, when False disables isolate on the layer.
sockpuppetCanOutput(self) -> bool
Returns whether this field can be output by sockpuppet, taking disabled and isolated fields into account.
Returns True if the field can be output, else False.
sockpuppetControlled(self) -> bool
Returns whether this field is controlled by sockpuppet taking disabled and isolated fields into account.
Returns True if the field is controlled, else False.
sockpuppetDisabled(self) -> bool
Returns whether this field can be controlled by sockpuppet.
Note: This does not account for an isolated field, use sockpuppetControlled instead.
Returns True if this field is disabled, else False.
sockpuppetIsolated(self) -> bool
Returns whether this field is isolated.
Returns True if field is isolated, else False.
sockpuppetSuppressedByIsolate(self) -> bool
Returns whether sockpuppet would control this field if not for a different field’s isolate.
True when this field is patched, another field in the layer is currently isolated, and this field is
neither isolated nor locally disabled. UI uses this to distinguish “configured but currently
suppressed” from “actively controlled” or “not configured for sockpuppet”.
Returns True if this field is suppressed by another field’s isolate, else False.