blender::index_mask::IndexMask Class Reference

#include <BLI_index_mask.hh>

Inherits blender::index_mask::IndexMaskData.

Public Types
using	Initializer = std::variant<IndexRange, Span<int64_t>, Span<int>, int64_t>

Public Member Functions
std::optional< RawMaskIterator >	find (int64_t query_index) const
std::optional< RawMaskIterator >	find_larger_equal (int64_t query_index) const
std::optional< RawMaskIterator >	find_smaller_equal (int64_t query_index) const
bool	contains (int64_t query_index) const
IndexMask	slice (int64_t start, int64_t size) const
IndexMask	slice (RawMaskIterator first_it, RawMaskIterator last_it, int64_t size) const
IndexMask	slice_content (IndexRange range) const
IndexMask	slice_content (int64_t start, int64_t size) const
IndexMask	slice_and_shift (IndexRange range, int64_t offset, IndexMaskMemory &memory) const
IndexMask	slice_and_shift (int64_t start, int64_t size, int64_t offset, IndexMaskMemory &memory) const
IndexMask	shift (const int64_t offset, IndexMaskMemory &memory) const
IndexMask	complement (const IndexMask &universe, IndexMaskMemory &memory) const
template<typename T >
void	to_indices (MutableSpan< T > r_indices) const
void	set_bits (MutableBitSpan r_bits, int64_t offset=0) const
void	to_bits (MutableBitSpan r_bits, int64_t offset=0) const
void	to_bools (MutableSpan< bool > r_bools) const
Vector< IndexRange >	to_ranges () const
Vector< IndexRange >	to_ranges_invert (IndexRange universe) const

Static Public Member Functions
template<typename T >
static IndexMask	from_indices (Span< T > indices, IndexMaskMemory &memory)
static IndexMask	from_bits (BitSpan bits, IndexMaskMemory &memory)
static IndexMask	from_bits (const IndexMask &universe, BitSpan bits, IndexMaskMemory &memory)
static IndexMask	from_bools (Span< bool > bools, IndexMaskMemory &memory)
static IndexMask	from_bools (const VArray< bool > &bools, IndexMaskMemory &memory)
static IndexMask	from_bools (const IndexMask &universe, Span< bool > bools, IndexMaskMemory &memory)
static IndexMask	from_bools_inverse (const IndexMask &universe, Span< bool > bools, IndexMaskMemory &memory)
static IndexMask	from_bools (const IndexMask &universe, const VArray< bool > &bools, IndexMaskMemory &memory)
static IndexMask	from_repeating (const IndexMask &mask_to_repeat, int64_t repetitions, int64_t stride, int64_t initial_offset, IndexMaskMemory &memory)
static IndexMask	from_every_nth (int64_t n, int64_t indices_num, const int64_t initial_offset, IndexMaskMemory &memory)
static IndexMask	from_segments (Span< IndexMaskSegment > segments, IndexMaskMemory &memory)
static IndexMask	from_initializers (const Span< Initializer > initializers, IndexMaskMemory &memory)
static IndexMask	from_union (const IndexMask &mask_a, const IndexMask &mask_b, IndexMaskMemory &memory)
static IndexMask	from_difference (const IndexMask &mask_a, const IndexMask &mask_b, IndexMaskMemory &memory)
static IndexMask	from_intersection (const IndexMask &mask_a, const IndexMask &mask_b, IndexMaskMemory &memory)
static IndexMask	from_batch_predicate (const IndexMask &universe, GrainSize grain_size, IndexMaskMemory &memory, FunctionRef< int64_t(const IndexMaskSegment &universe_segment, IndexRangesBuilder< int16_t > &builder)> batch_predicate)
static Vector< IndexMask, 4 >	from_group_ids (const VArray< int > &group_ids, IndexMaskMemory &memory, VectorSet< int > &r_index_by_group_id)
static Vector< IndexMask, 4 >	from_group_ids (const IndexMask &universe, const VArray< int > &group_ids, IndexMaskMemory &memory, VectorSet< int > &r_index_by_group_id)
static void	foreach_segment_zipped (Span< IndexMask > masks, FunctionRef< bool(Span< IndexMaskSegment > segments)> fn)

Friends
bool	operator== (const IndexMask &a, const IndexMask &b)
bool	operator!= (const IndexMask &a, const IndexMask &b)

#IndexMask Inline Methods
	IndexMask ()
	IndexMask (int64_t size)
	IndexMask (IndexRange range)
int64_t	size () const
bool	is_empty () const
IndexRange	index_range () const
int64_t	first () const
int64_t	last () const
IndexRange	bounds () const
int64_t	min_array_size () const
RawMaskIterator	index_to_iterator (int64_t index) const
int64_t	iterator_to_index (const RawMaskIterator &it) const
int64_t	operator[] (int64_t i) const
int64_t	operator[] (const RawMaskIterator &it) const
IndexMask	slice (IndexRange range) const
int64_t	segments_num () const
IndexMaskSegment	segment (int64_t segment_i) const
template<typename Fn >
void	foreach_index (Fn &&fn) const
template<typename Fn >
void	foreach_index (GrainSize grain_size, Fn &&fn) const
template<typename IndexT , typename Fn >
void	foreach_index_optimized (Fn &&fn) const
template<typename IndexT , typename Fn >
void	foreach_index_optimized (GrainSize grain_size, Fn &&fn) const
template<typename Fn >
void	foreach_segment (Fn &&fn) const
template<typename Fn >
void	foreach_segment (GrainSize grain_size, Fn &&fn) const
template<typename Fn >
void	foreach_segment_optimized (Fn &&fn) const
template<typename Fn >
void	foreach_segment_optimized (GrainSize grain_size, Fn &&fn) const
template<typename Fn >
void	foreach_range (Fn &&fn) const
std::optional< IndexRange >	to_range () const
template<int64_t N = 4>
Vector< std::variant< IndexRange, IndexMaskSegment >, N >	to_spans_and_ranges () const
IndexMaskData &	data_for_inplace_construction ()
template<typename Fn >
static IndexMask	from_predicate (const IndexMask &universe, GrainSize grain_size, IndexMaskMemory &memory, Fn &&predicate)
template<typename T , typename Fn >
static void	from_groups (const IndexMask &universe, IndexMaskMemory &memory, Fn &&get_group_index, MutableSpan< IndexMask > r_masks)

Detailed Description

An IndexMask is a sequence of unique and sorted indices (BLI_unique_sorted_indices.hh). It's commonly used when a subset of elements in an array has to be processed.

IndexMask is a non-owning container. That data it references is usually either statically allocated or is owned by an #IndexMaskMemory.

Internally, an index mask is split into an arbitrary number of ordered segments. Each segment contains up to max_segment_size (2^14 = 16384) indices. The indices in a segment are stored as int16_t, but each segment also has a int64_t offset.

The data structure is designed to satisfy the following key requirements:

• Construct index mask for an #IndexRange in O(1) time (after initial setup).
• Support efficient slicing (O(log n) with a low constant factor).
• Support multi-threaded construction without severe serial bottlenecks.
• Support efficient iteration over indices that uses #IndexRange when possible.

Construction: A new index mask is usually created by calling one of its constructors which are O(1), or for more complex masks, by calling various IndexMask::from_* functions that create masks from various sources. Those generally need additional memory which is provided with by an #IndexMaskMemory.

Some of the IndexMask::from_* functions have an IndexMask universe input. When provided, the function will only consider the indices in the "universe". The term comes from mathematics: https://en.wikipedia.org/wiki/Universe_(mathematics).

Iteration: To iterate over the indices, one usually has to use one of the foreach_* functions which require a callback function. Due to the internal segmentation of the index mask, this is more efficient than using a normal C++ iterator and range-based for loops.

There are multiple variants of the foreach_* functions which are useful in different scenarios. The callback can generally take one or two arguments. The first is the index stored in the mask and the second is the index that would have to be passed into operator[] to get the first index.

The foreach_* methods also accept an optional GrainSize argument. When that is provided, multi-threading is used when appropriate. Integrating multi-threading at this level works well because mask iteration and parallelism are often used at the same time.

Extraction: An IndexMask can be converted into various other forms using the to_* methods.

Definition at line 184 of file BLI_index_mask.hh.

Member Typedef Documentation

Initializer

using blender::index_mask::IndexMask::Initializer = std::variant<IndexRange, Span<int64_t>, Span<int>, int64_t>

Construct a mask from some parts. This is mainly meant for more concise testing code. The individual items are unioned together.

Definition at line 238 of file BLI_index_mask.hh.

Constructor & Destructor Documentation

IndexMask() [1/3]

blender::index_mask::IndexMask::IndexMask ( )

inline

Construct an empty mask.

Definition at line 638 of file BLI_index_mask.hh.

References blender::index_mask::init_empty_mask().

Referenced by from_bools(), and from_group_ids().

IndexMask() [2/3]

blender::index_mask::IndexMask::IndexMask ( int64_t size )

inlineexplicit

Construct a mask that contains the indices from 0 to size - 1. This takes O(1) time.

Definition at line 643 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, blender::index_mask::IndexMaskData::end_index_in_segment_, blender::index_mask::get_static_index_mask_for_min_size(), blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::init_empty_mask(), blender::index_mask::max_segment_size, blender::index_mask::max_segment_size_mask_high, blender::index_mask::max_segment_size_shift, blender::index_mask::IndexMaskData::segments_num_, and size().

IndexMask() [3/3]

blender::index_mask::IndexMask::IndexMask ( IndexRange range )

inline

Construct a mask that contains the indices in the range. This takes O(1) time.

Definition at line 656 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, blender::index_mask::IndexMaskData::cumulative_segment_sizes_, blender::index_mask::IndexMaskData::end_index_in_segment_, blender::index_mask::get_static_index_mask_for_min_size(), blender::index_mask::IndexMaskData::indices_by_segment_, blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::init_empty_mask(), blender::index_mask::max_segment_size_mask_high, blender::index_mask::max_segment_size_mask_low, blender::index_mask::max_segment_size_shift, blender::index_mask::IndexMaskData::segment_offsets_, and blender::index_mask::IndexMaskData::segments_num_.

Member Function Documentation

bounds()

IndexRange blender::index_mask::IndexMask::bounds ( ) const

inline

Returns the smallest range that contains all indices stored in this mask.

Definition at line 692 of file BLI_index_mask.hh.

References first(), blender::IndexRange::from_begin_end_inclusive(), is_empty(), and last().

