Blender  V2.93
Typedefs | Enumerations | Functions | Variables
BKE_volume.h File Reference
Blender » BlenKernel

Volume datablock. More...

Go to the source code of this file.

Typedefs

typedef struct VolumeGrid VolumeGrid
 
typedef enum VolumeGridType VolumeGridType
 

Enumerations

enum  { BKE_VOLUME_BATCH_DIRTY_ALL = 0 }
 
enum  VolumeGridType {
  VOLUME_GRID_UNKNOWN = 0 , VOLUME_GRID_BOOLEAN , VOLUME_GRID_FLOAT , VOLUME_GRID_DOUBLE ,
  VOLUME_GRID_INT , VOLUME_GRID_INT64 , VOLUME_GRID_MASK , VOLUME_GRID_STRING ,
  VOLUME_GRID_VECTOR_FLOAT , VOLUME_GRID_VECTOR_DOUBLE , VOLUME_GRID_VECTOR_INT , VOLUME_GRID_POINTS
}
 

Functions

void BKE_volumes_init (void)
 
void BKE_volume_init_grids (struct Volume *volume)
 
void * BKE_volume_add (struct Main *bmain, const char *name)
 
struct BoundBox * BKE_volume_boundbox_get (struct Object *ob)
 
bool BKE_volume_is_y_up (const struct Volume *volume)
 
bool BKE_volume_is_points_only (const struct Volume *volume)
 
void BKE_volume_eval_geometry (struct Depsgraph *depsgraph, struct Volume *volume)
 
void BKE_volume_data_update (struct Depsgraph *depsgraph, struct Scene *scene, struct Object *object)
 
void BKE_volume_grids_backup_restore (struct Volume *volume, struct VolumeGridVector *grids, const char *filepath)
 
void BKE_volume_batch_cache_dirty_tag (struct Volume *volume, int mode)
 
void BKE_volume_batch_cache_free (struct Volume *volume)
 
bool BKE_volume_load (const struct Volume *volume, const struct Main *bmain)
 
void BKE_volume_unload (struct Volume *volume)
 
bool BKE_volume_is_loaded (const struct Volume *volume)
 
int BKE_volume_num_grids (const struct Volume *volume)
 
const char * BKE_volume_grids_error_msg (const struct Volume *volume)
 
const char * BKE_volume_grids_frame_filepath (const struct Volume *volume)
 
const VolumeGrid * BKE_volume_grid_get_for_read (const struct Volume *volume, int grid_index)
 
VolumeGrid * BKE_volume_grid_get_for_write (struct Volume *volume, int grid_index)
 
const VolumeGrid * BKE_volume_grid_active_get_for_read (const struct Volume *volume)
 
const VolumeGrid * BKE_volume_grid_find_for_read (const struct Volume *volume, const char *name)
 
bool BKE_volume_grid_load (const struct Volume *volume, const struct VolumeGrid *grid)
 
void BKE_volume_grid_unload (const struct Volume *volume, const struct VolumeGrid *grid)
 
bool BKE_volume_grid_is_loaded (const struct VolumeGrid *grid)
 
const char * BKE_volume_grid_name (const struct VolumeGrid *grid)
 
VolumeGridType BKE_volume_grid_type (const struct VolumeGrid *grid)
 
int BKE_volume_grid_channels (const struct VolumeGrid *grid)
 
void BKE_volume_grid_transform_matrix (const struct VolumeGrid *grid, float mat[4][4])
 
struct Volume * BKE_volume_new_for_eval (const struct Volume *volume_src)
 
struct Volume * BKE_volume_copy_for_eval (struct Volume *volume_src, bool reference)
 
struct VolumeGrid * BKE_volume_grid_add (struct Volume *volume, const char *name, VolumeGridType type)
 
void BKE_volume_grid_remove (struct Volume *volume, struct VolumeGrid *grid)
 
int BKE_volume_simplify_level (const struct Depsgraph *depsgraph)
 
float BKE_volume_simplify_factor (const struct Depsgraph *depsgraph)
 
bool BKE_volume_save (const struct Volume *volume, const struct Main *bmain, struct ReportList *reports, const char *filepath)
 

Variables

void(* BKE_volume_batch_cache_dirty_tag_cb )(struct Volume *volume, int mode)
 
void(* BKE_volume_batch_cache_free_cb )(struct Volume *volume)
 

Detailed Description

Volume datablock.

Definition in file BKE_volume.h.

Typedef Documentation

◆ VolumeGrid

typedef struct VolumeGrid VolumeGrid

Definition at line 71 of file BKE_volume.h.

◆ VolumeGridType

typedef enum VolumeGridType VolumeGridType

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
BKE_VOLUME_BATCH_DIRTY_ALL 

Definition at line 63 of file BKE_volume.h.

◆ VolumeGridType

enum VolumeGridType
Enumerator
VOLUME_GRID_UNKNOWN 
VOLUME_GRID_BOOLEAN 
VOLUME_GRID_FLOAT 
VOLUME_GRID_DOUBLE 
VOLUME_GRID_INT 
VOLUME_GRID_INT64 
VOLUME_GRID_MASK 
VOLUME_GRID_STRING 
VOLUME_GRID_VECTOR_FLOAT 
VOLUME_GRID_VECTOR_DOUBLE 
VOLUME_GRID_VECTOR_INT 
VOLUME_GRID_POINTS 

Definition at line 98 of file BKE_volume.h.

Function Documentation

◆ BKE_volume_add()

void* BKE_volume_add ( struct Main *  bmain,
const char *  name 
)

Definition at line 671 of file volume.cc.

References BKE_id_new(), and ID_VO.

Referenced by BKE_object_obdata_add_from_type().

◆ BKE_volume_batch_cache_dirty_tag()

void BKE_volume_batch_cache_dirty_tag ( struct Volume *  volume,
int  mode 
)

Definition at line 1121 of file volume.cc.

References Volume::batch_cache, and BKE_volume_batch_cache_dirty_tag_cb.

Referenced by BKE_object_batch_cache_dirty_tag().

◆ BKE_volume_batch_cache_free()

void BKE_volume_batch_cache_free ( struct Volume *  volume)

Definition at line 1128 of file volume.cc.

References Volume::batch_cache, and BKE_volume_batch_cache_free_cb.

Referenced by volume_free_data().

◆ BKE_volume_boundbox_get()

struct BoundBox* BKE_volume_boundbox_get ( struct Object *  ob)

Definition at line 926 of file volume.cc.

References Object_Runtime::bb, BKE_boundbox_init_from_minmax(), BKE_volume_min_max(), BLI_assert, BOUNDBOX_DIRTY, Object::data, BoundBox::flag, INIT_MINMAX, max, MEM_callocN, min, OB_VOLUME, Object::runtime, and Object::type.

Referenced by BKE_object_boundbox_get(), BKE_object_minmax(), and eevee_volume_object_grids_init().

◆ BKE_volume_copy_for_eval()

struct Volume* BKE_volume_copy_for_eval ( struct Volume *  volume_src,
bool  reference 
)

Definition at line 1390 of file volume.cc.

References BKE_id_copy_ex(), Volume::id, LIB_ID_COPY_CD_REFERENCE, LIB_ID_COPY_LOCALIZE, and result.

Referenced by VolumeComponent::copy(), VolumeComponent::ensure_owns_direct_data(), VolumeComponent::get_for_write(), and volume_evaluate_modifiers().

◆ BKE_volume_data_update()

void BKE_volume_data_update ( struct Depsgraph *  depsgraph,
struct Scene *  scene,
struct Object *  object 
)

Definition at line 1075 of file volume.cc.

References BKE_object_eval_assign_data(), BKE_object_free_derived_caches(), Object::data, depsgraph, scene, and volume_evaluate_modifiers().

Referenced by BKE_object_handle_data_update(), and object_force_modifier_update_for_bind().

◆ BKE_volume_eval_geometry()

void BKE_volume_eval_geometry ( struct Depsgraph *  depsgraph,
struct Volume *  volume 
)

Definition at line 1054 of file volume.cc.

References BKE_volume_unload(), DEG_get_original_id(), DEG_is_active(), depsgraph, Volume_Runtime::frame, Volume::id, Volume::runtime, volume_sequence_frame(), and volume_update_simplify_level().

Referenced by blender::deg::DepsgraphNodeBuilder::build_object_data_geometry_datablock().

◆ BKE_volume_grid_active_get_for_read()

const VolumeGrid* BKE_volume_grid_active_get_for_read ( const struct Volume *  volume)

Referenced by DRW_volume_batch_cache_get_selection_surface(), DRW_volume_batch_cache_get_wireframes_face(), and workbench_volume_object_cache_populate().

◆ BKE_volume_grid_add()

struct VolumeGrid* BKE_volume_grid_add ( struct Volume *  volume,
const char *  name,
VolumeGridType  type 
)

Definition at line 1417 of file volume.cc.

References BKE_volume_grid_find_for_read(), BLI_assert, Volume_Runtime::grids, Volume::runtime, type, UNUSED_VARS, and VOLUME_GRID_UNKNOWN.

Referenced by modifyVolume().

◆ BKE_volume_grid_channels()

int BKE_volume_grid_channels ( const struct VolumeGrid *  grid)

Referenced by BKE_volume_grid_dense_floats(), and volume_grid_cache_get().

◆ BKE_volume_grid_find_for_read()

const VolumeGrid* BKE_volume_grid_find_for_read ( const struct Volume *  volume,
const char *  name 
)

Referenced by eevee_volume_object_grids_init(), and modifyMesh().

◆ BKE_volume_grid_get_for_read()

const VolumeGrid* BKE_volume_grid_get_for_read ( const struct Volume *  volume,
int  grid_index 
)

Referenced by blender::nodes::compute_min_max_from_volume_and_transforms().

◆ BKE_volume_grid_get_for_write()

VolumeGrid* BKE_volume_grid_get_for_write ( struct Volume *  volume,
int  grid_index 
)

Definition at line 1183 of file volume.cc.

References Volume_Runtime::grids, Volume::runtime, and UNUSED_VARS.

Referenced by modifyVolume(), and blender::nodes::transform_volume().

◆ BKE_volume_grid_is_loaded()

bool BKE_volume_grid_is_loaded ( const struct VolumeGrid *  grid)

Referenced by volume_grid_cache_get().

◆ BKE_volume_grid_load()

bool BKE_volume_grid_load ( const struct Volume *  volume,
const struct VolumeGrid *  grid 
)

◆ BKE_volume_grid_name()

const char* BKE_volume_grid_name ( const struct VolumeGrid *  grid)

Referenced by volume_grid_cache_get().

◆ BKE_volume_grid_remove()

void BKE_volume_grid_remove ( struct Volume *  volume,
struct VolumeGrid *  grid 
)

Definition at line 1438 of file volume.cc.

References Volume_Runtime::grids, Volume::runtime, and UNUSED_VARS.

◆ BKE_volume_grid_transform_matrix()

void BKE_volume_grid_transform_matrix ( const struct VolumeGrid *  grid,
float  mat[4][4] 
)

◆ BKE_volume_grid_type()

VolumeGridType BKE_volume_grid_type ( const struct VolumeGrid *  grid)

Referenced by BKE_volume_grid_dense_floats(), BKE_volume_grid_selection_surface(), BKE_volume_grid_wireframe(), and modifyVolume().

◆ BKE_volume_grid_unload()

void BKE_volume_grid_unload ( const struct Volume *  volume,
const struct VolumeGrid *  grid 
)

Referenced by volume_grid_cache_get().

◆ BKE_volume_grids_backup_restore()

void BKE_volume_grids_backup_restore ( struct Volume *  volume,
struct VolumeGridVector *  grids,
const char *  filepath 
)

Definition at line 1089 of file volume.cc.

References BLI_assert, Volume::filepath, Volume_Runtime::grids, Volume::id, LIB_TAG_COPIED_ON_WRITE, Volume::runtime, STREQ, ID::tag, and UNUSED_VARS.

Referenced by blender::deg::VolumeBackup::restore_to_volume().

◆ BKE_volume_grids_error_msg()

const char* BKE_volume_grids_error_msg ( const struct Volume *  volume)

Referenced by volume_import_exec().

◆ BKE_volume_grids_frame_filepath()

const char* BKE_volume_grids_frame_filepath ( const struct Volume *  volume)

◆ BKE_volume_init_grids()

void BKE_volume_init_grids ( struct Volume *  volume)

Definition at line 660 of file volume.cc.

References Volume_Runtime::grids, Volume::runtime, and UNUSED_VARS.

Referenced by BKE_volume_new_for_eval(), volume_blend_read_lib(), and volume_init_data().

◆ BKE_volume_is_loaded()

bool BKE_volume_is_loaded ( const struct Volume *  volume)

◆ BKE_volume_is_points_only()

bool BKE_volume_is_points_only ( const struct Volume *  volume)

Referenced by volume_import_exec().

◆ BKE_volume_is_y_up()

bool BKE_volume_is_y_up ( const struct Volume *  volume)

Referenced by volume_import_exec().

◆ BKE_volume_load()

bool BKE_volume_load ( const struct Volume *  volume,
const struct Main *  bmain 
)

Referenced by eevee_volume_object_grids_init(), modifyMesh(), modifyVolume(), blender::nodes::transform_volume(), volume_grid_cache_get(), volume_import_exec(), and workbench_volume_object_cache_populate().

◆ BKE_volume_new_for_eval()

struct Volume* BKE_volume_new_for_eval ( const struct Volume *  volume_src)

Referenced by modifyVolume().

◆ BKE_volume_num_grids()

int BKE_volume_num_grids ( const struct Volume *  volume)

Referenced by blender::nodes::compute_min_max_from_volume_and_transforms(), modifyVolume(), and blender::nodes::transform_volume().

◆ BKE_volume_save()

bool BKE_volume_save ( const struct Volume *  volume,
const struct Main *  bmain,
struct ReportList *  reports,
const char *  filepath 
)

◆ BKE_volume_simplify_factor()

float BKE_volume_simplify_factor ( const struct Depsgraph *  depsgraph)

◆ BKE_volume_simplify_level()

int BKE_volume_simplify_level ( const struct Depsgraph *  depsgraph)

◆ BKE_volume_unload()

void BKE_volume_unload ( struct Volume *  volume)

Definition at line 849 of file volume.cc.

References CLOG_INFO, Volume_Runtime::grids, Volume::id, LOG, ID::name, Volume::runtime, and UNUSED_VARS.

Referenced by BKE_packedfile_unpack_volume(), BKE_volume_eval_geometry(), and volume_import_exec().

◆ BKE_volumes_init()

void BKE_volumes_init ( void  )

Definition at line 496 of file volume.cc.

References initialize().

Referenced by main().

Variable Documentation

◆ BKE_volume_batch_cache_dirty_tag_cb

void(* BKE_volume_batch_cache_dirty_tag_cb) (struct Volume *volume, int mode) ( struct Volume *  volume,
int  mode 
)
extern

Definition at line 1118 of file volume.cc.

Referenced by BKE_volume_batch_cache_dirty_tag(), and DRW_engines_register().

◆ BKE_volume_batch_cache_free_cb

void(* BKE_volume_batch_cache_free_cb) (struct Volume *volume) ( struct Volume *  volume)
extern

Definition at line 1119 of file volume.cc.

Referenced by BKE_volume_batch_cache_free(), and DRW_engines_register().

Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1