StringParamBase¶
Inherits AnimatedParam
Inherited by: PathParam, OutputFileParam, FileParam, StringParam
Synopsis¶
This is the base-class for all parameters holding a string. See here for more details.
Functions¶
- def
get
() - def
get
(frame) - def
getDefaultValue
() - def
getValue
() - def
getValueAtTime
(time) - def
restoreDefaultValue
() - def
set
(x) - def
set
(x, frame) - def
setDefaultValue
(value) - def
setValue
(value) - def
setValueAtTime
(value, time)
Detailed Description¶
A string parameter contains internally a string which can change over time. Much like keyframes for value parameters (like IntParam or DoubleParam) keyframes can be set on string params, though the interpolation will remain constant always.
Member functions description¶
-
NatronEngine.StringParamBase.
get
()¶ Return type: str
Get the value of the parameter at the current timeline’s time
-
NatronEngine.StringParamBase.
get
(frame) Parameters: frame – float
Return type: str
Get the value of the parameter at the given frame.
-
NatronEngine.StringParamBase.
getDefaultValue
()¶ Return type: str
Get the default value for this parameter.
-
NatronEngine.StringParamBase.
getValue
()¶ Return type: str
Same as get()
-
NatronEngine.StringParamBase.
getValueAtTime
(time)¶ Parameters: time – float
Return type: str
Same as get(frame)
-
NatronEngine.StringParamBase.
restoreDefaultValue
()¶
Removes all animation and expression set on this parameter and set the value to be the default value.
-
NatronEngine.StringParamBase.
set
(x)¶ Parameters: x – str
Set the value of this parameter to be x. If this parameter is animated (see getIsAnimated(dimension)
then this function will automatically add a keyframe at the timeline’s current time.
-
NatronEngine.StringParamBase.
set
(x, frame) Parameters: - x –
str
- frame –
float
- x –
Set a new keyframe on the parameter with the value x at the given frame.
-
NatronEngine.StringParamBase.
setDefaultValue
(value)¶ Parameters: value – str
Set the default value for this parameter.
-
NatronEngine.StringParamBase.
setValue
(value)¶ Parameters: value – str
Same as set
-
NatronEngine.StringParamBase.
setValueAtTime
(value, time)¶ Parameters: - value –
str
- time –
float
- value –
Same as set(time)<NatronEngine.StringParamBase.set()