Referenced by from_repeating().

complement()

IndexMask blender::index_mask::IndexMask::complement	(	const IndexMask &	universe,
		IndexMaskMemory &	memory ) const

Returns

A new index mask that contains all the indices from the universe that are not in the current mask.

Definition at line 401 of file index_mask.cc.

References blender::index_mask::evaluate_expression(), and blender::index_mask::ExprBuilder::subtract().

Referenced by blender::geometry::convert_curves_to_bezier(), blender::geometry::convert_curves_to_catmull_rom_or_poly(), blender::geometry::convert_curves_to_nurbs(), blender::nodes::node_geo_curves_to_grease_pencil_cc::curves_to_grease_pencil_with_one_layer(), blender::draw::DRW_curves_batch_cache_create_requested(), blender::draw::extract_lines_bm(), blender::draw::extract_lines_mesh(), blender::geometry::fillet_curves(), blender::generate_curves(), blender::ed::greasepencil::get_reordered_indices(), blender::nodes::LazyFunctionForReduceForeachGeometryElement::handle_main_items_and_geometry(), blender::geometry::propagate_instances_to_keep(), blender::bke::CurvesGeometry::remove_curves(), blender::bke::CurvesGeometry::remove_points(), blender::geometry::resample_to_count(), blender::geometry::resample_to_evaluated(), blender::geometry::resample_to_length(), blender::geometry::resample_to_uniform(), blender::geometry::resample_to_uniform(), blender::ed::curves::resize_curves(), blender::ed::sculpt_paint::select_grow::select_grow_invoke_per_curve(), blender::ed::curves::select_random_exec(), blender::nodes::node_geo_sort_elements_cc::sorted_indices(), blender::geometry::split_edges(), blender::geometry::subdivide_curves(), blender::bke::greasepencil::Drawing::tag_topology_changed(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), to_ranges_invert(), and blender::geometry::trim_curves().

contains()

bool blender::index_mask::IndexMask::contains

(

int64_t

query_index

)

const

Returns

True when the #query_index is stored in the mask.

Definition at line 895 of file index_mask.cc.

References find().

Referenced by blender::draw::grease_pencil_geom_batch_ensure(), blender::draw::grease_pencil_get_visible_nurbs_points(), blender::ed::greasepencil::retrieve_editable_fill_strokes(), and blender::index_mask::tests::TEST().

data_for_inplace_construction()

IndexMaskData & blender::index_mask::IndexMask::data_for_inplace_construction ( )

inline

Is used by some functions to get low level access to the mask in order to construct it.

Definition at line 785 of file BLI_index_mask.hh.

Referenced by blender::index_mask::IndexMaskFromSegment::IndexMaskFromSegment(), and blender::index_mask::IndexMaskFromSegment::update().

find()

std::optional< RawMaskIterator > blender::index_mask::IndexMask::find

(

int64_t

query_index

)

const

Returns

Position where the #query_index is stored, or none if the index is not in the mask.

Definition at line 827 of file index_mask.cc.

References find_larger_equal().

Referenced by contains().

find_larger_equal()

std::optional< RawMaskIterator > blender::index_mask::IndexMask::find_larger_equal

(

int64_t

query_index

)

const

Definition at line 837 of file index_mask.cc.

References BLI_assert, blender::binary_search::find_predicate_begin(), blender::index_mask::IndexMaskData::indices_by_segment_, blender::OffsetSpan< T, BaseT >::last(), blender::index_mask::max_segment_size, segment(), and blender::index_mask::IndexMaskData::segments_num_.

Referenced by find(), find_smaller_equal(), and slice_content().

find_smaller_equal()

std::optional< RawMaskIterator > blender::index_mask::IndexMask::find_smaller_equal

(

int64_t

query_index

)

const

Definition at line 863 of file index_mask.cc.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, blender::index_mask::IndexMaskData::cumulative_segment_sizes_, blender::index_mask::IndexMaskData::end_index_in_segment_, find_larger_equal(), blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::RawMaskIterator::segment_i, and blender::index_mask::IndexMaskData::segments_num_.

Referenced by slice_content().

first()

int64_t blender::index_mask::IndexMask::first ( ) const

inline

Definition at line 702 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, BLI_assert, blender::index_mask::IndexMaskData::indices_by_segment_, blender::index_mask::IndexMaskData::indices_num_, and blender::index_mask::IndexMaskData::segment_offsets_.

Referenced by bounds(), blender::ed::greasepencil::grease_pencil_set_active_material_exec(), shift(), and to_range().

