#include "BLI_array.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_utildefines.h"
#include "intern/multires_inline.hh"

Namespaces
namespace	blender
namespace	blender::bke
namespace	blender::bke::subdiv

Enumerations
enum	MultiresModifiedFlags { MULTIRES_COORDS_MODIFIED = 1 , MULTIRES_HIDDEN_MODIFIED = 2 }
enum class	MultiresFlags : uint8_t { UseLocalMMD = 1 , UseRenderParams = 2 , AllocPaintMask = 4 , IgnoreSimplify = 8 }
enum class	ApplyBaseMode : int8_t { Base , ForSubdivision }
enum class	MultiresSubdivideModeType : int8_t { CatmullClark , Simple , Linear }

Functions
void	multires_customdata_delete (Mesh *mesh)
void	multires_set_tot_level (Object ob, MultiresModifierData mmd, int lvl)
void	multires_mark_as_modified (Depsgraph depsgraph, Object object, MultiresModifiedFlags flags)
void	multires_flush_sculpt_updates (Object *object)
void	multires_force_sculpt_rebuild (Object *object)
void	multires_force_external_reload (Object *object)
void	multiresModifier_set_levels_from_disps (MultiresModifierData mmd, Object ob)
	ENUM_OPERATORS (MultiresFlags, MultiresFlags::IgnoreSimplify)
MultiresModifierData *	find_multires_modifier_before (Scene scene, ModifierData lastmd)
MultiresModifierData *	get_multires_modifier (Scene scene, Object ob, bool use_first)
int	multires_get_level (const Scene scene, const Object ob, const MultiresModifierData *mmd, bool render, bool ignore_simplify)
Mesh *	BKE_multires_create_mesh (Depsgraph depsgraph, Object object, MultiresModifierData *mmd)
blender::Array< blender::float3 >	BKE_multires_create_deformed_base_mesh_vert_coords (Depsgraph depsgraph, Object object, MultiresModifierData *mmd)
void	multiresModifier_del_levels (MultiresModifierData mmd, Scene scene, Object *object, int direction)
void	multiresModifier_base_apply (Depsgraph depsgraph, Object object, MultiresModifierData *mmd, ApplyBaseMode mode)
int	multiresModifier_rebuild_subdiv (Depsgraph depsgraph, Object object, MultiresModifierData *mmd, int rebuild_limit, bool switch_view_to_lower_level)
void	multiresModifier_sync_levels_ex (Object ob_dst, const MultiresModifierData mmd_src, MultiresModifierData *mmd_dst)
void	multires_stitch_grids (Object *)
void	multiresModifier_scale_disp (Depsgraph depsgraph, Scene scene, Object *ob)
void	multiresModifier_prepare_join (Depsgraph depsgraph, Scene scene, Object ob, Object to_ob)
int	multires_mdisp_corners (const MDisps *s)
void	multires_topology_changed (Mesh *mesh)
void	multires_ensure_external_read (Mesh *mesh, int top_level)
void	multiresModifier_ensure_external_read (Mesh mesh, const MultiresModifierData mmd)
void	old_mdisps_bilinear (float out[3], float(*disps)[3], int st, float u, float v)
bool	multiresModifier_reshapeFromObject (Depsgraph depsgraph, MultiresModifierData mmd, Object dst, Object src)
bool	multiresModifier_reshapeFromDeformModifier (Depsgraph depsgraph, Object ob, MultiresModifierData mmd, ModifierData deform_md)
bool	multiresModifier_reshapeFromCCG (int tot_level, Mesh coarse_mesh, SubdivCCG subdiv_ccg)
void	multiresModifier_subdivide (Object object, MultiresModifierData mmd, MultiresSubdivideModeType mode)
void	multires_subdivide_create_tangent_displacement_linear_grids (Object object, MultiresModifierData mmd)
void	multiresModifier_subdivide_to_level (Object object, MultiresModifierData mmd, int top_level, MultiresSubdivideModeType mode)
void	BKE_multires_subdiv_settings_init (blender::bke::subdiv::Settings settings, const MultiresModifierData mmd)
void	BKE_multires_subdiv_mesh_settings_init (blender::bke::subdiv::ToMeshSettings mesh_settings, const Scene scene, const Object object, const MultiresModifierData mmd, bool use_render_params, bool ignore_simplify, bool ignore_control_edges)
BLI_INLINE void	BKE_multires_construct_tangent_matrix (blender::float3x3 &tangent_matrix, const blender::float3 &dPdu, const blender::float3 &dPdv, int corner)
void	multires_do_versions_simple_to_catmull_clark (Object object, MultiresModifierData mmd)

