ActionChannelbagFCurves(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.ActionChannelbagFCurves(bpy_prop_collection)

Collection of F-Curves for a specific action slot, on a specific strip

new(data_path, *, index=0, group_name='')

Add an F-Curve to the channelbag

Parameters:

  • data_path (str) – Data Path, F-Curve data path to use (never None)

  • index (int) – Index, Array index (in [0, inf], optional)

  • group_name (str) – Group Name, Name of the Group for this F-Curve, will be created if it does not exist yet (optional, never None)

Returns:

Newly created F-Curve

Return type:

FCurve

new_from_fcurve(source, *, data_path='')

Copy an F-Curve into the channelbag. The original F-Curve is unchanged

Parameters:

  • source (FCurve) – Source F-Curve, The F-Curve to copy

  • data_path (str) – Data Path, F-Curve data path to use. If not provided, this will use the same data path as the given F-Curve (optional, never None)

Returns:

Newly created F-Curve

Return type:

FCurve

ensure(data_path, *, index=0, group_name='')

Returns the F-Curve if it already exists, and creates it if necessary

Parameters:

  • data_path (str) – Data Path, F-Curve data path to use (never None)

  • index (int) – Index, Array index (in [0, inf], optional)

  • group_name (str) – Group Name, Name of the Group for this F-Curve, will be created if it does not exist yet. This parameter is ignored if the F-Curve already exists (optional, never None)

Returns:

Found or newly created F-Curve

Return type:

FCurve

find(data_path, *, index=0)

Find an F-Curve. Note that this function performs a linear scan of all F-Curves in the channelbag.

Parameters:

  • data_path (str) – Data Path, F-Curve data path (never None)

  • index (int) – Index, Array index (in [0, inf], optional)

Returns:

The found F-Curve, or None if it does not exist

Return type:

FCurve

remove(fcurve)

Remove F-Curve

Parameters:

fcurve (FCurve) – F-Curve to remove (never None)

clear()

Remove all F-Curves from this channelbag

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References