Class bGPDframe


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

    Class Documentation

    Blender Source Code

    Grease-Pencil Annotations - 'Frame' -> Acts as storage for the 'image' formed by strokes

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        List of the simplified 'strokes' that make up the frame's data.

        Pointer Arithmetics

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

         bGPDframe bgpdframe = ...;
         CPointer<Object> p = bgpdframe.__dna__addressof(bGPDframe.__DNA__FIELD__strokes);
         CPointer<ListBase> p_strokes = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Frame number of this frame.

        Pointer Arithmetics

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

         bGPDframe bgpdframe = ...;
         CPointer<Object> p = bgpdframe.__dna__addressof(bGPDframe.__DNA__FIELD__framenum);
         CPointer<Integer> p_framenum = p.cast(new Class[]{Integer.class});
         

        Metadata

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

        Temp settings.

        Pointer Arithmetics

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

         bGPDframe bgpdframe = ...;
         CPointer<Object> p = bgpdframe.__dna__addressof(bGPDframe.__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__key_type

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

        Field Documentation

        Blender Source Code

        Keyframe type (eBezTriple_KeyframeType).

        Pointer Arithmetics

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

         bGPDframe bgpdframe = ...;
         CPointer<Object> p = bgpdframe.__dna__addressof(bGPDframe.__DNA__FIELD__key_type);
         CPointer<Short> p_key_type = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'key_type'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__runtime

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

        Field Documentation

        Blender Source Code

        NOTE: When adding new members, make sure to add them to BKE_gpencil_frame_copy_settings as well!

        Pointer Arithmetics

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

         bGPDframe bgpdframe = ...;
         CPointer<Object> p = bgpdframe.__dna__addressof(bGPDframe.__DNA__FIELD__runtime);
         CPointer<bGPDframe_Runtime> p_runtime = p.cast(new Class[]{bGPDframe_Runtime.class});
         

        Metadata

        • Field: 'runtime'
        • Signature: 'bGPDframe_Runtime'
        • Actual Size (32bit/64bit): 12/16
    • Constructor Detail

      • bGPDframe

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

        protected bGPDframe​(bGPDframe that)
    • Method Detail

      • setNext

        public void setNext​(CPointer<bGPDframe> 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<bGPDframe> prev)
                     throws java.io.IOException
        Set method for struct member 'prev'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev
      • getStrokes

        public ListBase getStrokes()
                            throws java.io.IOException
        Get method for struct member 'strokes'.

        Field Documentation

        Blender Source Code

        List of the simplified 'strokes' that make up the frame's data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__strokes
      • setStrokes

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

        Field Documentation

        Blender Source Code

        List of the simplified 'strokes' that make up the frame's data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__strokes
      • getFramenum

        public int getFramenum()
                        throws java.io.IOException
        Get method for struct member 'framenum'.

        Field Documentation

        Blender Source Code

        Frame number of this frame.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__framenum
      • setFramenum

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

        Field Documentation

        Blender Source Code

        Frame number of this frame.

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

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

        Field Documentation

        Blender Source Code

        Temp settings.

        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

        Temp settings.

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

        public short getKey_type()
                          throws java.io.IOException
        Get method for struct member 'key_type'.

        Field Documentation

        Blender Source Code

        Keyframe type (eBezTriple_KeyframeType).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__key_type
      • setKey_type

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

        Field Documentation

        Blender Source Code

        Keyframe type (eBezTriple_KeyframeType).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__key_type
      • getRuntime

        public bGPDframe_Runtime getRuntime()
                                     throws java.io.IOException
        Get method for struct member 'runtime'.

        Field Documentation

        Blender Source Code

        NOTE: When adding new members, make sure to add them to BKE_gpencil_frame_copy_settings as well!

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__runtime
      • setRuntime

        public void setRuntime​(bGPDframe_Runtime runtime)
                        throws java.io.IOException
        Set method for struct member 'runtime'.

        Field Documentation

        Blender Source Code

        NOTE: When adding new members, make sure to add them to BKE_gpencil_frame_copy_settings as well!

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

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