Class AnimData


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

    Class Documentation

    Blender Source Code

    AnimData ---------------------------------- Animation data for some ID block (adt)

    This block of data is used to provide all of the necessary animation data for a data-block. Currently, this data will not be reusable, as there shouldn't be any need to do so.

    This information should be made available for most if not all ID-blocks, which should enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData blocks may override local settings.

    This data-block should be placed immediately after the ID block where it is used, so that the code which retrieves this data can do so in an easier manner. See blenkernel/intern/anim_sys.c for details.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Python API

        Active Action for this data-block

        Blender Source Code

        Active action - acts as the 'tweaking track' for the NLA. Either use BKE_animdata_set_action() to set this, or call BKE_animdata_action_ensure_idroot() after setting.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__action);
         CPointer<CPointer<bAction>> p_action = p.cast(new Class[]{CPointer.class, bAction.class});
         

        Metadata

        • Field: 'action'
        • Signature: 'bAction*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__tmpact

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

        Field Documentation

        Blender Source Code

        temp-storage for the 'real' active action (i.e. the one used before the tweaking-action took over to be edited in the Animation Editors)

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__tmpact);
         CPointer<CPointer<bAction>> p_tmpact = p.cast(new Class[]{CPointer.class, bAction.class});
         

        Metadata

        • Field: 'tmpact'
        • Signature: 'bAction*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__nla_tracks

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

        Field Documentation

        Blender Python API

        (read-only) NLA Tracks (i.e. Animation Layers)

        Blender Source Code

        nla-tracks

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__nla_tracks);
         CPointer<ListBase> p_nla_tracks = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Active NLA-track (only set/used during tweaking, so no need to worry about dangling pointers).

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__act_track);
         CPointer<CPointer<NlaTrack>> p_act_track = p.cast(new Class[]{CPointer.class, NlaTrack.class});
         

        Metadata

        • Field: 'act_track'
        • Signature: 'NlaTrack*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__actstrip

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

        Field Documentation

        Blender Source Code

        Active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers).

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__actstrip);
         CPointer<CPointer<NlaStrip>> p_actstrip = p.cast(new Class[]{CPointer.class, NlaStrip.class});
         

        Metadata

        • Field: 'actstrip'
        • Signature: 'NlaStrip*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__drivers

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

        Field Documentation

        Blender Python API

        (read-only) The Drivers/Expressions for this data-block

        Blender Source Code

        'drivers' for this ID-block's settings - FCurves, but are completely separate from those for animation data Standard user-created Drivers/Expressions (used as part of a rig).

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__drivers);
         CPointer<ListBase> p_drivers = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Temp storage (AnimOverride ) of values for settings that are animated (but the value hasn't been keyframed).

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__overrides);
         CPointer<ListBase> p_overrides = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Runtime data, for depsgraph evaluation.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__driver_array);
         CPointer<CPointer<CPointer<FCurve>>> p_driver_array = p.cast(new Class[]{CPointer.class, CPointer.class, FCurve.class});
         

        Metadata

        • Field: 'driver_array'
        • Signature: 'FCurve**'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        settings for animation evaluation User-defined settings.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__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___pad

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

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD___pad);
         CPointer<CArrayFacade<Byte>> p__pad = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad'
        • Signature: 'char[4]'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__act_blendmode

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

        Field Documentation

        Blender Source Code

        settings for active action evaluation (based on NLA strip settings) Accumulation mode for active action.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__act_blendmode);
         CPointer<Short> p_act_blendmode = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'act_blendmode'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__act_extendmode

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

        Field Documentation

        Blender Source Code

        Extrapolation mode for active action.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__act_extendmode);
         CPointer<Short> p_act_extendmode = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'act_extendmode'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__act_influence

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

        Field Documentation

        Blender Source Code

        Influence for active action.

        Pointer Arithmetics

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

         AnimData animdata = ...;
         CPointer<Object> p = animdata.__dna__addressof(AnimData.__DNA__FIELD__act_influence);
         CPointer<Float> p_act_influence = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'act_influence'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
    • Constructor Detail

      • AnimData

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

        protected AnimData​(AnimData that)
    • Method Detail

      • getAction

        public CPointer<bAction> getAction()
                                    throws java.io.IOException
        Get method for struct member 'action'.

        Field Documentation

        Blender Python API

        Active Action for this data-block

        Blender Source Code

        Active action - acts as the 'tweaking track' for the NLA. Either use BKE_animdata_set_action() to set this, or call BKE_animdata_action_ensure_idroot() after setting.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__action
      • setAction

        public void setAction​(CPointer<bAction> action)
                       throws java.io.IOException
        Set method for struct member 'action'.

        Field Documentation

        Blender Python API

        Active Action for this data-block

        Blender Source Code

        Active action - acts as the 'tweaking track' for the NLA. Either use BKE_animdata_set_action() to set this, or call BKE_animdata_action_ensure_idroot() after setting.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__action
      • getTmpact

        public CPointer<bAction> getTmpact()
                                    throws java.io.IOException
        Get method for struct member 'tmpact'.

        Field Documentation

        Blender Source Code

        temp-storage for the 'real' active action (i.e. the one used before the tweaking-action took over to be edited in the Animation Editors)

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tmpact
      • setTmpact

        public void setTmpact​(CPointer<bAction> tmpact)
                       throws java.io.IOException
        Set method for struct member 'tmpact'.

        Field Documentation

        Blender Source Code

        temp-storage for the 'real' active action (i.e. the one used before the tweaking-action took over to be edited in the Animation Editors)

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tmpact
      • getNla_tracks

        public ListBase getNla_tracks()
                               throws java.io.IOException
        Get method for struct member 'nla_tracks'.

        Field Documentation

        Blender Python API

        (read-only) NLA Tracks (i.e. Animation Layers)

        Blender Source Code

        nla-tracks

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__nla_tracks
      • setNla_tracks

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

        Field Documentation

        Blender Python API

        (read-only) NLA Tracks (i.e. Animation Layers)

        Blender Source Code

        nla-tracks

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__nla_tracks
      • getAct_track

        public CPointer<NlaTrack> getAct_track()
                                        throws java.io.IOException
        Get method for struct member 'act_track'.

        Field Documentation

        Blender Source Code

        Active NLA-track (only set/used during tweaking, so no need to worry about dangling pointers).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_track
      • setAct_track

        public void setAct_track​(CPointer<NlaTrack> act_track)
                          throws java.io.IOException
        Set method for struct member 'act_track'.

        Field Documentation

        Blender Source Code

        Active NLA-track (only set/used during tweaking, so no need to worry about dangling pointers).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_track
      • getActstrip

        public CPointer<NlaStrip> getActstrip()
                                       throws java.io.IOException
        Get method for struct member 'actstrip'.

        Field Documentation

        Blender Source Code

        Active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__actstrip
      • setActstrip

        public void setActstrip​(CPointer<NlaStrip> actstrip)
                         throws java.io.IOException
        Set method for struct member 'actstrip'.

        Field Documentation

        Blender Source Code

        Active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__actstrip
      • getDrivers

        public ListBase getDrivers()
                            throws java.io.IOException
        Get method for struct member 'drivers'.

        Field Documentation

        Blender Python API

        (read-only) The Drivers/Expressions for this data-block

        Blender Source Code

        'drivers' for this ID-block's settings - FCurves, but are completely separate from those for animation data Standard user-created Drivers/Expressions (used as part of a rig).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__drivers
      • setDrivers

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

        Field Documentation

        Blender Python API

        (read-only) The Drivers/Expressions for this data-block

        Blender Source Code

        'drivers' for this ID-block's settings - FCurves, but are completely separate from those for animation data Standard user-created Drivers/Expressions (used as part of a rig).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__drivers
      • getOverrides

        public ListBase getOverrides()
                              throws java.io.IOException
        Get method for struct member 'overrides'.

        Field Documentation

        Blender Source Code

        Temp storage (AnimOverride ) of values for settings that are animated (but the value hasn't been keyframed).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__overrides
      • setOverrides

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

        Field Documentation

        Blender Source Code

        Temp storage (AnimOverride ) of values for settings that are animated (but the value hasn't been keyframed).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__overrides
      • getDriver_array

        public CPointer<CPointer<FCurve>> getDriver_array()
                                                   throws java.io.IOException
        Get method for struct member 'driver_array'.

        Field Documentation

        Blender Source Code

        Runtime data, for depsgraph evaluation.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__driver_array
      • setDriver_array

        public void setDriver_array​(CPointer<CPointer<FCurve>> driver_array)
                             throws java.io.IOException
        Set method for struct member 'driver_array'.

        Field Documentation

        Blender Source Code

        Runtime data, for depsgraph evaluation.

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

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

        Field Documentation

        Blender Source Code

        settings for animation evaluation User-defined settings.

        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 animation evaluation User-defined settings.

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

        public CArrayFacade<java.lang.Byte> get_pad()
                                             throws java.io.IOException
        Get method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • set_pad

        public void set_pad​(CArrayFacade<java.lang.Byte> _pad)
                     throws java.io.IOException
        Set method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • getAct_blendmode

        public short getAct_blendmode()
                               throws java.io.IOException
        Get method for struct member 'act_blendmode'.

        Field Documentation

        Blender Source Code

        settings for active action evaluation (based on NLA strip settings) Accumulation mode for active action.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_blendmode
      • setAct_blendmode

        public void setAct_blendmode​(short act_blendmode)
                              throws java.io.IOException
        Set method for struct member 'act_blendmode'.

        Field Documentation

        Blender Source Code

        settings for active action evaluation (based on NLA strip settings) Accumulation mode for active action.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_blendmode
      • getAct_extendmode

        public short getAct_extendmode()
                                throws java.io.IOException
        Get method for struct member 'act_extendmode'.

        Field Documentation

        Blender Source Code

        Extrapolation mode for active action.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_extendmode
      • setAct_extendmode

        public void setAct_extendmode​(short act_extendmode)
                               throws java.io.IOException
        Set method for struct member 'act_extendmode'.

        Field Documentation

        Blender Source Code

        Extrapolation mode for active action.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_extendmode
      • getAct_influence

        public float getAct_influence()
                               throws java.io.IOException
        Get method for struct member 'act_influence'.

        Field Documentation

        Blender Source Code

        Influence for active action.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__act_influence
      • setAct_influence

        public void setAct_influence​(float act_influence)
                              throws java.io.IOException
        Set method for struct member 'act_influence'.

        Field Documentation

        Blender Source Code

        Influence for active action.

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

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