Class bActionGroup


  • public class bActionGroup
    extends CFacade
    Generated facet for DNA struct type 'bActionGroup'.

    Class Documentation

    Blender Source Code


    Action Groups ----------------------------------- Action-Channel Group (agrp)

    These are stored as a list per-Action, and are only used to group that Action's channels in an Animation Editor.

    Even though all FCurves live in a big list per Action, each group they are in also holds references to the achans within that list which belong to it. Care must be taken to ensure that action-groups never end up being the sole 'owner' of a channel.

    This is also exploited for bone-groups. Bone-Groups are stored per bPose , and are used primarily to color bones in the 3d-view. There are other benefits too, but those are mostly related to Action-Groups.

    Note that these two uses each have their own RNA 'ActionGroup' and 'BoneGroup'.

    • Field Detail

      • __DNA__SDNA_INDEX

        public static final int __DNA__SDNA_INDEX
        This is the sdna index of the struct bActionGroup.

        It is required when allocating a new block to store data for bActionGroup.

        See Also:
        StructDNA, BlockTable, Constant Field Values
      • __DNA__FIELD__next

        public static final long[] __DNA__FIELD__next
        Field descriptor (offset) for struct member 'next'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__next);
         CPointer<CPointer<bActionGroup>> p_next = p.cast(new Class[]{CPointer.class, bActionGroup.class});
         

        Metadata

        • Field: 'next'
        • Signature: 'bActionGroup*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__prev

        public static final long[] __DNA__FIELD__prev
        Field descriptor (offset) for struct member 'prev'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__prev);
         CPointer<CPointer<bActionGroup>> p_prev = p.cast(new Class[]{CPointer.class, bActionGroup.class});
         

        Metadata

        • Field: 'prev'
        • Signature: 'bActionGroup*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__channels

        public static final long[] __DNA__FIELD__channels
        Field descriptor (offset) for struct member 'channels'.

        Field Documentation

        Blender Source Code

        Note: this must not be touched by standard listbase functions which would clear links to other channels.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__channels);
         CPointer<ListBase> p_channels = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'channels'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__flag

        public static final long[] __DNA__FIELD__flag
        Field descriptor (offset) for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Settings for this action-group.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__flag);
         CPointer<Integer> p_flag = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__customCol

        public static final long[] __DNA__FIELD__customCol
        Field descriptor (offset) for struct member 'customCol'.

        Field Documentation

        Blender Source Code

        Index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set).

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__customCol);
         CPointer<Integer> p_customCol = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'customCol'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__name

        public static final long[] __DNA__FIELD__name
        Field descriptor (offset) for struct member 'name'.

        Field Documentation

        Blender Source Code

        Name of the group.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__name);
         CPointer<CArrayFacade<Byte>> p_name = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: 'name'
        • Signature: 'char[64]'
        • Actual Size (32bit/64bit): 64/64
      • __DNA__FIELD__cs

        public static final long[] __DNA__FIELD__cs
        Field descriptor (offset) for struct member 'cs'.

        Field Documentation

        Blender Source Code

        Color set to use when customCol == -1.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         bActionGroup bactiongroup = ...;
         CPointer<Object> p = bactiongroup.__dna__addressof(bActionGroup.__DNA__FIELD__cs);
         CPointer<ThemeWireColor> p_cs = p.cast(new Class[]{ThemeWireColor.class});
         

        Metadata

        • Field: 'cs'
        • Signature: 'ThemeWireColor'
        • Actual Size (32bit/64bit): 16/16
    • Constructor Detail

      • bActionGroup

        public bActionGroup​(long __address,
                            Block __block,
                            BlockTable __blockTable)
      • bActionGroup

        protected bActionGroup​(bActionGroup that)
    • Method Detail

      • getChannels

        public ListBase getChannels()
                             throws java.io.IOException
        Get method for struct member 'channels'.

        Field Documentation

        Blender Source Code

        Note: this must not be touched by standard listbase functions which would clear links to other channels.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__channels
      • setChannels

        public void setChannels​(ListBase channels)
                         throws java.io.IOException
        Set method for struct member 'channels'.

        Field Documentation

        Blender Source Code

        Note: this must not be touched by standard listbase functions which would clear links to other channels.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__channels
      • getFlag

        public int getFlag()
                    throws java.io.IOException
        Get method for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Settings for this action-group.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(int flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Settings for this action-group.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getCustomCol

        public int getCustomCol()
                         throws java.io.IOException
        Get method for struct member 'customCol'.

        Field Documentation

        Blender Source Code

        Index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__customCol
      • setCustomCol

        public void setCustomCol​(int customCol)
                          throws java.io.IOException
        Set method for struct member 'customCol'.

        Field Documentation

        Blender Source Code

        Index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__customCol
      • getName

        public CArrayFacade<java.lang.Byte> getName()
                                             throws java.io.IOException
        Get method for struct member 'name'.

        Field Documentation

        Blender Source Code

        Name of the group.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__name
      • setName

        public void setName​(CArrayFacade<java.lang.Byte> name)
                     throws java.io.IOException
        Set method for struct member 'name'.

        Field Documentation

        Blender Source Code

        Name of the group.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__name
      • getCs

        public ThemeWireColor getCs()
                             throws java.io.IOException
        Get method for struct member 'cs'.

        Field Documentation

        Blender Source Code

        Color set to use when customCol == -1.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cs
      • setCs

        public void setCs​(ThemeWireColor cs)
                   throws java.io.IOException
        Set method for struct member 'cs'.

        Field Documentation

        Blender Source Code

        Color set to use when customCol == -1.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cs
      • __io__addressof

        public CPointer<bActionGroup> __io__addressof()
        Instantiates a pointer on this instance.