Class KS_Path


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

    Class Documentation

    Blender Source Code


    KeyingSet Datatypes Path for use in KeyingSet definitions (ksp)

    Paths may be either specific (specifying the exact sub-ID dynamic data-block - such as PoseChannels - to act upon, ala Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may be generic (using various placeholder template tags that will be replaced with appropriate information from the context).

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        ID block that keyframes are for.

        Pointer Arithmetics

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        .

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__DNA__FIELD__group);
         CPointer<CArrayFacade<Byte>> p_group = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        -type that path can be used on.

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__DNA__FIELD__idtype);
         CPointer<Integer> p_idtype = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'idtype'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__groupmode

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

        Field Documentation

        Blender Source Code

        Group naming (eKSP_Grouping).

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__DNA__FIELD__groupmode);
         CPointer<Short> p_groupmode = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'groupmode'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        Various settings, etc.

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__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__rna_path

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

        Field Documentation

        Blender Source Code

        Dynamically (or statically in the case of predefined sets) path.

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__DNA__FIELD__rna_path);
         CPointer<CPointer<Byte>> p_rna_path = p.cast(new Class[]{CPointer.class, Byte.class});
         

        Metadata

        • Field: 'rna_path'
        • Signature: 'char*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__array_index

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

        Field Documentation

        Blender Source Code

        Index that path affects.

        Pointer Arithmetics

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

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__DNA__FIELD__array_index);
         CPointer<Integer> p_array_index = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'array_index'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __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:

         KS_Path ks_path = ...;
         CPointer<Object> p = ks_path.__dna__addressof(KS_Path.__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:

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

        Metadata

        • Field: 'keyingoverride'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
    • Constructor Detail

      • KS_Path

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

        protected KS_Path​(KS_Path that)
    • Method Detail

      • getNext

        public CPointer<KS_Path> getNext()
                                  throws java.io.IOException
        Get method for struct member 'next'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__next
      • setNext

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

        public CPointer<KS_Path> getPrev()
                                  throws java.io.IOException
        Get method for struct member 'prev'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev
      • setPrev

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

        public CPointer<ID> getId()
                           throws java.io.IOException
        Get method for struct member 'id'.

        Field Documentation

        Blender Source Code

        ID block that keyframes are for.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • setId

        public void setId​(CPointer<ID> id)
                   throws java.io.IOException
        Set method for struct member 'id'.

        Field Documentation

        Blender Source Code

        ID block that keyframes are for.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • getGroup

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

        Field Documentation

        Blender Source Code

        .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__group
      • setGroup

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

        Field Documentation

        Blender Source Code

        .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__group
      • getIdtype

        public int getIdtype()
                      throws java.io.IOException
        Get method for struct member 'idtype'.

        Field Documentation

        Blender Source Code

        -type that path can be used on.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idtype
      • setIdtype

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

        Field Documentation

        Blender Source Code

        -type that path can be used on.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idtype
      • getGroupmode

        public short getGroupmode()
                           throws java.io.IOException
        Get method for struct member 'groupmode'.

        Field Documentation

        Blender Source Code

        Group naming (eKSP_Grouping).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__groupmode
      • setGroupmode

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

        Field Documentation

        Blender Source Code

        Group naming (eKSP_Grouping).

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

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

        Field Documentation

        Blender Source Code

        Various settings, etc.

        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

        Various settings, etc.

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

        public CPointer<java.lang.Byte> getRna_path()
                                             throws java.io.IOException
        Get method for struct member 'rna_path'.

        Field Documentation

        Blender Source Code

        Dynamically (or statically in the case of predefined sets) path.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__rna_path
      • setRna_path

        public void setRna_path​(CPointer<java.lang.Byte> rna_path)
                         throws java.io.IOException
        Set method for struct member 'rna_path'.

        Field Documentation

        Blender Source Code

        Dynamically (or statically in the case of predefined sets) path.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__rna_path
      • getArray_index

        public int getArray_index()
                           throws java.io.IOException
        Get method for struct member 'array_index'.

        Field Documentation

        Blender Source Code

        Index that path affects.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__array_index
      • setArray_index

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

        Field Documentation

        Blender Source Code

        Index that path affects.

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

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