Enumeration Type Documentation

◆ ApplyBaseMode

enum class ApplyBaseMode : int8_t

strong

Enumerator
Base
ForSubdivision

Definition at line 94 of file BKE_multires.hh.

◆ MultiresFlags

enum class MultiresFlags : uint8_t

strong

Enumerator
UseLocalMMD
UseRenderParams
AllocPaintMask
IgnoreSimplify

Definition at line 54 of file BKE_multires.hh.

◆ MultiresModifiedFlags

enum MultiresModifiedFlags

Enumerator
MULTIRES_COORDS_MODIFIED
MULTIRES_HIDDEN_MODIFIED

Definition at line 28 of file BKE_multires.hh.

◆ MultiresSubdivideModeType

enum class MultiresSubdivideModeType : int8_t

strong

Enumerator
CatmullClark
Simple
Linear

Definition at line 162 of file BKE_multires.hh.

Function Documentation

◆ BKE_multires_construct_tangent_matrix()

BLI_INLINE void BKE_multires_construct_tangent_matrix	(	blender::float3x3 &	tangent_matrix,
		const blender::float3 &	dPdu,
		const blender::float3 &	dPdv,
		int	corner )

For a given partial derivatives of a PTEX face get tangent matrix for displacement.

Corner needs to be known to properly "rotate" partial derivatives when the matrix is being constructed for quad. For non-quad the corner is to be set to 0.

Definition at line 16 of file multires_inline.hh.

References BLI_assert_msg, BLI_INLINE, blender::math::cross(), blender::math::normalize(), blender::MatBase< T, NumCol, NumRow, Alignment >::x_axis(), blender::MatBase< T, NumCol, NumRow, Alignment >::y_axis(), and blender::MatBase< T, NumCol, NumRow, Alignment >::z_axis().

Referenced by blender::bke::subdiv::average_construct_tangent_matrix(), blender::bke::subdiv::eval_displacement(), and multires_reshape_tangent_matrix_for_corner().

◆ BKE_multires_create_deformed_base_mesh_vert_coords()

blender::Array< blender::float3 > BKE_multires_create_deformed_base_mesh_vert_coords	(	Depsgraph *	depsgraph,
		Object *	object,
		MultiresModifierData *	mmd )

Get coordinates of a deformed base mesh which is an input to the given multi-res modifier.

Note: The modifiers will be re-evaluated.

Definition at line 119 of file multires.cc.

References BKE_modifier_deform_verts(), BKE_modifier_get_info(), BKE_modifier_is_enabled(), BKE_modifiers_get_virtual_modifierlist(), DAG_EVAL_RENDER, Object::data, DEG_get_evaluated(), DEG_get_evaluated_scene(), DEG_get_mode(), depsgraph, eModifierMode_Realtime, eModifierMode_Render, ModifierEvalContext::flag, MOD_APPLY_RENDER, MultiresModifierData::modifier, ModifierData::next, OnlyDeform, Object::runtime, Object::sculpt, and ModifierTypeInfo::type.

Referenced by multires_reshape_apply_base_refine_from_deform(), and blender::ed::sculpt_paint::undo::refine_subdiv().

◆ BKE_multires_create_mesh()

Mesh * BKE_multires_create_mesh	(	Depsgraph *	depsgraph,
		Object *	object,
		MultiresModifierData *	mmd )

Creates mesh with multi-res modifier applied on current object's deform mesh.

Definition at line 99 of file multires.cc.

References BKE_mesh_copy_for_eval(), BKE_modifier_get_info(), CD_MASK_BAREMESH, DEG_get_evaluated(), DEG_get_evaluated_scene(), depsgraph, ModifierEvalContext::depsgraph, ModifierEvalContext::flag, blender::bke::mesh_get_eval_deform(), MOD_APPLY_IGNORE_SIMPLIFY, MOD_APPLY_USECACHE, MultiresModifierData::modifier, ModifierTypeInfo::modify_mesh, ModifierEvalContext::object, result, and ModifierData::type.

Referenced by multiresModifier_reshapeFromDeformModifier().

◆ BKE_multires_subdiv_mesh_settings_init()

void BKE_multires_subdiv_mesh_settings_init	(	blender::bke::subdiv::ToMeshSettings *	mesh_settings,
		const Scene *	scene,
		const Object *	object,
		const MultiresModifierData *	mmd,
		bool	use_render_params,
		bool	ignore_simplify,
		bool	ignore_control_edges )

