DNA_cachefile_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2016 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
 
struct GSet;
 
/* CacheFile::type */
typedef enum {
  CACHEFILE_TYPE_ALEMBIC = 1,
  CACHEFILE_TYPE_USD = 2,
  CACHE_FILE_TYPE_INVALID = 0,
} eCacheFileType;
 
/* CacheFile::flag */
enum {
  CACHEFILE_DS_EXPAND = (1 << 0),
  CACHEFILE_UNUSED_0 = (1 << 1),
};
 
#if 0 /* UNUSED */
/* CacheFile::draw_flag */
enum {
  CACHEFILE_KEYFRAME_DRAWN = (1 << 0),
};
#endif
 
/* Representation of an object's path inside the archive.
 * Note that this is not a file path. */
typedef struct CacheObjectPath {
  struct CacheObjectPath *next, *prev;
 
  char path[4096];
} CacheObjectPath;
 
/* CacheFileLayer::flag */
enum { CACHEFILE_LAYER_HIDDEN = (1 << 0) };
 
typedef struct CacheFileLayer {
  struct CacheFileLayer *next, *prev;
 
  char filepath[/*FILE_MAX*/ 1024];
  int flag;
  int _pad;
} CacheFileLayer;
 
/* CacheFile::velocity_unit
 * Determines what temporal unit is used to interpret velocity vectors for motion blur effects. */
enum {
  CACHEFILE_VELOCITY_UNIT_FRAME,
  CACHEFILE_VELOCITY_UNIT_SECOND,
};
 
typedef struct CacheFile {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_CF;
#endif
 
  ID id;
  struct AnimData *adt;

  ListBase object_paths;
 
  ListBase layers;
 
  char filepath[/*FILE_MAX*/ 1024];
 
  char is_sequence;
  char forward_axis;
  char up_axis;
  char override_frame;
 
  float scale;
  float frame;
  float frame_offset;
 
  char _pad[4];

  short flag;
 
  /* eCacheFileType enum. */
  char type;

  char use_render_procedural;
 
  char _pad1[3];

  char use_prefetch;

  int prefetch_cache_size;

  int active_layer;
 
  char _pad2[3];
 
  char velocity_unit;
  /* Name of the velocity property in the archive. */
  char velocity_name[64];
 
  /* Runtime */
  struct CacheArchiveHandle *handle;
  char handle_filepath[/*FILE_MAX*/ 1024];
  struct GSet *handle_readers;
} CacheFile;