Class CacheFile


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

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

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

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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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__object_paths

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

        Field Documentation

        Blender Python API

        (read-only) Paths of the objects inside the Alembic archive

        Blender Source Code

        Paths of the objects inside of the archive referenced by this CacheFile .

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__object_paths);
         CPointer<ListBase> p_object_paths = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        (read-only) Layers of the cache

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__layers);
         CPointer<ListBase> p_layers = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        Path to external displacements file

        Blender Source Code

        1024 = FILE_MAX.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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__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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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__forward_axis

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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__forward_axis);
         CPointer<Byte> p_forward_axis = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'forward_axis'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__up_axis

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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__up_axis);
         CPointer<Byte> p_up_axis = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'up_axis'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__override_frame

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

        Field Documentation

        Blender Python API

        Whether to use a custom frame for looking up data in the cache file, instead of using the current scene frame

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__override_frame);
         CPointer<Byte> p_override_frame = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'override_frame'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__scale

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

        Field Documentation

        Blender Python API

        Value by which to enlarge or shrink the object with respect to the world's origin (only applicable through a Transform Cache constraint)

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__scale);
         CPointer<Float> p_scale = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'scale'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__frame

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

        Field Documentation

        Blender Python API

        The time to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame/time to lookup in the cache file.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__frame);
         CPointer<Float> p_frame = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'frame'
        • Signature: 'float'
        • 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

        Subtracted from the current frame to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame offset to subtract.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__frame_offset);
         CPointer<Float> p_frame_offset = p.cast(new Class[]{Float.class});
         

        Metadata

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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__flag

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

        Field Documentation

        Blender Source Code

        Animation flag.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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

        eCacheFileType enum.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__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__use_render_procedural

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

        Field Documentation

        Blender Python API

        Display boxes in the viewport as placeholders for the objects, Cycles will use a procedural to load the objects during viewport rendering in experimental mode, other render engines will also receive a placeholder and should take care of loading the Alembic data themselves if possible

        Blender Source Code

        Do not load data from the cache file and display objects in the scene as boxes, Cycles will load objects directly from the CacheFile . Other render engines which can load Alembic data directly can take care of rendering it themselves.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__use_render_procedural);
         CPointer<Byte> p_use_render_procedural = p.cast(new Class[]{Byte.class});
         

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Python API

        When enabled, the Cycles Procedural will preload animation data for faster updates

        Blender Source Code

        Enable data prefetching when using the Cycles Procedural.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__use_prefetch);
         CPointer<Byte> p_use_prefetch = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'use_prefetch'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__prefetch_cache_size

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

        Field Documentation

        Blender Python API

        Memory usage limit in megabytes for the Cycles Procedural cache, if the data does not fit within the limit, rendering is aborted

        Blender Source Code

        Size in megabytes for the prefetch cache used by the Cycles Procedural.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__prefetch_cache_size);
         CPointer<Integer> p_prefetch_cache_size = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'prefetch_cache_size'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__active_layer

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

        Field Documentation

        Blender Source Code

        Index of the currently selected layer in the UI, starts at 1.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__active_layer);
         CPointer<Integer> p_active_layer = p.cast(new Class[]{Integer.class});
         

        Metadata

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD___pad2);
         CPointer<CArrayFacade<Byte>> p__pad2 = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad2'
        • Signature: 'char[3]'
        • Actual Size (32bit/64bit): 3/3
      • __DNA__FIELD__velocity_unit

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

        Field Documentation

        Blender Python API

        Define how the velocity vectors are interpreted with regard to time, 'frame' means the delta time is 1 frame, 'second' means the delta time is 1 / FPS

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__velocity_unit);
         CPointer<Byte> p_velocity_unit = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'velocity_unit'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__velocity_name

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

        Field Documentation

        Blender Python API

        Name of the Alembic attribute used for generating motion blur data

        Blender Source Code

        Name of the velocity property in the archive.

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__velocity_name);
         CPointer<CArrayFacade<Byte>> p_velocity_name = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Runtime

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__handle);
         CPointer<CPointer<Object>> p_handle = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'handle'
        • Signature: 'CacheArchiveHandle*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__handle_filepath

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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__handle_filepath);
         CPointer<CArrayFacade<Byte>> p_handle_filepath = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Pointer Arithmetics

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

         CacheFile cachefile = ...;
         CPointer<Object> p = cachefile.__dna__addressof(CacheFile.__DNA__FIELD__handle_readers);
         CPointer<CPointer<Object>> p_handle_readers = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'handle_readers'
        • Signature: 'GSet*'
        • Actual Size (32bit/64bit): 4/8
    • Constructor Detail

      • CacheFile

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

        protected CacheFile​(CacheFile 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
      • setAdt

        public void setAdt​(CPointer<AnimData> adt)
                    throws java.io.IOException
        Set method for struct member 'adt'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__adt
      • getObject_paths

        public ListBase getObject_paths()
                                 throws java.io.IOException
        Get method for struct member 'object_paths'.

        Field Documentation

        Blender Python API

        (read-only) Paths of the objects inside the Alembic archive

        Blender Source Code

        Paths of the objects inside of the archive referenced by this CacheFile .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_paths
      • setObject_paths

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

        Field Documentation

        Blender Python API

        (read-only) Paths of the objects inside the Alembic archive

        Blender Source Code

        Paths of the objects inside of the archive referenced by this CacheFile .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_paths
      • getLayers

        public ListBase getLayers()
                           throws java.io.IOException
        Get method for struct member 'layers'.

        Field Documentation

        Blender Python API

        (read-only) Layers of the cache
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layers
      • setLayers

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

        Field Documentation

        Blender Python API

        (read-only) Layers of the cache
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layers
      • getFilepath

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

        Field Documentation

        Blender Python API

        Path to external displacements file

        Blender Source Code

        1024 = 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

        Path to external displacements file

        Blender Source Code

        1024 = FILE_MAX.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__filepath
      • 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
        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
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__is_sequence
      • getForward_axis

        public byte getForward_axis()
                             throws java.io.IOException
        Get method for struct member 'forward_axis'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__forward_axis
      • setForward_axis

        public void setForward_axis​(byte forward_axis)
                             throws java.io.IOException
        Set method for struct member 'forward_axis'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__forward_axis
      • getUp_axis

        public byte getUp_axis()
                        throws java.io.IOException
        Get method for struct member 'up_axis'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__up_axis
      • setUp_axis

        public void setUp_axis​(byte up_axis)
                        throws java.io.IOException
        Set method for struct member 'up_axis'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__up_axis
      • getOverride_frame

        public byte getOverride_frame()
                               throws java.io.IOException
        Get method for struct member 'override_frame'.

        Field Documentation

        Blender Python API

        Whether to use a custom frame for looking up data in the cache file, instead of using the current scene frame
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__override_frame
      • setOverride_frame

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

        Field Documentation

        Blender Python API

        Whether to use a custom frame for looking up data in the cache file, instead of using the current scene frame
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__override_frame
      • getScale

        public float getScale()
                       throws java.io.IOException
        Get method for struct member 'scale'.

        Field Documentation

        Blender Python API

        Value by which to enlarge or shrink the object with respect to the world's origin (only applicable through a Transform Cache constraint)
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__scale
      • setScale

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

        Field Documentation

        Blender Python API

        Value by which to enlarge or shrink the object with respect to the world's origin (only applicable through a Transform Cache constraint)
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__scale
      • getFrame

        public float getFrame()
                       throws java.io.IOException
        Get method for struct member 'frame'.

        Field Documentation

        Blender Python API

        The time to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame/time to lookup in the cache file.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame
      • setFrame

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

        Field Documentation

        Blender Python API

        The time to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame/time to lookup in the cache file.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame
      • getFrame_offset

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

        Field Documentation

        Blender Python API

        Subtracted from the current frame to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame offset to subtract.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frame_offset
      • setFrame_offset

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

        Field Documentation

        Blender Python API

        Subtracted from the current frame to use for looking up the data in the cache file, or to determine which file to use in a file sequence

        Blender Source Code

        The frame offset to subtract.

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

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

        Field Documentation

        Blender Source Code

        Animation 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'.

        Field Documentation

        Blender Source Code

        Animation 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

        eCacheFileType enum.

        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

        eCacheFileType enum.

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

        public byte getUse_render_procedural()
                                      throws java.io.IOException
        Get method for struct member 'use_render_procedural'.

        Field Documentation

        Blender Python API

        Display boxes in the viewport as placeholders for the objects, Cycles will use a procedural to load the objects during viewport rendering in experimental mode, other render engines will also receive a placeholder and should take care of loading the Alembic data themselves if possible

        Blender Source Code

        Do not load data from the cache file and display objects in the scene as boxes, Cycles will load objects directly from the CacheFile . Other render engines which can load Alembic data directly can take care of rendering it themselves.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__use_render_procedural
      • setUse_render_procedural

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

        Field Documentation

        Blender Python API

        Display boxes in the viewport as placeholders for the objects, Cycles will use a procedural to load the objects during viewport rendering in experimental mode, other render engines will also receive a placeholder and should take care of loading the Alembic data themselves if possible

        Blender Source Code

        Do not load data from the cache file and display objects in the scene as boxes, Cycles will load objects directly from the CacheFile . Other render engines which can load Alembic data directly can take care of rendering it themselves.

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

        public byte getUse_prefetch()
                             throws java.io.IOException
        Get method for struct member 'use_prefetch'.

        Field Documentation

        Blender Python API

        When enabled, the Cycles Procedural will preload animation data for faster updates

        Blender Source Code

        Enable data prefetching when using the Cycles Procedural.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__use_prefetch
      • setUse_prefetch

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

        Field Documentation

        Blender Python API

        When enabled, the Cycles Procedural will preload animation data for faster updates

        Blender Source Code

        Enable data prefetching when using the Cycles Procedural.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__use_prefetch
      • getPrefetch_cache_size

        public int getPrefetch_cache_size()
                                   throws java.io.IOException
        Get method for struct member 'prefetch_cache_size'.

        Field Documentation

        Blender Python API

        Memory usage limit in megabytes for the Cycles Procedural cache, if the data does not fit within the limit, rendering is aborted

        Blender Source Code

        Size in megabytes for the prefetch cache used by the Cycles Procedural.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prefetch_cache_size
      • setPrefetch_cache_size

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

        Field Documentation

        Blender Python API

        Memory usage limit in megabytes for the Cycles Procedural cache, if the data does not fit within the limit, rendering is aborted

        Blender Source Code

        Size in megabytes for the prefetch cache used by the Cycles Procedural.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prefetch_cache_size
      • getActive_layer

        public int getActive_layer()
                            throws java.io.IOException
        Get method for struct member 'active_layer'.

        Field Documentation

        Blender Source Code

        Index of the currently selected layer in the UI, starts at 1.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_layer
      • setActive_layer

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

        Field Documentation

        Blender Source Code

        Index of the currently selected layer in the UI, starts at 1.

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

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

        public byte getVelocity_unit()
                              throws java.io.IOException
        Get method for struct member 'velocity_unit'.

        Field Documentation

        Blender Python API

        Define how the velocity vectors are interpreted with regard to time, 'frame' means the delta time is 1 frame, 'second' means the delta time is 1 / FPS
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__velocity_unit
      • setVelocity_unit

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

        Field Documentation

        Blender Python API

        Define how the velocity vectors are interpreted with regard to time, 'frame' means the delta time is 1 frame, 'second' means the delta time is 1 / FPS
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__velocity_unit
      • getVelocity_name

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

        Field Documentation

        Blender Python API

        Name of the Alembic attribute used for generating motion blur data

        Blender Source Code

        Name of the velocity property in the archive.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__velocity_name
      • setVelocity_name

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

        Field Documentation

        Blender Python API

        Name of the Alembic attribute used for generating motion blur data

        Blender Source Code

        Name of the velocity property in the archive.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__velocity_name
      • getHandle

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

        Field Documentation

        Blender Source Code

        Runtime

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle
      • setHandle

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

        Field Documentation

        Blender Source Code

        Runtime

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle
      • getHandle_filepath

        public CArrayFacade<java.lang.Byte> getHandle_filepath()
                                                        throws java.io.IOException
        Get method for struct member 'handle_filepath'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle_filepath
      • setHandle_filepath

        public void setHandle_filepath​(CArrayFacade<java.lang.Byte> handle_filepath)
                                throws java.io.IOException
        Set method for struct member 'handle_filepath'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle_filepath
      • getHandle_readers

        public CPointer<java.lang.Object> getHandle_readers()
                                                     throws java.io.IOException
        Get method for struct member 'handle_readers'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle_readers
      • setHandle_readers

        public void setHandle_readers​(CPointer<java.lang.Object> handle_readers)
                               throws java.io.IOException
        Set method for struct member 'handle_readers'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__handle_readers
      • __io__addressof

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