Definition at line 27 of file multires_subdiv.cc.

References eMultiresModifierFlag_ControlEdges, MultiresModifierData::flags, multires_get_level(), blender::bke::subdiv::ToMeshSettings::resolution, and blender::bke::subdiv::ToMeshSettings::use_optimal_display.

Referenced by multires_as_mesh().

◆ BKE_multires_subdiv_settings_init()

void BKE_multires_subdiv_settings_init	(	blender::bke::subdiv::Settings *	settings,
		const MultiresModifierData *	mmd )

Definition at line 14 of file multires_subdiv.cc.

Referenced by deform_matrices(), modify_mesh(), and multires_reshape_create_subdiv().

◆ ENUM_OPERATORS()

ENUM_OPERATORS	(	MultiresFlags	,
		MultiresFlags::IgnoreSimplify	)

References depsgraph, and IgnoreSimplify.

◆ find_multires_modifier_before()

MultiresModifierData * find_multires_modifier_before	(	Scene *	scene,
		ModifierData *	lastmd )

Definition at line 164 of file multires.cc.

References BKE_modifier_is_enabled(), eModifierMode_Realtime, eModifierType_Multires, and ModifierData::prev.

Referenced by blender::ed::object::modifier_apply(), blender::ed::object::modifier_apply_obdata(), and blender::ed::object::modifier_apply_poll().

◆ get_multires_modifier()

MultiresModifierData * get_multires_modifier	(	Scene *	scene,
		Object *	ob,
		bool	use_first )

used for applying scale on mdisps layer and syncing subdivide levels when joining objects.

Parameters

use_first return first multi-res modifier if all multi-res'es are disabled.

Definition at line 178 of file multires.cc.

References BKE_modifier_is_enabled(), eModifierMode_Realtime, eModifierType_Multires, LISTBASE_FOREACH, and Object::modifiers.

Referenced by BKE_sculpt_get_first_deform_matrices(), blender::ed::object::init_multiresbake_job(), blender::ed::mesh::join_objects_exec(), multires_apply_smat(), multires_sync_levels(), blender::ed::object::multiresbake_check(), and blender::ed::object::multiresbake_image_exec_locked().

◆ multires_customdata_delete()

void multires_customdata_delete ( Mesh * mesh )

Delete mesh mdisps and grid paint masks.

Custom-data.

Definition at line 53 of file multires.cc.

References BM_data_layer_free(), CD_GRID_PAINT_MASK, CD_MDISPS, Mesh::corner_data, Mesh::corners_num, CustomData_external_remove(), CustomData_free_layer_active(), CustomData_has_layer(), Mesh::id, and Mesh::runtime.

Referenced by blender::ed::object::modifier_apply_obdata(), multires_del_higher(), multires_sync_levels(), and blender::ed::object::object_modifier_remove().

◆ multires_do_versions_simple_to_catmull_clark()

void multires_do_versions_simple_to_catmull_clark	(	Object *	object,
		MultiresModifierData *	mmd )

Convert displacement which is stored for simply-subdivided mesh to a Catmull-Clark subdivided mesh.

Definition at line 61 of file multires_versioning.cc.

References Mesh::corners_num, blender::bke::subdiv::free(), multires_reshape_assign_final_coords_from_mdisps(), multires_reshape_context_create_from_modifier(), multires_reshape_context_create_from_subdiv(), multires_reshape_context_free(), multires_reshape_object_grids_to_tangent_displacement(), multires_reshape_store_original_grids(), MultiresModifierData::totlvl, and UNUSED_VARS.

Referenced by do_versions_after_linking_290().

◆ multires_ensure_external_read()

void multires_ensure_external_read	(	Mesh *	mesh,
		int	top_level )

Makes sure data from an external file is fully read.

Since the multi-res data files only contain displacement vectors without knowledge about subdivision level some extra work is needed. Namely make is to all displacement grids have proper level and number of displacement vectors set.

Definition at line 766 of file multires.cc.

References CD_MASK_MDISPS, CD_MDISPS, CD_SET_DEFAULT, Mesh::corner_data, Mesh::corners_num, CustomData_add_layer(), CustomData_external_read(), CustomData_external_test(), CustomData_get_layer(), i, Mesh::id, MDisps::level, MEM_SAFE_FREE, multires_grid_tot, and MDisps::totdisp.

Referenced by multiresModifier_ensure_external_read(), and multiresModifier_reshapeFromCCG().

