FCurve(bpy_struct)¶
base class — bpy_struct
-
class
bpy.types.
FCurve
(bpy_struct)¶ F-Curve defining values of a period of time
-
array_index
¶ Index to the specific property affected by F-Curve if applicable
- Type
int in [-inf, inf], default 0
-
auto_smoothing
¶ Algorithm used to compute automatic handles
NONE
None, Automatic handles only take immediately adjacent keys into account.CONT_ACCEL
Continuous Acceleration, Automatic handles are adjusted to avoid jumps in acceleration, resulting in smoother curves. However, key changes may affect interpolation over a larger stretch of the curve.
- Type
enum in [‘NONE’, ‘CONT_ACCEL’], default ‘NONE’
-
color
¶ Color of the F-Curve in the Graph Editor
- Type
float array of 3 items in [0, 1], default (0.0, 0.0, 0.0)
-
color_mode
¶ Method used to determine color of F-Curve in Graph Editor
AUTO_RAINBOW
Auto Rainbow, Cycle through the rainbow, trying to give each curve a unique color.AUTO_RGB
Auto XYZ to RGB, Use axis colors for transform and color properties, and auto-rainbow for the rest.AUTO_YRGB
Auto WXYZ to YRGB, Use axis colors for XYZ parts of transform, and yellow for the ‘W’ channel.CUSTOM
User Defined, Use custom hand-picked color for F-Curve.
- Type
enum in [‘AUTO_RAINBOW’, ‘AUTO_RGB’, ‘AUTO_YRGB’, ‘CUSTOM’], default ‘AUTO_RAINBOW’
-
data_path
¶ RNA Path to property affected by F-Curve
- Type
string, default “”, (never None)
-
extrapolation
¶ Method used for evaluating value of F-Curve outside first and last keyframes
CONSTANT
Constant, Hold values of endpoint keyframes.LINEAR
Linear, Use slope of curve leading in/out of endpoint keyframes.
- Type
enum in [‘CONSTANT’, ‘LINEAR’], default ‘CONSTANT’
-
group
¶ Action Group that this F-Curve belongs to
- Type
-
hide
¶ F-Curve and its keyframes are hidden in the Graph Editor graphs
- Type
boolean, default False
-
is_empty
¶ True if the curve contributes no animation due to lack of keyframes or useful modifiers, and should be deleted
- Type
boolean, default False, (readonly)
-
is_valid
¶ False when F-Curve could not be evaluated in past, so should be skipped when evaluating
- Type
boolean, default False
-
keyframe_points
¶ User-editable keyframes
- Type
FCurveKeyframePoints
bpy_prop_collection
ofKeyframe
, (readonly)
-
lock
¶ F-Curve’s settings cannot be edited
- Type
boolean, default False
-
modifiers
¶ Modifiers affecting the shape of the F-Curve
- Type
FCurveModifiers
bpy_prop_collection
ofFModifier
, (readonly)
-
mute
¶ Disable F-Curve Modifier evaluation
- Type
boolean, default False
-
sampled_points
¶ Sampled animation data
- Type
bpy_prop_collection
ofFCurveSample
, (readonly)
-
select
¶ F-Curve is selected for editing
- Type
boolean, default False
-
evaluate
(frame)¶ Evaluate F-Curve
- Parameters
frame (float in [-inf, inf]) – Frame, Evaluate F-Curve at given frame
- Returns
Value, Value of F-Curve specific frame
- Return type
float in [-inf, inf]
-
update
()¶ Ensure keyframes are sorted in chronological order and handles are set correctly
-
range
()¶ Get the time extents for F-Curve
- Returns
Range, Min/Max values
- Return type
float array of 2 items in [-inf, inf]
-
update_autoflags
(data)¶ Update FCurve flags set automatically from affected property (currently, integer/discrete flags set when the property is not a float)
- Parameters
data (
AnyType
, (never None)) – Data, Data containing the property controlled by given FCurve
-
convert_to_samples
(start, end)¶ Convert current FCurve from keyframes to sample points, if necessary
- Parameters
start (int in [-1048574, 1048574]) – Start Frame
end (int in [-1048574, 1048574]) – End Frame
-
convert_to_keyframes
(start, end)¶ Convert current FCurve from sample points to keyframes (linear interpolation), if necessary
- Parameters
start (int in [-1048574, 1048574]) – Start Frame
end (int in [-1048574, 1048574]) – End Frame
-
classmethod
bl_rna_get_subclass
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The RNA type or default when not found.
- Return type
bpy.types.Struct
subclass
-
classmethod
bl_rna_get_subclass_py
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The class or default when not found.
- Return type
type
-
Inherited Properties
Inherited Functions
References