Class Key


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

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__id);
         CPointer<ID> p_id = p.cast(new Class[]{ID.class});
         

        Metadata

        • Field: 'id'
        • Signature: 'ID'
        • Actual Size (32bit/64bit): 128/160
      • __DNA__FIELD__adt

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

        Field Documentation

        Blender Source Code

        Animation data (must be immediately after id for utilities to use it).

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__adt);
         CPointer<CPointer<AnimData>> p_adt = p.cast(new Class[]{CPointer.class, AnimData.class});
         

        Metadata

        • Field: 'adt'
        • Signature: 'AnimData*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__refkey

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

        Field Documentation

        Blender Source Code

        'key->block.first', perhaps later on it could be defined as some other KeyBlock - campbell

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__refkey);
         CPointer<CPointer<KeyBlock>> p_refkey = p.cast(new Class[]{CPointer.class, KeyBlock.class});
         

        Metadata

        • Field: 'refkey'
        • Signature: 'KeyBlock*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__elemstr

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

        Field Documentation

        Blender Source Code

        This is not a regular string, although it is \0 terminated this is an array of (element_array_size, element_type) pairs (each one char) used for calculating shape key-blocks.

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__elemstr);
         CPointer<CArrayFacade<Byte>> p_elemstr = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Size of each element in KeyBlock.getData() , use for allocation and stride.

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__elemsize);
         CPointer<Integer> p_elemsize = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'elemsize'
        • 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:

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__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__block

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

        Field Documentation

        Blender Source Code

        list of KeyBlock 's

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__block);
         CPointer<ListBase> p_block = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

        public static final long[] __DNA__FIELD__ipo
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__ipo);
         CPointer<CPointer<Ipo>> p_ipo = p.cast(new Class[]{CPointer.class, Ipo.class});
         

        Metadata

        • Field: 'ipo'
        • Signature: 'Ipo*'
        • Actual Size (32bit/64bit): 4/8
        Field descriptor (offset) for struct member 'ipo'.

        Field Documentation

        Blender Source Code

        old animation system, deprecated for 2.5

      • __DNA__FIELD__from

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

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__from);
         CPointer<CPointer<ID>> p_from = p.cast(new Class[]{CPointer.class, ID.class});
         

        Metadata

        • Field: 'from'
        • Signature: 'ID*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__totkey

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

        Field Documentation

        Blender Source Code

        (totkey == BLI_listbase_count(&key->block))

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__totkey);
         CPointer<Integer> p_totkey = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'totkey'
        • 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'.

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__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__type

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

        Field Documentation

        Blender Source Code

        absolute or relative shape key

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__type);
         CPointer<Byte> p_type = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'type'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD___pad2

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

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD___pad2);
         CPointer<Byte> p__pad2 = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: '_pad2'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__ctime

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

        Field Documentation

        Blender Source Code

        Only used when (Key->type == KEY_NORMAL), this value is used as a time slider, rather then using the scenes time, this value can be animated to give greater control

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__ctime);
         CPointer<Float> p_ctime = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'ctime'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__uidgen

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

        Field Documentation

        Blender Source Code

        Can never be 0, this is used for detecting old data. current free uid for keyblocks

        Pointer Arithmetics

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

         Key key = ...;
         CPointer<Object> p = key.__dna__addressof(Key.__DNA__FIELD__uidgen);
         CPointer<Integer> p_uidgen = p.cast(new Class[]{Integer.class});
         

        Metadata

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

      • Key

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

        protected Key​(Key that)
    • Method Detail

      • getId

        public ID getId()
                 throws java.io.IOException
        Get method for struct member 'id'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • setId

        public void setId​(ID id)
                   throws java.io.IOException
        Set method for struct member 'id'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • getAdt

        public CPointer<AnimData> getAdt()
                                  throws java.io.IOException
        Get method for struct member 'adt'.

        Field Documentation

        Blender Source Code

        Animation data (must be immediately after id for utilities to use it).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__adt
      • setAdt

        public void setAdt​(CPointer<AnimData> adt)
                    throws java.io.IOException
        Set method for struct member 'adt'.

        Field Documentation

        Blender Source Code

        Animation data (must be immediately after id for utilities to use it).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__adt
      • getRefkey

        public CPointer<KeyBlock> getRefkey()
                                     throws java.io.IOException
        Get method for struct member 'refkey'.

        Field Documentation

        Blender Source Code

        'key->block.first', perhaps later on it could be defined as some other KeyBlock - campbell

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__refkey
      • setRefkey

        public void setRefkey​(CPointer<KeyBlock> refkey)
                       throws java.io.IOException
        Set method for struct member 'refkey'.

        Field Documentation

        Blender Source Code

        'key->block.first', perhaps later on it could be defined as some other KeyBlock - campbell

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__refkey
      • getElemstr

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

        Field Documentation

        Blender Source Code

        This is not a regular string, although it is \0 terminated this is an array of (element_array_size, element_type) pairs (each one char) used for calculating shape key-blocks.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__elemstr
      • setElemstr

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

        Field Documentation

        Blender Source Code

        This is not a regular string, although it is \0 terminated this is an array of (element_array_size, element_type) pairs (each one char) used for calculating shape key-blocks.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__elemstr
      • getElemsize

        public int getElemsize()
                        throws java.io.IOException
        Get method for struct member 'elemsize'.

        Field Documentation

        Blender Source Code

        Size of each element in KeyBlock.getData() , use for allocation and stride.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__elemsize
      • setElemsize

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

        Field Documentation

        Blender Source Code

        Size of each element in KeyBlock.getData() , use for allocation and stride.

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

        public ListBase getBlock()
                          throws java.io.IOException
        Get method for struct member 'block'.

        Field Documentation

        Blender Source Code

        list of KeyBlock 's

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__block
      • setBlock

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

        Field Documentation

        Blender Source Code

        list of KeyBlock 's

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__block
      • getIpo

        public CPointer<Ipo> getIpo()
                             throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'ipo'.

        Field Documentation

        Blender Source Code

        old animation system, deprecated for 2.5

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ipo
      • setIpo

        public void setIpo​(CPointer<Ipo> ipo)
                    throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'ipo'.

        Field Documentation

        Blender Source Code

        old animation system, deprecated for 2.5

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ipo
      • getFrom

        public CPointer<ID> getFrom()
                             throws java.io.IOException
        Get method for struct member 'from'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__from
      • setFrom

        public void setFrom​(CPointer<ID> from)
                     throws java.io.IOException
        Set method for struct member 'from'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__from
      • getTotkey

        public int getTotkey()
                      throws java.io.IOException
        Get method for struct member 'totkey'.

        Field Documentation

        Blender Source Code

        (totkey == BLI_listbase_count(&key->block))

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__totkey
      • setTotkey

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

        Field Documentation

        Blender Source Code

        (totkey == BLI_listbase_count(&key->block))

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

        public short getFlag()
                      throws java.io.IOException
        Get method for struct member 'flag'.
        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'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getType

        public byte getType()
                     throws java.io.IOException
        Get method for struct member 'type'.

        Field Documentation

        Blender Source Code

        absolute or relative shape key

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__type
      • setType

        public void setType​(byte type)
                     throws java.io.IOException
        Set method for struct member 'type'.

        Field Documentation

        Blender Source Code

        absolute or relative shape key

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__type
      • get_pad2

        public byte get_pad2()
                      throws java.io.IOException
        Get method for struct member '_pad2'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad2
      • set_pad2

        public void set_pad2​(byte _pad2)
                      throws java.io.IOException
        Set method for struct member '_pad2'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad2
      • getCtime

        public float getCtime()
                       throws java.io.IOException
        Get method for struct member 'ctime'.

        Field Documentation

        Blender Source Code

        Only used when (Key->type == KEY_NORMAL), this value is used as a time slider, rather then using the scenes time, this value can be animated to give greater control

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ctime
      • setCtime

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

        Field Documentation

        Blender Source Code

        Only used when (Key->type == KEY_NORMAL), this value is used as a time slider, rather then using the scenes time, this value can be animated to give greater control

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ctime
      • getUidgen

        public int getUidgen()
                      throws java.io.IOException
        Get method for struct member 'uidgen'.

        Field Documentation

        Blender Source Code

        Can never be 0, this is used for detecting old data. current free uid for keyblocks

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__uidgen
      • setUidgen

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

        Field Documentation

        Blender Source Code

        Can never be 0, this is used for detecting old data. current free uid for keyblocks

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

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