Class Volume


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

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__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)

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__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__filepath

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

        Field Documentation

        Blender Python API

        Volume file used by this Volume data-block

        Blender Source Code

        File FILE_MAX

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__filepath);
         CPointer<CArrayFacade<Byte>> p_filepath = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: 'filepath'
        • Signature: 'char[1024]'
        • Actual Size (32bit/64bit): 1024/1024
      • __DNA__FIELD__packedfile

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

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__packedfile);
         CPointer<CPointer<PackedFile>> p_packedfile = p.cast(new Class[]{CPointer.class, PackedFile.class});
         

        Metadata

        • Field: 'packedfile'
        • Signature: 'PackedFile*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__is_sequence

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

        Field Documentation

        Blender Python API

        Whether the cache is separated in a series of files

        Blender Source Code

        Sequence

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__is_sequence);
         CPointer<Byte> p_is_sequence = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'is_sequence'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__sequence_mode

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

        Field Documentation

        Blender Python API

        Sequence playback mode

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__sequence_mode);
         CPointer<Byte> p_sequence_mode = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'sequence_mode'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD___pad1

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

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD___pad1);
         CPointer<CArrayFacade<Byte>> p__pad1 = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad1'
        • Signature: 'char[2]'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__frame_start

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

        Field Documentation

        Blender Python API

        Global starting frame of the sequence, assuming first has a #1

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__frame_start);
         CPointer<Integer> p_frame_start = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'frame_start'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__frame_duration

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

        Field Documentation

        Blender Python API

        Number of frames of the sequence to use

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__frame_duration);
         CPointer<Integer> p_frame_duration = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'frame_duration'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__frame_offset

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

        Field Documentation

        Blender Python API

        Offset the number of the frame to use in the animation

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__frame_offset);
         CPointer<Integer> p_frame_offset = p.cast(new Class[]{Integer.class});
         

        Metadata

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

        Flag

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__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__active_grid

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

        Field Documentation

        Blender Source Code

        Grids

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__active_grid);
         CPointer<Integer> p_active_grid = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active_grid'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__mat

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

        Field Documentation

        Blender Source Code

        Material

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__mat);
         CPointer<CPointer<CPointer<Material>>> p_mat = p.cast(new Class[]{CPointer.class, CPointer.class, Material.class});
         

        Metadata

        • Field: 'mat'
        • Signature: 'Material**'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__totcol

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

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__totcol);
         CPointer<Short> p_totcol = p.cast(new Class[]{Short.class});
         

        Metadata

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD___pad2);
         CPointer<CArrayFacade<Short>> p__pad2 = p.cast(new Class[]{CArrayFacade.class, Short.class});
         

        Metadata

        • Field: '_pad2'
        • Signature: 'short[3]'
        • Actual Size (32bit/64bit): 6/6
      • __DNA__FIELD__render

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

        Field Documentation

        Blender Python API

        (read-only) Volume render settings for 3d viewport

        Blender Source Code

        Render & Display Settings

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__render);
         CPointer<VolumeRender> p_render = p.cast(new Class[]{VolumeRender.class});
         

        Metadata

        • Field: 'render'
        • Signature: 'VolumeRender'
        • Actual Size (32bit/64bit): 16/16
      • __DNA__FIELD__display

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

        Field Documentation

        Blender Python API

        (read-only) Volume display settings for 3d viewport

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__display);
         CPointer<VolumeDisplay> p_display = p.cast(new Class[]{VolumeDisplay.class});
         

        Metadata

        • Field: 'display'
        • Signature: 'VolumeDisplay'
        • Actual Size (32bit/64bit): 16/16
      • __DNA__FIELD__batch_cache

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

        Field Documentation

        Blender Source Code

        Draw Cache

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__batch_cache);
         CPointer<CPointer<Object>> p_batch_cache = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'batch_cache'
        • Signature: 'void*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__runtime

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

        Field Documentation

        Blender Source Code

        Runtime Data

        Pointer Arithmetics

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

         Volume volume = ...;
         CPointer<Object> p = volume.__dna__addressof(Volume.__DNA__FIELD__runtime);
         CPointer<Volume_Runtime> p_runtime = p.cast(new Class[]{Volume_Runtime.class});
         

        Metadata

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

      • Volume

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

        protected Volume​(Volume 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)

        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)

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

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

        Field Documentation

        Blender Python API

        Volume file used by this Volume data-block

        Blender Source Code

        File FILE_MAX

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__filepath
      • setFilepath

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

        Field Documentation

        Blender Python API

        Volume file used by this Volume data-block

        Blender Source Code

        File FILE_MAX

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__filepath
      • setPackedfile

        public void setPackedfile​(CPointer<PackedFile> packedfile)
                           throws java.io.IOException
        Set method for struct member 'packedfile'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__packedfile
      • getIs_sequence

        public byte getIs_sequence()
                            throws java.io.IOException
        Get method for struct member 'is_sequence'.

        Field Documentation

        Blender Python API

        Whether the cache is separated in a series of files

        Blender Source Code

        Sequence

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__is_sequence
      • setIs_sequence

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

        Field Documentation

        Blender Python API

        Whether the cache is separated in a series of files

        Blender Source Code

        Sequence

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__is_sequence
      • getSequence_mode

        public byte getSequence_mode()
                              throws java.io.IOException
        Get method for struct member 'sequence_mode'.

        Field Documentation

        Blender Python API

        Sequence playback mode
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sequence_mode
      • setSequence_mode

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

        Field Documentation

        Blender Python API

        Sequence playback mode
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sequence_mode
      • get_pad1

        public CArrayFacade<java.lang.Byte> get_pad1()
                                              throws java.io.IOException
        Get method for struct member '_pad1'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad1
      • set_pad1

        public void set_pad1​(CArrayFacade<java.lang.Byte> _pad1)
                      throws java.io.IOException
        Set method for struct member '_pad1'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad1
      • getFrame_start

        public int getFrame_start()
                           throws java.io.IOException
        Get method for struct member 'frame_start'.

        Field Documentation

        Blender Python API

        Global starting frame of the sequence, assuming first has a #1
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_start
      • setFrame_start

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

        Field Documentation

        Blender Python API

        Global starting frame of the sequence, assuming first has a #1
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_start
      • getFrame_duration

        public int getFrame_duration()
                              throws java.io.IOException
        Get method for struct member 'frame_duration'.

        Field Documentation

        Blender Python API

        Number of frames of the sequence to use
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_duration
      • setFrame_duration

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

        Field Documentation

        Blender Python API

        Number of frames of the sequence to use
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_duration
      • getFrame_offset

        public int getFrame_offset()
                            throws java.io.IOException
        Get method for struct member 'frame_offset'.

        Field Documentation

        Blender Python API

        Offset the number of the frame to use in the animation
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_offset
      • setFrame_offset

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

        Field Documentation

        Blender Python API

        Offset the number of the frame to use in the animation
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_offset
      • getFlag

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

        Field Documentation

        Blender Source Code

        Flag

        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

        Flag

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

        public int getActive_grid()
                           throws java.io.IOException
        Get method for struct member 'active_grid'.

        Field Documentation

        Blender Source Code

        Grids

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_grid
      • setActive_grid

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

        Field Documentation

        Blender Source Code

        Grids

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_grid
      • getTotcol

        public short getTotcol()
                        throws java.io.IOException
        Get method for struct member 'totcol'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__totcol
      • setTotcol

        public void setTotcol​(short totcol)
                       throws java.io.IOException
        Set method for struct member 'totcol'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__totcol
      • get_pad2

        public CArrayFacade<java.lang.Short> 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​(CArrayFacade<java.lang.Short> _pad2)
                      throws java.io.IOException
        Set method for struct member '_pad2'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad2
      • getRender

        public VolumeRender getRender()
                               throws java.io.IOException
        Get method for struct member 'render'.

        Field Documentation

        Blender Python API

        (read-only) Volume render settings for 3d viewport

        Blender Source Code

        Render & Display Settings

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__render
      • setRender

        public void setRender​(VolumeRender render)
                       throws java.io.IOException
        Set method for struct member 'render'.

        Field Documentation

        Blender Python API

        (read-only) Volume render settings for 3d viewport

        Blender Source Code

        Render & Display Settings

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__render
      • getDisplay

        public VolumeDisplay getDisplay()
                                 throws java.io.IOException
        Get method for struct member 'display'.

        Field Documentation

        Blender Python API

        (read-only) Volume display settings for 3d viewport
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__display
      • setDisplay

        public void setDisplay​(VolumeDisplay display)
                        throws java.io.IOException
        Set method for struct member 'display'.

        Field Documentation

        Blender Python API

        (read-only) Volume display settings for 3d viewport
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__display
      • getBatch_cache

        public CPointer<java.lang.Object> getBatch_cache()
                                                  throws java.io.IOException
        Get method for struct member 'batch_cache'.

        Field Documentation

        Blender Source Code

        Draw Cache

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__batch_cache
      • setBatch_cache

        public void setBatch_cache​(CPointer<java.lang.Object> batch_cache)
                            throws java.io.IOException
        Set method for struct member 'batch_cache'.

        Field Documentation

        Blender Source Code

        Draw Cache

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

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

        Field Documentation

        Blender Source Code

        Runtime Data

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

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

        Field Documentation

        Blender Source Code

        Runtime Data

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

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