Blender: blender::animrig::ChannelGroup Class Reference

Blender V4.3

#include <ANIM_action.hh>

Inherits bActionGroup.

Public Member Functions
bool	is_legacy () const
Span< FCurve * >	fcurves ()
Span< const FCurve * >	fcurves () const

Additional Inherited Members
Public Attributes inherited from bActionGroup
struct bActionGroup *	next
struct bActionGroup *	prev
ListBase	channels
int	fcurve_range_start
int	fcurve_range_length
struct ActionChannelBag *	channel_bag
int	flag
int	customCol
char	name [64]
ThemeWireColor	cs

Detailed Description

A group of channels within a ChannelBag.

This does not own the fcurves–the ChannelBag does. This just groups fcurves for organizational purposes, e.g. for use in the channel list in the animation editors.

Usage of this wrapper typically indicates that the group is part of a layered action. However, the underlying bActionGroup struct is also used by legacy actions.

Definition at line 1116 of file ANIM_action.hh.

Member Function Documentation

◆ fcurves() [1/2]

Span< FCurve * > blender::animrig::ChannelGroup::fcurves ( )

Get the fcurves in this channel group.

Definition at line 2157 of file animrig/intern/action.cc.

References BLI_assert, bActionGroup::channel_bag, bActionGroup::fcurve_range_length, bActionGroup::fcurve_range_start, and is_legacy().

Referenced by animsys_evaluate_action_group().

◆ fcurves() [2/2]

Span< const FCurve * > blender::animrig::ChannelGroup::fcurves ( ) const

Definition at line 2169 of file animrig/intern/action.cc.

References BLI_assert, bActionGroup::channel_bag, bActionGroup::fcurve_range_length, bActionGroup::fcurve_range_start, and is_legacy().

◆ is_legacy()

bool blender::animrig::ChannelGroup::is_legacy ( ) const

Determine whether this channel group is from a legacy action or a layered action.

Returns: True if it's from a legacy action, false if it's from a layered action.

Definition at line 2152 of file animrig/intern/action.cc.

References bActionGroup::channel_bag.

Referenced by animsys_evaluate_action_group(), fcurves(), and fcurves().

The documentation for this class was generated from the following files: