Volume data-block. More...

#include <memory>
#include <optional>
#include "BLI_bounds_types.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_memory_counter_fwd.hh"
#include "BKE_volume_grid_fwd.hh"

Go to the source code of this file.

Classes
struct	blender::bke::VolumeRuntime

Namespaces
namespace	blender

namespace	blender::bke

namespace	blender::bke::bake

Enumerations
enum	{ BKE_VOLUME_BATCH_DIRTY_ALL = 0 }

Functions
void	BKE_volumes_init ()

void	BKE_volume_init_grids (Volume *volume)

void *	BKE_volume_add (Main bmain, const char name)

bool	BKE_volume_is_y_up (const Volume *volume)

bool	BKE_volume_is_points_only (const Volume *volume)

void	BKE_volume_eval_geometry (Depsgraph depsgraph, Volume volume)

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

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

void	BKE_volume_batch_cache_dirty_tag (Volume *volume, int mode)

void	BKE_volume_batch_cache_free (Volume *volume)

bool	BKE_volume_load (const Volume volume, const Main bmain)

void	BKE_volume_unload (Volume *volume)

bool	BKE_volume_is_loaded (const Volume *volume)

int	BKE_volume_num_grids (const Volume *volume)

const char *	BKE_volume_grids_error_msg (const Volume *volume)

const char *	BKE_volume_grids_frame_filepath (const Volume *volume)

const blender::bke::VolumeGridData *	BKE_volume_grid_get (const Volume *volume, int grid_index)

blender::bke::VolumeGridData *	BKE_volume_grid_get_for_write (Volume *volume, int grid_index)

const blender::bke::VolumeGridData *	BKE_volume_grid_active_get_for_read (const Volume *volume)

const blender::bke::VolumeGridData *	BKE_volume_grid_find (const Volume volume, const char name)

blender::bke::VolumeGridData *	BKE_volume_grid_find_for_write (Volume volume, const char name)

bool	BKE_volume_set_velocity_grid_by_name (Volume volume, const char base_name)

Volume *	BKE_volume_new_for_eval (const Volume *volume_src)

Volume *	BKE_volume_copy_for_eval (const Volume *volume_src)

void	BKE_volume_grid_remove (Volume volume, const blender::bke::VolumeGridData grid)

void	BKE_volume_grid_add (Volume *volume, const blender::bke::VolumeGridData &grid)

bool	BKE_volume_grid_determinant_valid (double determinant)

int	BKE_volume_simplify_level (const Depsgraph *depsgraph)

float	BKE_volume_simplify_factor (const Depsgraph *depsgraph)

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

void	BKE_volume_count_memory (const Volume &volume, blender::MemoryCounter &memory)

std::optional< blender::Bounds< blender::float3 > >	BKE_volume_min_max (const Volume *volume)

Variables
void(*	BKE_volume_batch_cache_dirty_tag_cb )(Volume *volume, int mode)

void(*	BKE_volume_batch_cache_free_cb )(Volume *volume)

Detailed Description

Volume data-block.

Definition in file BKE_volume.hh.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
BKE_VOLUME_BATCH_DIRTY_ALL

Definition at line 56 of file BKE_volume.hh.

Function Documentation

◆ BKE_volume_add()

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

Definition at line 324 of file blenkernel/intern/volume.cc.

References BKE_id_new(), and ID_VO.

Referenced by BKE_object_obdata_add_from_type(), and blender::io::usd::USDVolumeReader::create_object().

◆ BKE_volume_batch_cache_dirty_tag()

void BKE_volume_batch_cache_dirty_tag	(	Volume *	volume,
		int	mode )

Definition at line 829 of file blenkernel/intern/volume.cc.

References 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 ( Volume * volume )

Definition at line 836 of file blenkernel/intern/volume.cc.

References BKE_volume_batch_cache_free_cb.

Referenced by volume_free_data().

◆ BKE_volume_copy_for_eval()

Volume * BKE_volume_copy_for_eval ( const Volume * volume_src )

Definition at line 961 of file blenkernel/intern/volume.cc.

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

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

◆ BKE_volume_count_memory()

void BKE_volume_count_memory	(	const Volume &	volume,
		blender::MemoryCounter &	memory )

Definition at line 601 of file blenkernel/intern/volume.cc.

References UNUSED_VARS.

Referenced by blender::bke::VolumeComponent::count_memory().

◆ BKE_volume_data_update()

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

Definition at line 773 of file blenkernel/intern/volume.cc.

References BKE_object_eval_assign_data(), BKE_object_free_derived_caches(), BKE_volume_new_for_eval(), depsgraph, Volume::id, blender::bke::ReadOnly, blender::bke::GeometrySet::replace_volume(), take_volume_ownership_from_geometry_set(), and volume_evaluate_modifiers().

Referenced by BKE_object_handle_data_update(), and blender::ed::object::object_force_modifier_update_for_bind().

◆ BKE_volume_eval_geometry()

void BKE_volume_eval_geometry	(	Depsgraph *	depsgraph,
		Volume *	volume )

Definition at line 732 of file blenkernel/intern/volume.cc.

References BKE_volume_unload(), DEG_get_bmain(), DEG_get_original_id(), DEG_is_active(), depsgraph, 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 blender::bke::VolumeGridData * BKE_volume_grid_active_get_for_read ( const Volume * volume )

Definition at line 907 of file blenkernel/intern/volume.cc.

References BKE_volume_grid_get(), BKE_volume_num_grids(), and clamp_i().

Referenced by blender::draw::DRW_volume_batch_cache_get_selection_surface(), blender::draw::DRW_volume_batch_cache_get_wireframes_face(), and blender::workbench::VolumePass::object_sync_volume().

◆ BKE_volume_grid_add()

void BKE_volume_grid_add	(	Volume *	volume,
		const blender::bke::VolumeGridData &	grid )

Adds a new grid to the volume with the name stored in the grid. The caller is responsible for making sure that the user count already contains the volume as a user.

Definition at line 1011 of file blenkernel/intern/volume.cc.

References UNUSED_VARS.