Class KeyingSet


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

    Class Documentation

    Blender Source Code


    KeyingSet definition (ks)

    A KeyingSet defines a group of properties that should be keyframed together, providing a convenient way for animators to insert keyframes without resorting to Auto-Keyframing.

    A few 'generic' (non-absolute and dependent on templates) KeyingSets are defined 'built-in' to facilitate easy animating for the casual animator without the need to add extra steps to the rigging process.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

        • Field: 'next'
        • Signature: 'KeyingSet*'
        • 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:

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

        Metadata

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

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

        Field Documentation

        Blender Python API

        (read-only) Keying Set Paths to define settings that get keyframed together

        Blender Source Code

        (KS_Path ) paths to keyframe to.

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__paths);
         CPointer<ListBase> p_paths = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        .

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__idname);
         CPointer<CArrayFacade<Byte>> p_idname = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        User-viewable name for KeyingSet .

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__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__description

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

        Field Documentation

        Blender Source Code

        (RNA_DYN_DESCR_MAX) short help text.

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__description);
         CPointer<CArrayFacade<Byte>> p_description = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: 'description'
        • Signature: 'char[240]'
        • Actual Size (32bit/64bit): 240/240
      • __DNA__FIELD__typeinfo

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

        Field Documentation

        Blender Source Code

        .

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__typeinfo);
         CPointer<CArrayFacade<Byte>> p_typeinfo = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Index of the active path.

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__active_path);
         CPointer<Integer> p_active_path = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active_path'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        Settings for KeyingSet .

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__flag);
         CPointer<Short> p_flag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__keyingflag

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

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) settings to supply insertkey() with.

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__keyingflag);
         CPointer<Short> p_keyingflag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'keyingflag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__keyingoverride

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

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default.

        Pointer Arithmetics

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

         KeyingSet keyingset = ...;
         CPointer<Object> p = keyingset.__dna__addressof(KeyingSet.__DNA__FIELD__keyingoverride);
         CPointer<Short> p_keyingoverride = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'keyingoverride'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __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:

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

        Metadata

        • Field: '_pad'
        • Signature: 'char[6]'
        • Actual Size (32bit/64bit): 6/6
    • Constructor Detail

      • KeyingSet

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

        protected KeyingSet​(KeyingSet that)
    • Method Detail

      • setNext

        public void setNext​(CPointer<KeyingSet> next)
                     throws java.io.IOException
        Set method for struct member 'next'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__next
      • setPrev

        public void setPrev​(CPointer<KeyingSet> prev)
                     throws java.io.IOException
        Set method for struct member 'prev'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev
      • getPaths

        public ListBase getPaths()
                          throws java.io.IOException
        Get method for struct member 'paths'.

        Field Documentation

        Blender Python API

        (read-only) Keying Set Paths to define settings that get keyframed together

        Blender Source Code

        (KS_Path ) paths to keyframe to.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__paths
      • setPaths

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

        Field Documentation

        Blender Python API

        (read-only) Keying Set Paths to define settings that get keyframed together

        Blender Source Code

        (KS_Path ) paths to keyframe to.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__paths
      • getIdname

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

        Field Documentation

        Blender Source Code

        .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname
      • setIdname

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

        Field Documentation

        Blender Source Code

        .

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

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

        Field Documentation

        Blender Source Code

        User-viewable name for KeyingSet .

        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

        User-viewable name for KeyingSet .

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

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

        Field Documentation

        Blender Source Code

        (RNA_DYN_DESCR_MAX) short help text.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • setDescription

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

        Field Documentation

        Blender Source Code

        (RNA_DYN_DESCR_MAX) short help text.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • getTypeinfo

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

        Field Documentation

        Blender Source Code

        .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__typeinfo
      • setTypeinfo

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

        Field Documentation

        Blender Source Code

        .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__typeinfo
      • getActive_path

        public int getActive_path()
                           throws java.io.IOException
        Get method for struct member 'active_path'.

        Field Documentation

        Blender Source Code

        Index of the active path.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_path
      • setActive_path

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

        Field Documentation

        Blender Source Code

        Index of the active path.

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

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

        Field Documentation

        Blender Source Code

        Settings for KeyingSet .

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

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

        Field Documentation

        Blender Source Code

        Settings for KeyingSet .

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

        public short getKeyingflag()
                            throws java.io.IOException
        Get method for struct member 'keyingflag'.

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) settings to supply insertkey() with.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keyingflag
      • setKeyingflag

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

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) settings to supply insertkey() with.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keyingflag
      • getKeyingoverride

        public short getKeyingoverride()
                                throws java.io.IOException
        Get method for struct member 'keyingoverride'.

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keyingoverride
      • setKeyingoverride

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

        Field Documentation

        Blender Source Code

        (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keyingoverride
      • 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
      • __io__addressof

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