◆ multires_flush_sculpt_updates()

void multires_flush_sculpt_updates ( Object * object )

Definition at line 270 of file multires.cc.

References SculptSession::active, BKE_modifier_is_enabled(), BKE_modifiers_get_virtual_modifierlist(), SubdivCCG::coords, SubdivCCG::dirty, eModifierMode_Realtime, eModifierType_Multires, blender::bke::pbvh::Grids, SubdivCCG::hidden, SculptSession::modifier, SculptSession::multires, multiresModifier_reshapeFromCCG(), ModifierData::next, blender::bke::object::pbvh_get(), Object::sculpt, SculptSession::subdiv_ccg, MultiresModifierData::totlvl, and blender::bke::pbvh::Tree::type().

Referenced by ED_editors_flush_edits_for_object_ex(), blender::ed::object::init_multiresbake_job(), multires_force_sculpt_rebuild(), blender::ed::object::multiresbake_image_exec_locked(), multiresModifier_subdivide_to_level(), blender::ed::sculpt_paint::object_sculpt_mode_exit(), and blender::ed::sculpt_paint::undo::push_multires_mesh_begin().

◆ multires_force_external_reload()

void multires_force_external_reload ( Object * object )

Definition at line 339 of file multires.cc.

References BKE_mesh_from_object(), CD_MASK_MDISPS, Mesh::corner_data, Mesh::corners_num, CustomData_external_reload(), Mesh::id, and multires_force_sculpt_rebuild().

◆ multires_force_sculpt_rebuild()

void multires_force_sculpt_rebuild ( Object * object )

Definition at line 327 of file multires.cc.

References BKE_sculptsession_free_pbvh(), multires_flush_sculpt_updates(), and Object::sculpt.

Referenced by BKE_mesh_assign_object(), libblock_remap_data_postprocess_obdata_relink(), blender::ed::object::modifier_apply_obdata(), multires_del_higher(), multires_force_external_reload(), multires_subdivide_create_tangent_displacement_linear_grids(), multiresModifier_base_apply(), multiresModifier_del_levels(), and multiresModifier_rebuild_subdiv().

◆ multires_get_level()

int multires_get_level	(	const Scene *	scene,
		const Object *	ob,
		const MultiresModifierData *	mmd,
		bool	render,
		bool	ignore_simplify )

Definition at line 205 of file multires.cc.

References get_render_subsurf_level(), MultiresModifierData::lvl, Object::mode, OB_MODE_SCULPT, Scene::r, MultiresModifierData::renderlvl, and MultiresModifierData::sculptlvl.

Referenced by BKE_multires_subdiv_mesh_settings_init(), multires_ccg_settings_init(), multires_reshape_context_create_from_base_mesh(), multires_reshape_context_create_from_object(), and multiresModifier_del_levels().

◆ multires_mark_as_modified()

void multires_mark_as_modified	(	Depsgraph *	depsgraph,
		Object *	object,
		MultiresModifiedFlags	flags )

Definition at line 247 of file multires.cc.

References Object::data, DEG_get_evaluated(), depsgraph, multires_ccg_mark_as_modified(), and Mesh::runtime.

Referenced by blender::ed::sculpt_paint::flush_update_step(), blender::ed::sculpt_paint::mask::gesture_end(), blender::ed::sculpt_paint::hide::grid_hide_update(), blender::ed::sculpt_paint::hide::grids_show_all(), blender::ed::sculpt_paint::hide::grow_shrink_visibility_grid(), blender::ed::sculpt_paint::mask::invert_mask_grids(), blender::ed::sculpt_paint::hide::invert_visibility_grids(), and blender::ed::sculpt_paint::undo::restore_list().

◆ multires_mdisp_corners()

int multires_mdisp_corners ( const MDisps * s )

Definition at line 693 of file multires.cc.

References MDisps::totdisp.

Referenced by bm_corners_to_loops_ex(), and layerSwap_mdisps().

◆ multires_set_tot_level()

void multires_set_tot_level	(	Object *	ob,
		MultiresModifierData *	mmd,
		int	lvl )

Definition at line 225 of file multires.cc.

References MultiresModifierData::lvl, Object::mode, OB_MODE_SCULPT, MultiresModifierData::renderlvl, MultiresModifierData::sculptlvl, and MultiresModifierData::totlvl.

Referenced by multires_del_higher(), multires_subdivide_create_tangent_displacement_linear_grids(), blender::ed::object::multires_update_totlevels(), multiresModifier_del_levels(), and multiresModifier_subdivide_to_level().