foreach_index() [1/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_index ( Fn && fn ) const

inline

Calls the function once for every index.

Supported function signatures:

• (int64_t i)
• (int64_t i, int64_t pos)

i is the index that should be processed and pos is the position of that index in the mask: i == mask[pos]

Definition at line 795 of file BLI_index_mask.hh.

References foreach_segment(), and indices.

Referenced by blender::ed::greasepencil::apply_color_operation_for_mode(), blender::ed::object::apply_eval_grease_pencil_data(), blender::ed::greasepencil::apply_mask_as_selection(), blender::ed::sculpt_paint::mask::apply_mask_from_settings(), blender::ed::sculpt_paint::mask::apply_new_mask_bmesh(), blender::ed::sculpt_paint::mask::apply_new_mask_grids(), blender::ed::sculpt_paint::mask::apply_new_mask_mesh(), BKE_bvhtree_from_mesh_edges_init(), BKE_bvhtree_from_mesh_tris_init(), BKE_bvhtree_from_mesh_verts_init(), BKE_bvhtree_from_pointcloud_get(), blender::ed::sculpt_paint::smooth::blur_geometry_data_array(), blender::bke::pbvh::bmesh_normals_update(), blender::ed::greasepencil::build_curves_2d_bvh_from_visible(), blender::geometry::calc_all_corner_groups(), blender::ed::sculpt_paint::cloth::calc_constraint_factors(), blender::draw::calc_edit_handles_ibo(), blender::ed::sculpt_paint::filter::calc_enhance_details_filter(), blender::ed::sculpt_paint::filter::calc_erase_displacement_filter(), blender::ed::sculpt_paint::filter::calc_inflate_filter(), blender::geometry::calc_new_edges(), blender::bke::pbvh::calc_node_face_normals(), blender::bke::pbvh::calc_node_vert_normals(), blender::ed::sculpt_paint::filter::calc_random_filter(), blender::ed::sculpt_paint::filter::calc_relax_face_sets_filter(), blender::ed::sculpt_paint::filter::calc_relax_filter(), blender::ed::sculpt_paint::filter::calc_scale_filter(), blender::ed::sculpt_paint::filter::calc_sharpen_filter(), blender::ed::sculpt_paint::filter::calc_smooth_filter(), blender::ed::sculpt_paint::calc_smooth_translations(), blender::ed::sculpt_paint::filter::calc_sphere_filter(), blender::ed::sculpt_paint::filter::calc_surface_smooth_filter(), blender::ed::sculpt_paint::expand::calc_topology_falloff_from_verts(), blender::ed::sculpt_paint::islands::calc_topology_islands_bmesh(), blender::ed::sculpt_paint::islands::calc_topology_islands_mesh(), blender::ed::sculpt_paint::face_set::clear_face_sets(), blender::ed::sculpt_paint::cloth::cloth_brush_apply_brush_foces(), blender::ed::sculpt_paint::cloth::cloth_sim_initialize_default_node_state(), blender::ed::sculpt_paint::paint::image::collect_dirty_tiles(), blender::io::grease_pencil::compute_drawing_bounds(), blender::create_dashes(), blender::create_envelope_strokes(), blender::ed::sculpt_paint::create_node_vert_offsets(), blender::ed::sculpt_paint::create_node_vert_offsets(), blender::ed::sculpt_paint::create_node_vert_offsets_bmesh(), blender::nodes::node_geo_curves_to_grease_pencil_cc::curve_instances_to_grease_pencil_layers(), blender::bke::curves_copy_point_selection(), blender::deform_drawing(), blender::deform_drawing(), blender::deform_drawing_as_envelope(), blender::ed::sculpt_paint::boundary::do_bend_brush(), blender::ed::sculpt_paint::do_bmesh_topology_rake_brush(), blender::ed::sculpt_paint::do_clay_brush(), blender::ed::sculpt_paint::do_clay_strips_brush(), blender::ed::sculpt_paint::do_clay_thumb_brush(), blender::ed::sculpt_paint::do_displacement_eraser_brush(), blender::ed::sculpt_paint::do_displacement_smear_brush(), blender::ed::sculpt_paint::do_draw_vector_displacement_brush(), blender::ed::sculpt_paint::do_elastic_deform_brush(), blender::ed::sculpt_paint::do_enhance_details_brush(), blender::ed::sculpt_paint::boundary::do_grab_brush(), blender::ed::sculpt_paint::do_grab_brush(), blender::ed::sculpt_paint::boundary::do_inflate_brush(), blender::ed::sculpt_paint::do_inflate_brush(), blender::ed::sculpt_paint::do_layer_brush(), blender::ed::sculpt_paint::do_mask_brush(), blender::ed::sculpt_paint::do_multiplane_scrape_brush(), blender::ed::sculpt_paint::color::do_paint_brush(), blender::ed::sculpt_paint::do_pinch_brush(), blender::ed::sculpt_paint::pose::do_pose_brush(), blender::ed::sculpt_paint::do_rotate_brush(), blender::ed::sculpt_paint::boundary::do_slide_brush(), blender::ed::sculpt_paint::boundary::do_smooth_brush(), blender::ed::sculpt_paint::do_smooth_brush(), blender::ed::sculpt_paint::do_smooth_mask_brush(), blender::ed::sculpt_paint::do_snake_hook_brush(), blender::ed::sculpt_paint::do_thumb_brush(), blender::ed::sculpt_paint::do_topology_slide_brush(), blender::ed::sculpt_paint::boundary::do_twist_brush(), do_vpaint_brush_blur_loops(), do_vpaint_brush_blur_verts(), do_vpaint_brush_smear(), blender::draw::overlay::GreasePencil::draw_grease_pencil(), blender::ed::greasepencil::image_render::draw_grease_pencil_strokes(), draw_pbvh_nodes(), blender::geometry::duplicate_fillet_point_data(), blender::ed::sculpt_paint::dynamic_topology_update(), blender::nodes::node_geo_edge_paths_to_curves_cc::edge_paths_to_curves_convert(), blender::nodes::node_geo_edge_paths_to_selection_cc::edge_paths_to_selection(), blender::nodes::node_geo_scale_elements_cc::edge_to_vert_islands(), blender::ed::sculpt_paint::face_set::edit_fairing(), blender::ed::curves::end_points(), blender::draw::pbvh::DrawCacheImpl::ensure_lines_batches(), blender::draw::pbvh::DrawCacheImpl::ensure_tris_batches(), blender::draw::pbvh::ensure_vbos_allocated_bmesh(), blender::draw::pbvh::ensure_vbos_allocated_grids(), blender::draw::pbvh::ensure_vbos_allocated_mesh(), blender::bke::CurvesGeometry::evaluated_tangents(), blender::ed::sculpt_paint::DeleteOperationExecutor::execute(), blender::ed::sculpt_paint::DensitySubtractOperationExecutor::execute(), blender::ed::sculpt_paint::ScaleCurvesEffect::execute(), blender::draw::extract_edituv_lines_mesh(), blender::draw::extract_lines_bm(), blender::draw::extract_points_bm(), blender::ed::greasepencil::extrude_grease_pencil_curves(), blender::nodes::node_geo_extrude_mesh_cc::extrude_individual_mesh_faces(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_face_regions(), blender::ed::sculpt_paint::face_set::face_hide_update(), blender::ed::sculpt_paint::face_set::face_sets_update(), blender::nodes::node_geo_scale_elements_cc::face_to_vert_islands(), blender::ed::sculpt_paint::mask::fill_mask_bmesh(), blender::ed::sculpt_paint::mask::fill_mask_grids(), blender::ed::sculpt_paint::mask::fill_mask_mesh(), blender::bke::curves::fill_points(), blender::draw::pbvh::fill_vbos_bmesh(), blender::draw::pbvh::fill_vbos_grids(), blender::draw::pbvh::fill_vbos_mesh(), blender::ed::greasepencil::find_curve_intersections(), blender::ed::greasepencil::find_curve_segments(), blender::ed::sculpt_paint::PuffOperationExecutor::find_curve_weights_projected(), blender::ed::sculpt_paint::PuffOperationExecutor::find_curves_weights_spherical(), blender::ed::sculpt_paint::SmoothOperationExecutor::find_projected_smooth_factors(), blender::ed::sculpt_paint::SmoothOperationExecutor::find_spherical_smooth_factors(), blender::bke::flip_corner_data(), blender::ed::sculpt_paint::hide::flush_face_changes_node(), blender::draw::pbvh::flush_vbo_data(), blender::ed::curves::foreach_selectable_point_range(), from_group_ids(), from_groups(), blender::geometry::gather_attribute_propagation_components_with_custom_depths(), blender::ed::sculpt_paint::CurvesEffectOperationExecutor::gather_influences_projected(), blender::ed::sculpt_paint::CurvesEffectOperationExecutor::gather_influences_spherical(), blender::array_utils::gather_to_groups(), blender::ed::sculpt_paint::expand::geodesic_falloff_create(), blender::ed::sculpt_paint::face_set::gesture_apply_bmesh(), blender::ed::sculpt_paint::mask::gesture_apply_for_symmetry_pass(), blender::ed::sculpt_paint::project::gesture_apply_for_symmetry_pass(), blender::ed::sculpt_paint::face_set::gesture_apply_mesh(), blender::ed::greasepencil::get_boundary_bounds(), blender::modifier::greasepencil::get_drawing_infos_by_frame(), blender::modifier::greasepencil::get_drawing_infos_by_layer(), blender::modifier::greasepencil::get_drawings_for_write(), blender::nodes::node_geo_edges_to_face_groups_cc::FaceSetFromBoundariesInput::get_varray_for_context(), gizmo_3d_foreach_selected(), blender::draw::grease_pencil_geom_batch_ensure(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_exec(), blender::ed::greasepencil::grease_pencil_material_lock_unselected_exec(), blender::ed::greasepencil::grease_pencil_reproject_exec(), blender::ed::greasepencil::grease_pencil_set_handle_type_exec(), blender::ed::greasepencil::grease_pencil_snap_compute_centroid(), blender::ed::greasepencil::grease_pencil_snap_to_cursor_exec(), blender::ed::greasepencil::grease_pencil_snap_to_grid_exec(), blender::ed::greasepencil::grease_pencil_stroke_simplify_exec(), blender::ed::greasepencil::grease_pencil_texture_gradient_exec(), blender::draw::grease_pencil_weight_batch_ensure(), blender::draw::grease_pencil_wire_batch_ensure(), blender::ed::sculpt_paint::hide::grid_hide_update(), blender::ed::sculpt_paint::hide::grow_shrink_visibility_grid(), blender::nodes::LazyFunctionForReduceForeachGeometryElement::handle_generation_items_group(), blender::draw::index_buf_add_line_points(), blender::draw::index_buf_add_nurbs_lines(), blender::draw::index_buf_add_points(), blender::fn::multi_function::VariableState::indices_split(), blender::ed::sculpt_paint::mask::init_mask_grids(), blender::geometry::interpolate_curves(), blender::ed::sculpt_paint::mask::invert_mask_bmesh(), blender::ed::sculpt_paint::mask::invert_mask_grids(), blender::ed::sculpt_paint::hide::invert_visibility_bmesh(), blender::ed::sculpt_paint::hide::invert_visibility_grids(), blender::ed::sculpt_paint::hide::invert_visibility_mesh(), blender::geometry::mapped_corner_selection_from_face(), blender::ed::sculpt_paint::filter::mesh_filter_sharpen_init(), blender::geometry::mix_arrays(), blender::modify_curves(), blender::modify_curves(), blender::modify_drawing(), blender::modify_fill_color(), blender::modify_fill_color(), blender::modify_fill_color(), blender::modify_geometry_set(), blender::modify_opacity(), blender::modify_softness(), blender::modify_stroke_by_index(), blender::modify_stroke_by_layer(), blender::modify_stroke_by_material(), blender::modify_stroke_color(), blender::modify_stroke_color(), blender::modify_stroke_color(), blender::modify_stroke_random(), blender::nodes::node_geo_grease_pencil_to_curves_cc::node_geo_exec(), blender::bke::pbvh::nodes_to_face_selection_grids(), blender::ed::sculpt_paint::offset_positions(), blender::ed::sculpt_paint::greasepencil::VertexAverageOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexBlurOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexPaintOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexReplaceOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexSmearOperation::on_stroke_extended(), blender::ed::sculpt_paint::hide::partialvis_update_bmesh_nodes(), blender::ed::sculpt_paint::undo::push_nodes(), blender::geometry::reassign_loose_edge_verts(), blender::geometry::remap_edges(), blender::reorder_cyclic_curve_points(), blender::ed::sculpt_paint::expand::reposition_pivot(), blender::ed::curves::resize_curves(), blender::ed::sculpt_paint::expand::restore_color_data(), blender::ed::sculpt_paint::undo::restore_color_from_undo_step(), blender::ed::sculpt_paint::undo::restore_face_set_from_undo_step(), blender::ed::sculpt_paint::undo::restore_mask_from_undo_step(), blender::ed::sculpt_paint::undo::restore_position_from_undo_step(), blender::bke::curves::bezier::retrieve_all_positions(), blender::bke::reverse_curve_point_data(), blender::bke::reverse_swap_curve_point_data(), blender::geometry::sample_curve_attribute(), blender::draw::sculpt_batches_get_ex(), blender::ed::sculpt_paint::cloth::sculpt_cloth_filter_modal(), blender::ed::sculpt_paint::color::sculpt_color_filter_apply(), blender::ed::sculpt_paint::dyntopo::sculpt_detail_flood_fill_exec(), SCULPT_do_paint_brush_image(), blender::ed::sculpt_paint::mask::sculpt_mask_filter_exec(), blender::ed::sculpt_paint::mask::sculpt_mask_init_exec(), blender::ed::sculpt_paint::sculpt_transform_all_vertices(), blender::ed::curves::select_adjacent(), blender::ed::curves::select_adjacent_mask(), blender::ed::curves::select_alternate(), blender::ed::curves::select_box(), blender::ed::curves::select_circle(), blender::ed::sculpt_paint::select_grow::select_grow_invoke_per_curve(), blender::ed::curves::select_lasso(), blender::ed::curves::select_linked(), blender::nodes::node_geo_input_shortest_edge_paths_cc::shortest_paths(), blender::ed::sculpt_paint::cloth::sim_activate_nodes(), blender::geometry::simplify_curve_attribute(), blender::geometry::smooth_curve_attribute(), blender::geometry::smooth_curve_positions(), blender::bke::greasepencil::Drawing::tag_topology_changed(), blender::index_mask::tests::TEST(), blender::ed::greasepencil::toggle_caps(), blender::ed::sculpt_paint::transform_radius_elastic(), blender::ed::greasepencil::trim::trim_curve_segments(), blender::ed::curves::convert_to_particle_system::try_convert_single_object(), blender::ed::sculpt_paint::mask::try_remove_mask_mesh(), blender::bke::pbvh::update_bounds_bmesh(), blender::bke::pbvh::update_bounds_grids(), blender::bke::pbvh::update_bounds_mesh(), blender::bke::greasepencil::update_curve_plane_normal_cache(), blender::ed::sculpt_paint::expand::update_for_vert(), blender::bke::pbvh::update_mask_bmesh(), blender::bke::pbvh::update_mask_grids(), blender::bke::pbvh::update_mask_mesh(), blender::ed::sculpt_paint::mask::update_mask_mesh(), blender::ed::sculpt_paint::hide::update_node_visibility_from_face_changes(), blender::bke::pbvh::update_normals_mesh(), blender::ed::sculpt_paint::hide::update_undo_state(), blender::geometry::update_unselected_edges(), blender::bke::pbvh::update_visibility_bmesh(), blender::bke::pbvh::update_visibility_faces(), blender::bke::pbvh::update_visibility_grids(), blender::ed::sculpt_paint::hide::vert_hide_update(), vpaint_do_draw(), blender::bke::curves::bezier::write_all_positions(), blender::write_fill_transforms(), blender::ed::sculpt_paint::mask::write_mask_mesh(), blender::write_stroke_transforms(), and blender::write_weights_for_drawing().

foreach_index() [2/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_index ( GrainSize grain_size, Fn && fn ) const

inline

Definition at line 813 of file BLI_index_mask.hh.

References index_range(), blender::threading::parallel_for(), and blender::GrainSize::value.

foreach_index_optimized() [1/2]

template<typename IndexT , typename Fn >

void blender::index_mask::IndexMask::foreach_index_optimized ( Fn && fn ) const

inline

Same as foreach_index, but generates more code, increasing compile time and binary size. This is because separate loops are generated for segments that are ranges and those that are not. Only use this when very little processing is done for each index.

Definition at line 879 of file BLI_index_mask.hh.

References foreach_segment(), blender::index_mask::optimized_foreach_index(), and blender::index_mask::optimized_foreach_index_with_pos().

Referenced by blender::geometry::calc_new_edges(), blender::nodes::node_geo_scale_elements_cc::edge_to_vert_islands(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::nodes::node_geo_scale_elements_cc::face_to_vert_islands(), blender::nodes::node_geo_material_selection_cc::select_by_material(), blender::nodes::node_geo_sort_elements_cc::sorted_indices(), to_bools(), to_indices(), and blender::geometry::vert_selection_from_edge().

foreach_index_optimized() [2/2]

template<typename IndexT , typename Fn >

void blender::index_mask::IndexMask::foreach_index_optimized ( GrainSize grain_size, Fn && fn ) const

inline

Definition at line 893 of file BLI_index_mask.hh.

References index_range(), blender::threading::parallel_for(), and blender::GrainSize::value.

foreach_range()

template<typename Fn >

void blender::index_mask::IndexMask::foreach_range ( Fn && fn ) const

inline

Calls the function once for every range. Note that this might call the function for each index separately in the worst case if there are no consecutive indices.

Support function signatures:

• (IndexRange segment)
• (IndexRange segment, int64_t segment_pos)

Definition at line 984 of file BLI_index_mask.hh.

References blender::Span< T >::drop_front(), foreach_segment(), and blender::Span< T >::is_empty().

Referenced by blender::ed::curves::foreach_selectable_curve_range(), blender::ed::sculpt_paint::greasepencil::EraseOperation::on_stroke_done(), blender::geometry::smooth_curve_attribute(), blender::geometry::smooth_curve_positions(), and to_ranges().

foreach_segment() [1/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_segment ( Fn && fn ) const

inline

Calls the function once for every segment. This should be used instead of foreach_index if the algorithm can be implemented more efficiently by processing multiple indices at once.

Supported function signatures:

• (IndexMaskSegment segment)
• (IndexMaskSegment segment, int64_t segment_pos)

The segment_pos is the position in the mask where the segment starts: segment[0] == mask[segment_pos]

Definition at line 951 of file BLI_index_mask.hh.

References blender::index_mask::has_segment_and_start_parameter, segment(), and blender::index_mask::IndexMaskData::segments_num_.

Referenced by blender::index_mask::build_result_mask_segments(), blender::ed::sculpt_paint::CombOperationExecutor::comb_projected(), blender::ed::sculpt_paint::CombOperationExecutor::comb_spherical(), blender::geometry::curve_constraints::compute_segment_lengths(), blender::ed::sculpt_paint::DeleteOperationExecutor::delete_projected(), blender::ed::sculpt_paint::DeleteOperationExecutor::delete_spherical(), blender::ed::sculpt_paint::CombOperationExecutor::execute(), blender::ed::sculpt_paint::ShrinkCurvesEffect::execute(), blender::geometry::fillet_curves(), blender::ed::sculpt_paint::SlideOperationExecutor::find_curves_to_slide(), foreach_index(), foreach_index_optimized(), foreach_range(), foreach_segment_optimized(), from_batch_predicate(), blender::index_mask::detail::from_predicate_impl(), blender::ed::sculpt_paint::PinchOperationExecutor::pinch_projected(), blender::ed::sculpt_paint::PinchOperationExecutor::pinch_spherical(), blender::ed::sculpt_paint::SnakeHookOperatorExecutor::projected_snake_hook(), blender::ed::sculpt_paint::SmoothOperationExecutor::smooth(), blender::geometry::curve_constraints::solve_length_and_collision_constraints(), blender::geometry::curve_constraints::solve_length_constraints(), blender::ed::sculpt_paint::SnakeHookOperatorExecutor::spherical_snake_hook(), and blender::bke::greasepencil::update_triangle_cache().

foreach_segment() [2/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_segment ( GrainSize grain_size, Fn && fn ) const

inline

Definition at line 967 of file BLI_index_mask.hh.

References index_range(), blender::threading::parallel_for(), and blender::GrainSize::value.

foreach_segment_optimized() [1/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_segment_optimized ( Fn && fn ) const

inline

This is similar to foreach_segment but supports slightly different function signatures:

• (auto segment)
• (auto segment, int64_t segment_pos)

The segment input is either of type IndexMaskSegment or IndexRange, so the function has to support both cases. This also means that more code is generated by the compiler because the function is instantiated twice. Only use this when very little processing happens per index.

Definition at line 909 of file BLI_index_mask.hh.

References foreach_segment(), blender::index_mask::has_segment_and_start_parameter, and blender::unique_sorted_indices::non_empty_is_range().

Referenced by blender::length_parameterize::interpolate_to_masked(), set_bits(), and to_spans_and_ranges().

foreach_segment_optimized() [2/2]

template<typename Fn >

void blender::index_mask::IndexMask::foreach_segment_optimized ( GrainSize grain_size, Fn && fn ) const

inline

Definition at line 934 of file BLI_index_mask.hh.

References index_range(), blender::threading::parallel_for(), and blender::GrainSize::value.

foreach_segment_zipped()

void blender::index_mask::IndexMask::foreach_segment_zipped ( Span< IndexMask > masks, FunctionRef< bool(Span< IndexMaskSegment > segments)> fn )

static

Iterate over the indices in multiple masks which have the same size. The given function is called for groups of segments where each segment has the same size and comes from a different input mask. For example, if the input masks are (both have size 18): A: [0, 15), {20, 24, 25} B: [0, 5), [10, 15], {20, 30, 40, 50, 60, 70, 80, 90} Then the function will be called multiple times, each time with two segments:

1. [0, 5), [0, 5)
2. [5, 10), [10, 15)
3. [10, 15), {20, 30, 40, 50, 60}
4. {20, 24, 25}, {70, 80, 90}

Definition at line 1032 of file index_mask.cc.

References BLI_assert, blender::math::min(), segments_num(), size(), and blender::Span< T >::slice().

Referenced by blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

from_batch_predicate()

IndexMask blender::index_mask::IndexMask::from_batch_predicate ( const IndexMask & universe, GrainSize grain_size, IndexMaskMemory & memory, FunctionRef< int64_t(const IndexMaskSegment &universe_segment, IndexRangesBuilder< int16_t > &builder)> batch_predicate )

static

This is a variant of from_predicate that is more efficient if the predicate for many indices can be evaluated at once.

Parameters

batch_predicate

A function that finds indices in a certain segment that should become part of the mask. To efficiently handle ranges, this function uses #IndexRangesBuilder. It returns an index offset that should be applied to each index in the builder.

Definition at line 550 of file index_mask.cc.

References blender::index_mask::ParallelSegmentsCollector::data_by_thread, foreach_segment(), from_segments(), is_empty(), blender::threading::EnumerableThreadSpecific< T >::local(), blender::index_mask::ParallelSegmentsCollector::reduce(), segment(), blender::index_mask::segments_from_batch_predicate(), segments_num(), size(), and blender::GrainSize::value.

Referenced by from_bits(), and from_bools().

from_bits() [1/2]

IndexMask blender::index_mask::IndexMask::from_bits ( BitSpan bits, IndexMaskMemory & memory )

static

Construct a mask from the indices of set bits.

Definition at line 446 of file index_mask.cc.

References from_bits(), and blender::bits::BitSpan::index_range().

Referenced by blender::ed::sculpt_paint::expand::boundary_from_enabled(), blender::draw::calc_mesh_edge_visibility(), from_bits(), from_bools(), from_bools_inverse(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::bke::pbvh::update_bounds_bmesh(), blender::bke::pbvh::update_bounds_grids(), blender::bke::pbvh::update_bounds_mesh(), blender::bke::pbvh::update_normals(), and blender::bke::pbvh::update_visibility().

from_bits() [2/2]

IndexMask blender::index_mask::IndexMask::from_bits ( const IndexMask & universe, BitSpan bits, IndexMaskMemory & memory )

static

Construct a mask from the indices of set bits, but limited to the indices in #universe.

Definition at line 479 of file index_mask.cc.

References BLI_assert, from_batch_predicate(), blender::IndexRange::from_begin_end_inclusive(), blender::index_mask::from_bits_batch_predicate(), blender::OffsetSpan< T, BaseT >::last(), blender::index_mask::max_segment_size, min_array_size(), blender::bits::BitSpan::size(), blender::bits::BitSpan::slice(), and slice().

from_bools() [1/4]

IndexMask blender::index_mask::IndexMask::from_bools ( const IndexMask & universe, const VArray< bool > & bools, IndexMaskMemory & memory )

static

Definition at line 629 of file index_mask.cc.

References blender::VArrayCommon< T >::common_info(), blender::CommonVArrayInfo::data, from_bools(), from_predicate(), IndexMask(), blender::CommonVArrayInfo::Single, blender::VArrayCommon< T >::size(), blender::CommonVArrayInfo::Span, and blender::CommonVArrayInfo::type.

from_bools() [2/4]

IndexMask blender::index_mask::IndexMask::from_bools ( const IndexMask & universe, Span< bool > bools, IndexMaskMemory & memory )

static

Construct a mask from the true indices, but limited by the indices in #universe.

Definition at line 591 of file index_mask.cc.

References BLI_assert, blender::bits::BitVector< InlineBufferCapacity, Allocator >::capacity(), from_batch_predicate(), blender::IndexRange::from_begin_end_inclusive(), from_bits(), blender::index_mask::from_bits_batch_predicate(), blender::OffsetSpan< T, BaseT >::last(), blender::index_mask::max_segment_size, min_array_size(), blender::bits::or_bools_into_bits(), blender::bits::BitVector< InlineBufferCapacity, Allocator >::resize(), size(), blender::Span< T >::size(), slice(), and blender::Span< T >::slice().

from_bools() [3/4]

IndexMask blender::index_mask::IndexMask::from_bools ( const VArray< bool > & bools, IndexMaskMemory & memory )

static

Definition at line 586 of file index_mask.cc.

References from_bools(), and blender::VArrayCommon< T >::index_range().

from_bools() [4/4]

IndexMask blender::index_mask::IndexMask::from_bools ( Span< bool > bools, IndexMaskMemory & memory )

static

Construct a mask from the true indices.

Definition at line 581 of file index_mask.cc.

References from_bools(), and blender::Span< T >::index_range().

Referenced by blender::ed::sculpt_paint::mask::apply_new_mask_bmesh(), blender::ed::sculpt_paint::mask::apply_new_mask_grids(), blender::ed::sculpt_paint::mask::apply_new_mask_mesh(), blender::ed::spreadsheet::GeometryDataSource::apply_selection_filter(), BKE_pbvh_bmesh_after_stroke(), blender::bke::pbvh::bmesh_update_topology(), blender::build_drawing(), blender::deform_drawing(), blender::ed::sculpt_paint::CombOperationExecutor::execute(), blender::ed::sculpt_paint::DeleteOperationExecutor::execute(), blender::ed::sculpt_paint::PinchOperationExecutor::execute(), blender::draw::extract_edituv_lines_mesh(), blender::ed::sculpt_paint::hide::flush_face_changes_node(), from_bools(), from_bools(), from_bools(), blender::ed::sculpt_paint::hide::grid_hide_update(), blender::fn::index_mask_from_selection(), blender::geometry::mapped_corner_selection_from_face(), blender::bke::pbvh::nodes_to_face_selection_grids(), blender::ed::curves::remove_selection(), blender::ed::sculpt_paint::undo::restore_face_set_from_undo_step(), blender::ed::sculpt_paint::undo::restore_mask_from_undo_step(), blender::ed::curves::retrieve_selected_curves(), blender::ed::curves::retrieve_selected_points(), blender::ed::sculpt_paint::mask::sculpt_mask_filter_exec(), blender::index_mask::tests::TEST(), blender::ed::sculpt_paint::mask::update_mask_mesh(), and blender::geometry::vert_selection_from_edge().

from_bools_inverse()

IndexMask blender::index_mask::IndexMask::from_bools_inverse ( const IndexMask & universe, Span< bool > bools, IndexMaskMemory & memory )

static

Definition at line 620 of file index_mask.cc.

References from_bits(), and blender::bits::invert().

Referenced by blender::draw::calc_face_visibility_mesh(), blender::draw::calc_mesh_edge_visibility(), blender::ed::sculpt_paint::islands::calc_topology_islands_mesh(), blender::draw::calc_vert_visibility_mesh(), and blender::draw::extract_edituv_lines_mesh().

from_difference()

IndexMask blender::index_mask::IndexMask::from_difference ( const IndexMask & mask_a, const IndexMask & mask_b, IndexMaskMemory & memory )

static

Construct a mask from the difference of #mask_a and #mask_b.

Definition at line 654 of file index_mask.cc.

References blender::index_mask::evaluate_expression(), and blender::index_mask::ExprBuilder::subtract().

Referenced by blender::index_mask::tests::TEST().

from_every_nth()

IndexMask blender::index_mask::IndexMask::from_every_nth ( int64_t n, int64_t indices_num, const int64_t initial_offset, IndexMaskMemory & memory )

static

Constructs a mask that contains every nth index the given number of times.

Definition at line 1023 of file index_mask.cc.

References BLI_assert, and from_repeating().

Referenced by blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

from_group_ids() [1/2]

Vector< IndexMask, 4 > blender::index_mask::IndexMask::from_group_ids ( const IndexMask & universe, const VArray< int > & group_ids, IndexMaskMemory & memory, VectorSet< int > & r_index_by_group_id )

static

Definition at line 1139 of file index_mask.cc.

References blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BLI_assert, foreach_index(), from_groups(), blender::VArrayCommon< T >::get_if_single(), blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of(), blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_or_add(), min_array_size(), blender::Vector< T, InlineBufferCapacity, Allocator >::resize(), blender::VArrayCommon< T >::size(), and blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size().

from_group_ids() [2/2]

Vector< IndexMask, 4 > blender::index_mask::IndexMask::from_group_ids ( const VArray< int > & group_ids, IndexMaskMemory & memory, VectorSet< int > & r_index_by_group_id )

static

Creates an index mask for every unique group id.

Definition at line 1170 of file index_mask.cc.

References from_group_ids(), IndexMask(), and blender::VArrayCommon< T >::size().

Referenced by blender::nodes::node_geo_split_to_instances_cc::do_common_split(), from_group_ids(), blender::nodes::node_geo_proximity_cc::ProximityFunction::init_for_mesh(), blender::nodes::node_geo_proximity_cc::ProximityFunction::init_for_pointcloud(), and blender::nodes::node_geo_sample_nearest_surface_cc::SampleNearestSurfaceFunction::SampleNearestSurfaceFunction().

from_groups()

template<typename T , typename Fn >

void blender::index_mask::IndexMask::from_groups ( const IndexMask & universe, IndexMaskMemory & memory, Fn && get_group_index, MutableSpan< IndexMask > r_masks )

static

Sorts all indices from #universe into the different output masks.

Definition at line 1043 of file BLI_index_mask.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), foreach_index(), from_indices(), blender::MutableSpan< T >::index_range(), blender::MutableSpan< T >::size(), and T.

Referenced by blender::nodes::node_geo_index_switch_cc::IndexSwitchFunction::call(), blender::nodes::node_geo_menu_switch_cc::MenuSwitchFn::call(), from_group_ids(), and blender::nodes::node_geo_index_of_nearest_cc::IndexOfNearestFieldInput::get_varray_for_context().

from_indices()

template<typename T >

template IndexMask blender::index_mask::IndexMask::from_indices ( Span< T > indices, IndexMaskMemory & memory )

static

Construct a mask from unique sorted indices.

Definition at line 409 of file index_mask.cc.

References BLI_system_thread_count(), blender::index_mask::consolidate_index_mask_segments(), from_segments(), blender::index_mask::max_segment_size, blender::unique_sorted_indices::non_empty_as_range_try(), blender::threading::parallel_for(), range, blender::index_mask::ParallelSegmentsCollector::reduce(), blender::Vector< T, InlineBufferCapacity, Allocator >::resize(), and blender::index_mask::segments_from_indices().

Referenced by blender::fn::multi_function::InstructionScheduler::add_owned_indices(), blender::ed::transform::curves::createTransCurvesVerts(), blender::ed::transform::greasepencil::createTransGreasePencilVerts(), from_groups(), from_initializers(), blender::ed::sculpt_paint::expand::geodesic_falloff_create(), blender::nodes::node_geo_mesh_topology_corners_of_edge_cc::CornersOfEdgeInput::get_varray_for_context(), blender::nodes::node_geo_mesh_topology_corners_of_vertex_cc::CornersOfVertInput::get_varray_for_context(), blender::nodes::node_geo_mesh_topology_edges_of_vertex_cc::EdgesOfVertInput::get_varray_for_context(), blender::ed::sculpt_paint::greasepencil::interpolate_between_curves(), blender::ed::greasepencil::polyline_detect_corners(), blender::bke::pbvh::search_nodes(), blender::fn::multi_function::tests::TEST(), blender::fn::multi_function::tests::TEST(), blender::fn::multi_function::tests::TEST(), blender::fn::multi_function::tests::TEST(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), and blender::ed::sculpt_paint::expand::topology_falloff_create().

from_initializers()

IndexMask blender::index_mask::IndexMask::from_initializers ( const Span< Initializer > initializers, IndexMaskMemory & memory )

static

Definition at line 672 of file index_mask.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::as_span(), blender::Vector< T, InlineBufferCapacity, Allocator >::begin(), blender::Vector< T, InlineBufferCapacity, Allocator >::end(), blender::Vector< T, InlineBufferCapacity, Allocator >::extend(), from_indices(), and range.

Referenced by blender::ed::transform::curves::createTransCurvesVerts(), blender::ed::transform::greasepencil::createTransGreasePencilVerts(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

from_intersection()

IndexMask blender::index_mask::IndexMask::from_intersection ( const IndexMask & mask_a, const IndexMask & mask_b, IndexMaskMemory & memory )

static

Construct a mask from the intersection of #mask_a and #mask_b.

Definition at line 663 of file index_mask.cc.

References blender::index_mask::evaluate_expression(), and blender::index_mask::ExprBuilder::intersect().

Referenced by blender::ed::transform::greasepencil::createTransGreasePencilVerts(), blender::draw::pbvh::free_batches(), blender::draw::pbvh::free_ibos(), blender::draw::pbvh::free_vbos(), blender::draw::grease_pencil_get_visible_non_nurbs_curves(), blender::draw::grease_pencil_get_visible_nurbs_curves(), blender::ed::greasepencil::retrieve_editable_and_selected_fill_strokes(), blender::ed::greasepencil::retrieve_editable_and_selected_points(), blender::ed::greasepencil::retrieve_editable_and_selected_strokes(), blender::ed::greasepencil::retrieve_editable_fill_strokes(), blender::ed::greasepencil::retrieve_visible_bezier_handle_points(), and blender::index_mask::tests::TEST().

from_predicate()

template<typename Fn >

IndexMask blender::index_mask::IndexMask::from_predicate ( const IndexMask & universe, GrainSize grain_size, IndexMaskMemory & memory, Fn && predicate )

inlinestatic

Construct a mask from all the indices for which the predicate is true.

Definition at line 1012 of file BLI_index_mask.hh.

References BLI_assert, ELEM, and blender::index_mask::detail::from_predicate_impl().

Referenced by blender::bke::pbvh::all_leaf_nodes(), blender::ed::spreadsheet::apply_filter_operation(), BKE_pbvh_sync_visibility_from_verts(), blender::ed::sculpt_paint::expand::boundary_from_enabled(), blender::ed::sculpt_paint::greasepencil::brush_point_influence_mask(), blender::draw::calc_face_visibility_mesh(), blender::draw::calc_mesh_edge_visibility(), blender::draw::calc_vert_visibility_mesh(), blender::geometry::convert_bezier_or_catmull_rom_to_poly_before_conversion_to_nurbs(), blender::ed::curves::curve_mask_from_points(), blender::bke::curves_copy_point_selection(), blender::ed::sculpt_paint::cloth::do_simulation_step(), blender::geometry::edge_selection_from_vert(), blender::ed::sculpt_paint::cloth::ensure_nodes_constraints(), blender::ed::sculpt_paint::CurvesEffectOperationExecutor::execute(), blender::ed::sculpt_paint::PuffOperationExecutor::execute(), blender::draw::extract_edituv_face_dots_bm(), blender::draw::extract_edituv_face_dots_mesh(), blender::draw::extract_face_dots_bm(), blender::geometry::face_selection_from_mapped_corner(), from_bools(), blender::ed::sculpt_paint::greasepencil::InterpolateOpData::from_operator(), blender::modifier::greasepencil::get_filtered_layer_mask(), blender::modifier::greasepencil::get_filtered_stroke_mask(), blender::ed::greasepencil::get_visible_boundary_strokes(), blender::io::grease_pencil::get_visible_strokes(), blender::draw::grease_pencil_get_visible_non_nurbs_curves(), blender::draw::grease_pencil_get_visible_nurbs_curves(), blender::draw::grease_pencil_get_visible_nurbs_points(), blender::ed::sculpt_paint::hide::grids_show_all(), blender::bke::curves::indices_for_type(), blender::ed::sculpt_paint::hide::mesh_show_all(), blender::ed::sculpt_paint::undo::restore_color_from_undo_step(), blender::ed::sculpt_paint::undo::restore_position_from_undo_step(), blender::ed::greasepencil::retrieve_editable_fill_strokes(), blender::ed::greasepencil::retrieve_editable_points(), blender::ed::greasepencil::retrieve_editable_strokes(), blender::ed::greasepencil::retrieve_editable_strokes_by_material(), blender::ed::curves::retrieve_selected_curves(), blender::ed::greasepencil::retrieve_visible_bezier_handle_points(), blender::ed::greasepencil::retrieve_visible_points(), blender::ed::greasepencil::retrieve_visible_strokes(), blender::simplify_drawing(), blender::ed::sculpt_paint::simplify_fixed(), blender::simplify_fixed(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), and blender::ed::curves::convert_to_particle_system::try_convert_single_object().

from_repeating()

IndexMask blender::index_mask::IndexMask::from_repeating ( const IndexMask & mask_to_repeat, int64_t repetitions, int64_t stride, int64_t initial_offset, IndexMaskMemory & memory )

static

Constructs a mask by repeating the indices in the given mask with a stride. For example, with an input mask containing {3, 5} and a stride of 10 the resulting mask would contain {3, 5, 13, 15, 23, 25, ...}.

Definition at line 948 of file index_mask.cc.

References blender::LinearAllocator< Allocator >::allocate_array(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, bounds(), blender::ceil_division(), blender::IndexRange::first(), from_segments(), blender::index_mask::get_every_nth_index(), blender::OffsetSpan< T, BaseT >::index_range(), is_empty(), last(), blender::index_mask::max_segment_size, segment(), segments_num(), size(), blender::OffsetSpan< T, BaseT >::size(), blender::Span< T >::take_front(), and to_range().

Referenced by from_every_nth(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

from_segments()

IndexMask blender::index_mask::IndexMask::from_segments ( Span< IndexMaskSegment > segments, IndexMaskMemory & memory )

static

Construct a mask from the given segments. The provided segments are expected to be sorted and owned by #memory already.

Definition at line 283 of file index_mask.cc.

References blender::LinearAllocator< Allocator >::allocate_array(), BLI_assert, blender::MutableSpan< T >::data(), blender::Span< T >::drop_front(), blender::Span< T >::index_range(), blender::index_mask::IndexMaskData::indices_num_, blender::Span< T >::is_empty(), blender::Span< T >::last(), mask(), segments_num(), and blender::Span< T >::size().

Referenced by from_batch_predicate(), from_indices(), blender::index_mask::detail::from_predicate_impl(), from_repeating(), and blender::index_mask::tests::TEST().

from_union()

IndexMask blender::index_mask::IndexMask::from_union ( const IndexMask & mask_a, const IndexMask & mask_b, IndexMaskMemory & memory )

static

Construct a mask from the union of #mask_a and #mask_b.

Definition at line 645 of file index_mask.cc.

References blender::index_mask::evaluate_expression(), and blender::index_mask::ExprBuilder::merge().

Referenced by blender::ed::transform::curves::createTransCurvesVerts(), blender::ed::transform::greasepencil::createTransGreasePencilVerts(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

index_range()

IndexRange blender::index_mask::IndexMask::index_range ( ) const

inline

Definition at line 687 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::indices_num_.

Referenced by blender::ed::sculpt_paint::average_mask_border_position(), blender::ed::sculpt_paint::average_unmasked_position(), blender::ed::sculpt_paint::calc_area_center(), blender::ed::sculpt_paint::calc_area_normal(), blender::ed::sculpt_paint::calc_area_normal_and_center(), blender::geometry::calc_vert_ranges_per_old_vert(), calculate_average_weight(), blender::ed::curves::contains(), blender::ed::sculpt_paint::color::do_paint_brush(), blender::draw::extract_edituv_lines_mesh(), blender::ed::sculpt_paint::fake_neighbor_search(), blender::ed::curves::find_closest_curve_to_screen_co(), blender::ed::curves::find_closest_point_to_screen_co(), foreach_index(), foreach_index_optimized(), foreach_segment(), foreach_segment_optimized(), blender::draw::grease_pencil_cache_add_nurbs(), blender::draw::grease_pencil_edit_batch_ensure(), blender::ed::sculpt_paint::pose::grow_pose_factor(), blender::draw::index_buf_add_bezier_lines(), blender::ed::sculpt_paint::nearest_vert_calc_bmesh(), blender::ed::sculpt_paint::nearest_vert_calc_grids(), blender::ed::sculpt_paint::nearest_vert_calc_mesh(), parallel_nodes_loop_with_mirror_check(), blender::ed::sculpt_paint::sample_surface(), blender::ed::sculpt_paint::select_grow::select_grow_invoke_per_curve(), and blender::ed::sculpt_paint::mask::try_remove_mask_mesh().

index_to_iterator()

RawMaskIterator blender::index_mask::IndexMask::index_to_iterator ( int64_t index ) const

inline

Returns

The iterator for the given index such that mask[iterator] == mask[index].

Definition at line 724 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, BLI_assert, blender::index_mask::IndexMaskData::cumulative_segment_sizes_, blender::binary_search::find_predicate_begin(), blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::RawMaskIterator::segment_i, and blender::index_mask::IndexMaskData::segments_num_.

Referenced by operator[](), slice(), and blender::index_mask::tests::TEST().

is_empty()

bool blender::index_mask::IndexMask::is_empty ( ) const

inline

Definition at line 682 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::indices_num_.

Referenced by blender::ed::greasepencil::apply_color_operation_for_mode(), blender::ed::greasepencil::apply_mask_as_segment_selection(), blender::ed::greasepencil::apply_mask_as_selection(), blender::ed::spreadsheet::GeometryDataSource::apply_selection_filter(), bounds(), blender::deform_drawing(), blender::deform_drawing(), blender::deform_drawing(), blender::ed::sculpt_paint::do_brush_action(), blender::ed::sculpt_paint::dynamic_topology_update(), blender::modifier::greasepencil::ensure_no_bezier_curves(), blender::bke::CurvesGeometry::evaluated_tangents(), blender::ed::curves::subdivide::exec(), blender::draw::extract_lines_bm(), blender::draw::extract_lines_mesh(), blender::ed::curves::extrude_curves(), blender::nodes::node_geo_extrude_mesh_cc::extrude_individual_mesh_faces(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_face_regions(), blender::ed::sculpt_paint::face_set::face_hide_update(), blender::ed::sculpt_paint::fake_neighbor_search(), blender::ed::sculpt_paint::hide::flush_face_changes_node(), from_batch_predicate(), blender::index_mask::detail::from_predicate_impl(), from_repeating(), blender::generate_curves(), blender::ed::sculpt_paint::face_set::gesture_apply_bmesh(), blender::nodes::node_geo_input_shortest_edge_paths_cc::ShortestEdgePathsCostFieldInput::get_varray_for_context(), blender::nodes::node_geo_input_shortest_edge_paths_cc::ShortestEdgePathsNextVertFieldInput::get_varray_for_context(), blender::ed::greasepencil::gpencil_stroke_subdivide_exec(), blender::draw::grease_pencil_cache_add_nurbs(), blender::ed::greasepencil::grease_pencil_caps_set_exec(), blender::ed::greasepencil::grease_pencil_cyclical_set_exec(), blender::draw::grease_pencil_edit_batch_ensure(), blender::ed::greasepencil::grease_pencil_extrude_exec(), blender::ed::greasepencil::grease_pencil_material_lock_unselected_exec(), blender::ed::greasepencil::grease_pencil_material_select_exec(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), blender::ed::greasepencil::grease_pencil_reproject_exec(), blender::ed::greasepencil::grease_pencil_reset_uvs_exec(), blender::ed::greasepencil::grease_pencil_separate_layer(), blender::ed::greasepencil::grease_pencil_separate_material(), blender::ed::greasepencil::grease_pencil_separate_selected(), blender::ed::greasepencil::grease_pencil_set_active_material_exec(), blender::ed::greasepencil::grease_pencil_set_curve_resolution_exec(), blender::ed::greasepencil::grease_pencil_set_curve_type_exec(), blender::ed::greasepencil::grease_pencil_set_uniform_opacity_exec(), blender::ed::greasepencil::grease_pencil_set_uniform_thickness_exec(), blender::ed::greasepencil::grease_pencil_stroke_material_set_exec(), blender::ed::greasepencil::grease_pencil_stroke_reorder_exec(), blender::ed::greasepencil::grease_pencil_stroke_simplify_exec(), blender::ed::greasepencil::grease_pencil_stroke_smooth_exec(), blender::ed::greasepencil::grease_pencil_stroke_switch_direction_exec(), blender::ed::greasepencil::grease_pencil_texture_gradient_exec(), blender::ed::sculpt_paint::hide::grid_hide_update(), blender::ed::sculpt_paint::hide::grids_show_all(), blender::draw::index_buf_add_bezier_line_points(), blender::draw::index_buf_add_bezier_lines(), blender::draw::index_buf_add_nurbs_lines(), blender::nodes::node_geo_proximity_cc::ProximityFunction::init_for_mesh(), blender::nodes::node_geo_proximity_cc::ProximityFunction::init_for_pointcloud(), blender::ed::sculpt_paint::face_set::init_op_exec(), blender::geometry::mesh_copy_selection(), blender::ed::sculpt_paint::nearest_vert_calc_bmesh(), blender::ed::sculpt_paint::nearest_vert_calc_grids(), blender::ed::sculpt_paint::nearest_vert_calc_mesh(), blender::ed::sculpt_paint::greasepencil::GrabOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::VertexAverageOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexBlurOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexPaintOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexReplaceOperation::on_stroke_extended(), blender::ed::sculpt_paint::greasepencil::VertexSmearOperation::on_stroke_extended(), blender::ed::greasepencil::polyline_fit_curve(), blender::geometry::propagate_instances_to_keep(), blender::bke::CurvesGeometry::remove_curves(), blender::bke::CurvesGeometry::remove_points(), blender::ed::curves::resize_curves(), blender::ed::greasepencil::retrieve_editable_fill_strokes(), blender::ed::sculpt_paint::mask::sculpt_mask_init_exec(), blender::ed::greasepencil::select_all_exec(), blender::ed::greasepencil::select_linked_exec(), blender::ed::greasepencil::select_random_exec(), blender::ed::greasepencil::select_similar_by_layer(), blender::simplify_drawing(), blender::ed::sculpt_paint::greasepencil::simplify_stroke(), blender::geometry::smooth_curve_attribute(), blender::geometry::smooth_curve_positions(), blender::ed::sculpt_paint::smooth_fill_strokes(), blender::bke::greasepencil::Drawing::tag_positions_changed(), blender::bke::greasepencil::Drawing::tag_topology_changed(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::geometry::trim_curves(), blender::bke::pbvh::update_bounds_bmesh(), blender::bke::pbvh::update_bounds_grids(), blender::bke::pbvh::update_bounds_mesh(), blender::bke::pbvh::update_visibility(), blender::bke::curves::bezier::write_all_positions(), and blender::write_weights_for_drawing().

iterator_to_index()

int64_t blender::index_mask::IndexMask::iterator_to_index ( const RawMaskIterator & it ) const

inline

Returns

The index for the given iterator such that mask[iterator] == mask[index].

Definition at line 739 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, BLI_assert, blender::index_mask::IndexMaskData::cumulative_segment_sizes_, and blender::index_mask::IndexMaskData::segments_num_.

Referenced by slice(), slice_content(), and blender::index_mask::tests::TEST().

last()

int64_t blender::index_mask::IndexMask::last ( ) const

inline

Definition at line 708 of file BLI_index_mask.hh.

References BLI_assert, blender::index_mask::IndexMaskData::end_index_in_segment_, blender::index_mask::IndexMaskData::indices_by_segment_, blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::IndexMaskData::segment_offsets_, and blender::index_mask::IndexMaskData::segments_num_.

Referenced by bounds(), from_repeating(), min_array_size(), and to_range().

min_array_size()

int64_t blender::index_mask::IndexMask::min_array_size ( ) const

inline

Returns

Minimum number of elements an array has to have so that it can be indexed by every index stored in the mask.

Definition at line 716 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::indices_num_, and last().

Referenced by blender::ed::sculpt_paint::mask::apply_new_mask_bmesh(), blender::ed::sculpt_paint::mask::apply_new_mask_grids(), blender::ed::sculpt_paint::mask::apply_new_mask_mesh(), blender::nodes::node_geo_scale_elements_cc::edge_to_vert_islands(), blender::fn::multi_function::VariableState::ensure_is_mutable(), blender::ed::sculpt_paint::face_set::face_hide_update(), blender::nodes::node_geo_scale_elements_cc::face_to_vert_islands(), blender::ed::sculpt_paint::mask::fill_mask_bmesh(), blender::ed::sculpt_paint::mask::fill_mask_grids(), blender::ed::sculpt_paint::mask::fill_mask_mesh(), blender::ed::sculpt_paint::hide::flush_face_changes_node(), from_bits(), from_bools(), from_group_ids(), blender::ed::sculpt_paint::face_set::gesture_apply_bmesh(), blender::ed::sculpt_paint::mask::gesture_apply_for_symmetry_pass(), blender::ed::sculpt_paint::hide::grid_hide_update(), blender::draw::index_mask_to_ibo(), blender::ed::sculpt_paint::undo::restore_face_set_from_undo_step(), blender::ed::sculpt_paint::undo::restore_mask_from_undo_step(), blender::ed::sculpt_paint::mask::sculpt_mask_filter_exec(), blender::nodes::node_geo_material_selection_cc::select_by_material(), blender::bke::pbvh::Tree::tag_positions_changed(), blender::bke::pbvh::Tree::tag_visibility_changed(), blender::draw::pbvh::DrawCacheImpl::tag_visibility_changed(), blender::ed::sculpt_paint::expand::update_for_vert(), blender::ed::sculpt_paint::mask::update_mask_mesh(), and blender::ed::sculpt_paint::hide::update_node_visibility_from_face_changes().

operator[]() [1/2]

int64_t blender::index_mask::IndexMask::operator[] ( const RawMaskIterator & it ) const

inline

Same as above but takes O(1) time. It's still preferable to use foreach_* methods for iteration.

Definition at line 756 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::indices_by_segment_, and blender::index_mask::IndexMaskData::segment_offsets_.

operator[]() [2/2]

int64_t blender::index_mask::IndexMask::operator[] ( int64_t i ) const

inline

Get the index at the given position. Prefer foreach_* methods for better performance. This takes O(log n) time.

Definition at line 750 of file BLI_index_mask.hh.

References index_to_iterator().

segment()

IndexMaskSegment blender::index_mask::IndexMask::segment ( int64_t segment_i ) const

inline

Returns

Indices stored in the n-th segment.

Definition at line 766 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::begin_index_in_segment_, BLI_assert, blender::index_mask::IndexMaskData::cumulative_segment_sizes_, blender::index_mask::IndexMaskData::end_index_in_segment_, blender::index_mask::IndexMaskData::indices_by_segment_, blender::index_mask::IndexMaskData::segment_offsets_, and blender::index_mask::IndexMaskData::segments_num_.

Referenced by find_larger_equal(), foreach_segment(), from_batch_predicate(), blender::index_mask::detail::from_predicate_impl(), from_repeating(), and set_bits().

segments_num()

int64_t blender::index_mask::IndexMask::segments_num ( ) const

inline

Returns

Number of segments in the mask.

Definition at line 761 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::segments_num_.

Referenced by foreach_segment_zipped(), from_batch_predicate(), blender::index_mask::detail::from_predicate_impl(), from_repeating(), and from_segments().

set_bits()

void blender::index_mask::IndexMask::set_bits	(	MutableBitSpan	r_bits,
		int64_t	offset = 0 ) const

Set the bits at indices in the mask to 1.

Definition at line 711 of file index_mask.cc.

References BLI_assert, foreach_segment_optimized(), segment(), blender::bits::MutableBitSpan::set_all(), blender::index_mask::IndexMaskSegment::shift(), blender::IndexRange::shift(), blender::bits::MutableBitSpan::size(), and blender::bits::MutableBitSpan::slice().

Referenced by blender::bke::pbvh::Tree::tag_positions_changed(), blender::bke::pbvh::Tree::tag_visibility_changed(), blender::draw::pbvh::DrawCacheImpl::tag_visibility_changed(), and to_bits().

shift()

IndexMask blender::index_mask::IndexMask::shift	(	const int64_t	offset,
		IndexMaskMemory &	memory ) const

Adds an offset to every index in the mask.

Definition at line 200 of file index_mask.cc.

References blender::LinearAllocator< Allocator >::allocate_array(), BLI_assert, blender::MutableSpan< T >::data(), first(), blender::index_mask::IndexMaskData::indices_num_, blender::index_mask::IndexMaskData::segment_offsets_, blender::index_mask::IndexMaskData::segments_num_, and to_range().

Referenced by blender::draw::extract_points_subdiv_mesh(), blender::GVArrayImpl_For_SlicedGVArray::materialize(), blender::GVArrayImpl_For_SlicedGVArray::materialize_compressed(), blender::GVArrayImpl_For_SlicedGVArray::materialize_compressed_to_uninitialized(), blender::GVArrayImpl_For_SlicedGVArray::materialize_to_uninitialized(), slice_and_shift(), and blender::index_mask::tests::TEST().

size()

int64_t blender::index_mask::IndexMask::size ( ) const

inline

Definition at line 677 of file BLI_index_mask.hh.

References blender::index_mask::IndexMaskData::indices_num_.

Referenced by blender::fn::multi_function::VariableState::add_as_output(), blender::fn::multi_function::VariableStates::add_initial_variable_states(), BKE_bvhtree_from_mesh_edges_init(), BKE_bvhtree_from_mesh_tris_init(), BKE_bvhtree_from_mesh_verts_init(), BKE_bvhtree_from_pointcloud_get(), blender::ed::sculpt_paint::greasepencil::brush_point_influence_mask(), blender::nodes::node_geo_extrude_mesh_cc::build_vert_to_edge_map(), blender::geometry::calc_all_corner_groups(), blender::draw::calc_edit_handles_ibo(), blender::geometry::calc_vert_ranges_per_old_vert(), blender::ed::sculpt_paint::create_node_vert_offsets(), blender::ed::sculpt_paint::create_node_vert_offsets(), blender::ed::sculpt_paint::create_node_vert_offsets_bmesh(), blender::nodes::node_geo_curves_to_grease_pencil_cc::curve_instances_to_grease_pencil_layers(), blender::bke::curves_copy_curve_selection(), blender::bke::curves_copy_point_selection(), blender::fn::multi_function::VariableState::destruct(), blender::draw::DRW_curves_batch_cache_create_requested(), blender::nodes::node_geo_scale_elements_cc::edge_to_vert_islands(), blender::fn::multi_function::evaluate_as_one(), blender::ed::sculpt_paint::DensitySubtractOperationExecutor::execute(), blender::draw::extract_edituv_face_dots_bm(), blender::draw::extract_edituv_face_dots_mesh(), blender::draw::extract_lines_bm(), blender::draw::extract_lines_mesh(), blender::draw::extract_points_bm(), blender::draw::extract_points_mesh(), blender::draw::extract_points_subdiv_bm(), blender::draw::extract_points_subdiv_mesh(), blender::ed::curves::extrude_curves(), blender::nodes::node_geo_extrude_mesh_cc::extrude_individual_mesh_faces(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::nodes::node_geo_scale_elements_cc::face_to_vert_islands(), blender::ed::sculpt_paint::greasepencil::find_curve_mapping_from_index(), blender::ed::greasepencil::find_curve_segments(), foreach_segment_zipped(), from_batch_predicate(), from_bools(), blender::index_mask::detail::from_predicate_impl(), from_repeating(), blender::geometry::gather_attributes_to_propagate(), blender::nodes::node_geo_scale_elements_cc::gather_edge_islands(), blender::nodes::node_geo_scale_elements_cc::gather_face_islands(), gizmo_3d_foreach_selected(), blender::draw::grease_pencil_cache_add_nurbs(), blender::draw::grease_pencil_edit_batch_ensure(), blender::draw::grease_pencil_geom_batch_ensure(), blender::ed::greasepencil::grease_pencil_reset_uvs_exec(), blender::ed::greasepencil::grease_pencil_snap_compute_centroid(), blender::ed::greasepencil::grease_pencil_stroke_reorder_exec(), blender::ed::greasepencil::grease_pencil_texture_gradient_exec(), blender::draw::grease_pencil_weight_batch_ensure(), blender::draw::index_buf_add_bezier_line_points(), blender::draw::index_buf_add_bezier_lines(), IndexMask(), blender::geometry::interpolate_curves(), blender::length_parameterize::interpolate_to_masked(), blender::fn::multi_function::VariableState::is_fully_initialized(), blender::geometry::mesh_copy_selection(), blender::geometry::mesh_copy_selection_keep_edges(), blender::geometry::mesh_copy_selection_keep_verts(), blender::modify_drawing(), blender::modify_drawing(), blender::nodes::node_geo_attribute_statistic_cc::node_geo_exec(), blender::nodes::node_geo_grease_pencil_to_curves_cc::node_geo_exec(), blender::ed::greasepencil::polyline_fit_curve(), blender::geometry::remap_verts(), blender::bke::Instances::remove(), blender::bke::CurvesGeometry::remove_curves(), blender::bke::CurvesGeometry::remove_points(), blender::ed::curves::resize_curves(), blender::draw::sculpt_batches_get_ex(), blender::ed::sculpt_paint::select_grow::select_grow_invoke_per_curve(), blender::simplify_drawing(), slice(), slice(), blender::geometry::split_edges(), blender::ed::spreadsheet::spreadsheet_main_region_draw(), blender::ed::spreadsheet::SpreadsheetLayoutDrawer::SpreadsheetLayoutDrawer(), blender::ed::sculpt_paint::greasepencil::EraseOperationExecutor::stroke_eraser(), blender::bke::greasepencil::Drawing::tag_positions_changed(), blender::bke::greasepencil::Drawing::tag_topology_changed(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), blender::index_mask::tests::TEST(), to_indices(), blender::ed::curves::convert_to_particle_system::try_convert_single_object(), and blender::bke::curves::bezier::write_all_positions().

slice() [1/3]

IndexMask blender::index_mask::IndexMask::slice ( IndexRange range ) const

inline

Get a new mask that contains a consecutive subset of this mask. Takes O(log n) time and but can reuse the memory from the source mask.

Definition at line 780 of file BLI_index_mask.hh.

References slice(), and blender::IndexRange::start().

Referenced by blender::ed::curves::contains(), blender::draw::create_edit_points_selection(), do_wpaint_brush_blur(), do_wpaint_brush_draw(), do_wpaint_brush_smear(), blender::ed::curves::end_points(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::ed::sculpt_paint::fake_neighbor_search(), blender::ed::sculpt_paint::greasepencil::find_curve_mapping_from_index(), from_bits(), from_bools(), blender::ed::sculpt_paint::nearest_vert_calc_bmesh(), blender::ed::sculpt_paint::nearest_vert_calc_grids(), blender::ed::sculpt_paint::nearest_vert_calc_mesh(), slice(), slice_and_shift(), slice_content(), blender::index_mask::tests::TEST(), and blender::ed::sculpt_paint::mask::try_remove_mask_mesh().

slice() [2/3]

IndexMask blender::index_mask::IndexMask::slice	(	int64_t	start,
		int64_t	size ) const

Definition at line 120 of file index_mask.cc.

References blender::index_mask::RawMaskIterator::index_in_segment, index_to_iterator(), blender::index_mask::RawMaskIterator::segment_i, and size().

slice() [3/3]

IndexMask blender::index_mask::IndexMask::slice	(	RawMaskIterator	first_it,
		RawMaskIterator	last_it,
		int64_t	size ) const

Definition at line 139 of file index_mask.cc.

References BLI_assert, blender::index_mask::RawMaskIterator::index_in_segment, iterator_to_index(), blender::index_mask::RawMaskIterator::segment_i, and size().

slice_and_shift() [1/2]

IndexMask blender::index_mask::IndexMask::slice_and_shift	(	IndexRange	range,
		int64_t	offset,
		IndexMaskMemory &	memory ) const

Same slice but can also add an offset to every index in the mask. Takes O(log n + range.size()) time but with a very small constant factor.

Definition at line 179 of file index_mask.cc.

References slice_and_shift(), and blender::IndexRange::start().

Referenced by blender::fn::multi_function::MultiFunction::call_auto(), slice_and_shift(), and blender::index_mask::tests::TEST().

slice_and_shift() [2/2]

IndexMask blender::index_mask::IndexMask::slice_and_shift	(	int64_t	start,
		int64_t	size,
		int64_t	offset,
		IndexMaskMemory &	memory ) const

Definition at line 186 of file index_mask.cc.

References shift(), slice(), and to_range().

slice_content() [1/2]

IndexMask blender::index_mask::IndexMask::slice_content

(

IndexRange

range

)

const

Slices the mask based on the stored indices. The resulting mask only contains the indices that are within the given range.

Definition at line 155 of file index_mask.cc.

References slice_content(), and blender::IndexRange::start().

Referenced by blender::index_mask::build_result_mask_segments(), blender::index_mask::evaluate_coarse(), blender::index_mask::evaluate_exact_with_bits(), blender::index_mask::evaluate_exact_with_indices(), blender::index_mask::evaluate_short_unknown_segments_exactly(), blender::index_mask::evaluated_segments_to_index_mask(), blender::ed::greasepencil::extrude_grease_pencil_curves(), blender::ed::greasepencil::find_curve_segments(), blender::ed::greasepencil::grease_pencil_snap_to_cursor_exec(), blender::ed::curves::select_box(), blender::ed::curves::select_circle(), blender::ed::curves::select_lasso(), slice_content(), blender::index_mask::tests::TEST(), and blender::index_mask::tests::TEST().

slice_content() [2/2]

IndexMask blender::index_mask::IndexMask::slice_content	(	int64_t	start,
		int64_t	size ) const

Definition at line 160 of file index_mask.cc.

References find_larger_equal(), find_smaller_equal(), iterator_to_index(), and slice().

to_bits()

void blender::index_mask::IndexMask::to_bits	(	MutableBitSpan	r_bits,
		int64_t	offset = 0 ) const

Set the bits at indices in the mask to 1 and all other bits to 0.

Definition at line 730 of file index_mask.cc.

References BLI_assert, blender::bits::MutableBitSpan::reset_all(), set_bits(), and blender::bits::MutableBitSpan::size().

Referenced by blender::index_mask::evaluate_exact_with_bits().

to_bools()

void blender::index_mask::IndexMask::to_bools

(

MutableSpan< bool >

r_bools

)

const

Set the bools at indices in the mask to true and all others to false.

Definition at line 737 of file index_mask.cc.

References BLI_assert, blender::MutableSpan< T >::fill(), foreach_index_optimized(), and blender::MutableSpan< T >::size().

Referenced by blender::ed::greasepencil::apply_mask_as_segment_selection(), blender::ed::curves::curve_mask_from_points(), blender::ed::curves::subdivide::exec(), and blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_face_regions().

to_indices()

template<typename T >

template void blender::index_mask::IndexMask::to_indices

(

MutableSpan< T >

r_indices

)

const

Fill the provided span with the indices in the mask. The span is expected to have the same size as the mask.

Definition at line 702 of file index_mask.cc.

References BLI_assert, blender::MutableSpan< T >::data(), foreach_index_optimized(), pos, size(), and blender::MutableSpan< T >::size().

Referenced by blender::nodes::node_geo_extrude_mesh_cc::build_vert_to_edge_map(), blender::draw::extract_edituv_face_dots_bm(), blender::draw::extract_edituv_face_dots_mesh(), blender::draw::extract_points_subdiv_bm(), blender::draw::extract_points_subdiv_mesh(), blender::ed::sculpt_paint::greasepencil::find_curve_mapping_from_index(), blender::nodes::node_geo_scale_elements_cc::gather_edge_islands(), blender::nodes::node_geo_scale_elements_cc::gather_face_islands(), and blender::ed::greasepencil::polyline_fit_curve().

to_range()

std::optional< IndexRange > blender::index_mask::IndexMask::to_range ( ) const

inline

Try to convert the entire index mask into a range. This only works if there are no gaps between any indices.

Definition at line 1058 of file BLI_index_mask.hh.

References first(), blender::index_mask::IndexMaskData::indices_num_, and last().

Referenced by from_repeating(), blender::ed::curves::resize_curves(), shift(), and slice_and_shift().

to_ranges()

Vector< IndexRange > blender::index_mask::IndexMask::to_ranges

(

)

const

Returns

All index ranges in the mask. In the worst case this is a separate range for every index.

Definition at line 745 of file index_mask.cc.

References foreach_range().

Referenced by to_ranges_invert().

to_ranges_invert()

Vector< IndexRange > blender::index_mask::IndexMask::to_ranges_invert

(

IndexRange

universe

)

const

Returns

All index ranges in the universe that are not in the mask. In the worst case this is a separate range for every index.

Definition at line 752 of file index_mask.cc.

References complement(), and to_ranges().

to_spans_and_ranges()

template<int64_t N>

Vector< std::variant< IndexRange, IndexMaskSegment >, N > blender::index_mask::IndexMask::to_spans_and_ranges ( ) const

inline

Returns

All segments in sorted vector. Segments that encode a range are already converted to an #IndexRange.

Definition at line 1072 of file BLI_index_mask.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), foreach_segment_optimized(), and N.

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const IndexMask & a, const IndexMask & b )

friend

Definition at line 1079 of file BLI_index_mask.hh.

operator==

bool operator== ( const IndexMask & a, const IndexMask & b )

friend

Definition at line 1118 of file index_mask.cc.

---

The documentation for this class was generated from the following files:

• BLI_index_mask.hh
• index_mask.cc