◆ multires_stitch_grids()

void multires_stitch_grids ( Object * ob )

Definition at line 549 of file multires.cc.

References BKE_subdiv_ccg_average_stitch_faces(), BLI_assert, SubdivCCG::faces, blender::bke::pbvh::Grids, blender::bke::object::pbvh_get(), Object::sculpt, and SculptSession::subdiv_ccg.

Referenced by blender::ed::sculpt_paint::sculpt_fix_noise_tear().

◆ multires_subdivide_create_tangent_displacement_linear_grids()

void multires_subdivide_create_tangent_displacement_linear_grids	(	Object *	object,
		MultiresModifierData *	mmd )

Definition at line 56 of file multires_reshape_subdivide.cc.

References CD_MDISPS, CD_SET_DEFAULT, Mesh::corner_data, Mesh::corners_num, CustomData_add_layer(), CustomData_has_layer(), multires_force_sculpt_rebuild(), multires_reshape_context_create_from_modifier(), multires_reshape_context_free(), multires_reshape_ensure_grids(), multires_reshape_object_grids_to_tangent_displacement(), multires_set_tot_level(), multires_subdivide_create_object_space_linear_grids(), and MultiresModifierData::totlvl.

Referenced by multiresModifier_subdivide_to_level().

◆ multires_topology_changed()

void multires_topology_changed ( Mesh * mesh )

Update multi-res data after topology changing.

Definition at line 732 of file multires.cc.

References CD_MASK_MDISPS, CD_MDISPS, Mesh::corner_data, Mesh::corners_num, CustomData_external_read(), CustomData_get_layer_for_write(), MDisps::disps, i, Mesh::id, MEM_calloc_arrayN(), and MDisps::totdisp.

◆ multiresModifier_base_apply()

void multiresModifier_base_apply	(	Depsgraph *	depsgraph,
		Object *	object,
		MultiresModifierData *	mmd,
		ApplyBaseMode	mode )

Definition at line 228 of file multires_reshape.cc.

References depsgraph, ForSubdivision, multires_force_sculpt_rebuild(), multires_reshape_apply_base_refine_from_base(), multires_reshape_apply_base_refine_from_deform(), multires_reshape_apply_base_refit_base_mesh(), multires_reshape_apply_base_update_mesh_coords(), multires_reshape_assign_final_coords_from_mdisps(), multires_reshape_context_create_from_object(), multires_reshape_context_free(), multires_reshape_object_grids_to_tangent_displacement(), and multires_reshape_store_original_grids().

Referenced by blender::ed::object::multires_base_apply_exec().

◆ multiresModifier_del_levels()

void multiresModifier_del_levels	(	MultiresModifierData *	mmd,
		Scene *	scene,
		Object *	object,
		int	direction )

Parameters

direction 1 for delete higher, 0 for lower (not implemented yet).

Definition at line 526 of file multires.cc.

References BKE_mesh_from_object(), CD_MDISPS, Mesh::corner_data, Mesh::corners_num, CustomData_get_layer_for_write(), multires_del_higher(), multires_force_sculpt_rebuild(), multires_get_level(), multires_set_tot_level(), multires_set_tot_mdisps(), multiresModifier_ensure_external_read(), and MultiresModifierData::totlvl.

Referenced by blender::ed::object::multires_higher_levels_delete_exec().

◆ multiresModifier_ensure_external_read()

void multiresModifier_ensure_external_read	(	Mesh *	mesh,
		const MultiresModifierData *	mmd )

Definition at line 798 of file multires.cc.

References multires_ensure_external_read(), and MultiresModifierData::totlvl.

Referenced by blender::bke::subdiv::initialize(), multires_apply_smat(), multires_del_higher(), and multiresModifier_del_levels().

◆ multiresModifier_prepare_join()

void multiresModifier_prepare_join	(	Depsgraph *	depsgraph,
		Scene *	scene,
		Object *	ob,
		Object *	to_ob )

Definition at line 718 of file multires.cc.

References BKE_object_scale_to_mat3(), depsgraph, invert_m3(), mul_m3_m3m3(), multires_apply_smat(), and multires_sync_levels().

Referenced by blender::ed::mesh::join_objects_exec().

◆ multiresModifier_rebuild_subdiv()

int multiresModifier_rebuild_subdiv	(	Depsgraph *	depsgraph,
		Object *	object,
		MultiresModifierData *	mmd,
		int	rebuild_limit,
		bool	switch_view_to_lower_level )