#include <BLI_virtual_array.hh>

Inherited by blender::VArray< T >, and blender::VMutableArray< T >.

Public Member Functions
	operator bool () const
T	operator[] (const int64_t index) const
T	get (const int64_t index) const
int64_t	size () const
T	first () const
T	last (const int64_t n=0) const
bool	is_empty () const
IndexRange	index_range () const
CommonVArrayInfo	common_info () const
bool	is_span () const
Span< T >	get_internal_span () const
bool	is_single () const
T	get_internal_single () const
std::optional< T >	get_if_single () const
void	materialize (MutableSpan< T > r_span) const
void	materialize (const IndexMask &mask, MutableSpan< T > r_span) const
void	materialize_to_uninitialized (MutableSpan< T > r_span) const
void	materialize_to_uninitialized (const IndexMask &mask, MutableSpan< T > r_span) const
void	materialize_compressed (const IndexMask &mask, MutableSpan< T > r_span) const
void	materialize_compressed_to_uninitialized (const IndexMask &mask, MutableSpan< T > r_span) const
bool	try_assign_GVArray (GVArray &varray) const
const VArrayImpl< T > *	get_implementation () const

Protected Types
using	Storage = Any<blender::detail::VArrayAnyExtraInfo<T>, 24, 8>

Protected Member Functions
	VArrayCommon ()=default
	VArrayCommon (const VArrayCommon &other)
	VArrayCommon (VArrayCommon &&other) noexcept
	VArrayCommon (const VArrayImpl< T > *impl)
	VArrayCommon (std::shared_ptr< const VArrayImpl< T > > impl)
template<typename ImplT, typename... Args>
void	emplace (Args &&...args)
void	copy_from (const VArrayCommon &other)
void	move_from (VArrayCommon &&other) noexcept
const VArrayImpl< T > *	impl_from_storage () const

Protected Attributes
const VArrayImpl< T > *	impl_ = nullptr
Storage	storage_

Detailed Description

template<typename T>
class blender::VArrayCommon< T >

Utility class to reduce code duplication for methods available on VArray and VMutableArray. Deriving VMutableArray from VArray would have some issues:

Static methods on VArray would also be available on VMutableArray.
It would allow assigning a VArray to a VMutableArray under some circumstances which is not allowed and could result in hard to find bugs.

Definition at line 496 of file BLI_virtual_array.hh.

Member Typedef Documentation

◆ Storage

template<typename T>

using blender::VArrayCommon< T >::Storage = Any<blender::detail::VArrayAnyExtraInfo<T>, 24, 8>

protected

Store the virtual array implementation in an Any. This makes it easy to avoid a memory allocation if the implementation is small enough and is copyable. This is the case for the most common virtual arrays. Other virtual array implementations are typically stored as #std::shared_ptr. That works even when the implementation itself is not copyable and makes copying VArrayCommon cheaper.

Definition at line 505 of file BLI_virtual_array.hh.

Constructor & Destructor Documentation

◆ VArrayCommon() [1/5]

template<typename T>

blender::VArrayCommon< T >::VArrayCommon ( )

protecteddefault

Referenced by copy_from(), move_from(), blender::VArray< T >::VArray(), blender::VArray< T >::VArray(), VArrayCommon(), VArrayCommon(), blender::VMutableArray< T >::VMutableArray(), and blender::VMutableArray< T >::VMutableArray().

◆ VArrayCommon() [2/5]

template<typename T>

blender::VArrayCommon< T >::VArrayCommon ( const VArrayCommon< T > & other )

inlineprotected

Copy constructor.

Definition at line 524 of file BLI_virtual_array.hh.

References impl_, impl_from_storage(), storage_, and VArrayCommon().

◆ VArrayCommon() [3/5]

template<typename T>

blender::VArrayCommon< T >::VArrayCommon ( VArrayCommon< T > && other )

inlineprotectednoexcept

Move constructor.

Definition at line 530 of file BLI_virtual_array.hh.

References impl_, impl_from_storage(), and VArrayCommon().

◆ VArrayCommon() [4/5]

template<typename T>

blender::VArrayCommon< T >::VArrayCommon ( const VArrayImpl< T > * impl )

inlineprotected

Wrap an existing VArrayImpl and don't take ownership of it. This should rarely be used in practice.

Definition at line 541 of file BLI_virtual_array.hh.

References impl, impl_, and storage_.

◆ VArrayCommon() [5/5]

template<typename T>

blender::VArrayCommon< T >::VArrayCommon ( std::shared_ptr< const VArrayImpl< T > > impl )

inlineprotected

Wrap an existing VArrayImpl that is contained in a #std::shared_ptr. This takes ownership.

Definition at line 549 of file BLI_virtual_array.hh.

References get(), impl, impl_, and storage_.

Member Function Documentation

◆ common_info()

template<typename T>

CommonVArrayInfo blender::VArrayCommon< T >::common_info ( ) const

inline

Definition at line 676 of file BLI_virtual_array.hh.

References BLI_assert, and impl_.

Referenced by blender::array_utils::booleans_mix_calc(), blender::ed::curves::contains(), blender::array_utils::count_booleans(), blender::VArrayDevirtualizer< T, UseSingle, UseSpan >::devirtualize(), blender::index_mask::IndexMask::from_bools(), and blender::GVMutableArray::GVMutableArray().

◆ copy_from()

template<typename T>

void blender::VArrayCommon< T >::copy_from ( const VArrayCommon< T > & other )

inlineprotected

Utility to implement a copy assignment operator in a subclass.

Definition at line 579 of file BLI_virtual_array.hh.

References impl_, impl_from_storage(), storage_, and VArrayCommon().

Referenced by blender::VMutableArray< float >::operator VArray< float >(), blender::VArray< T >::operator=(), and blender::VMutableArray< T >::operator=().

◆ emplace()

template<typename T>

template<typename ImplT, typename... Args>

void blender::VArrayCommon< T >::emplace ( Args &&... args )

inlineprotected

Replace the contained VArrayImpl.

Definition at line 559 of file BLI_virtual_array.hh.

References emplace(), impl_, ptr, and storage_.

Referenced by emplace(), blender::VArray< T >::For(), blender::VMutableArray< T >::For(), blender::VArray< T >::VArray(), and blender::VArray< T >::VArray().

◆ first()

template<typename T>

T blender::VArrayCommon< T >::first ( ) const

inline

Get the first element.

Definition at line 653 of file BLI_virtual_array.hh.

References T.

Referenced by blender::io::alembic::ABCCurveWriter::create_alembic_objects(), blender::io::alembic::ABCCurveWriter::do_write(), blender::io::usd::USDCurvesWriter::do_write(), and blender::io::grease_pencil::PDFExporter::GreasePencilExporter().

◆ get()

template<typename T>

T blender::VArrayCommon< T >::get ( const int64_t index ) const

inline

Same as the operator[] but is sometimes easier to use when one has a pointer to a virtual array.

Definition at line 634 of file BLI_virtual_array.hh.

References T.

Referenced by blender::modifier::greasepencil::get_filtered_layer_mask(), blender::modifier::greasepencil::get_filtered_stroke_mask(), blender::fn::tests::TEST(), blender::fn::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), and VArrayCommon().

◆ get_if_single()

template<typename T>

std::optional< T > blender::VArrayCommon< T >::get_if_single ( ) const

inline

Return the value that is returned for every index, if the array is stored as a single value.

Definition at line 723 of file BLI_virtual_array.hh.

References blender::CommonVArrayInfo::data, impl_, blender::CommonVArrayInfo::Single, T, and blender::CommonVArrayInfo::type.

Referenced by blender::nodes::node_geo_duplicate_elements_cc::accumulate_counts_to_offsets(), blender::ed::greasepencil::attributes_elements_are_equal(), blender::nodes::node_fn_combine_transform_cc::CombineTransformFunction::call(), blender::nodes::node_fn_separate_matrix_cc::SeparateMatrixFunction::call(), blender::nodes::node_geo_menu_switch_cc::MenuSwitchFn::call(), blender::io::usd::copy_blender_buffer_to_primvar(), blender::ed::greasepencil::extrude_grease_pencil_curves(), blender::index_mask::IndexMask::from_group_ids(), blender::geometry::gather_attributes_to_propagate(), blender::nodes::node_geo_scale_elements_cc::gather_mean(), blender::ed::greasepencil::grease_pencil_material_lock_unselected_exec(), blender::ed::greasepencil::retrieve_visible_points(), and blender::nodes::node_geo_material_selection_cc::select_by_material().

◆ get_implementation()

template<typename T>

const VArrayImpl< T > * blender::VArrayCommon< T >::get_implementation ( ) const

inline

Definition at line 773 of file BLI_virtual_array.hh.

References impl_.

◆ get_internal_single()

template<typename T>

T blender::VArrayCommon< T >::get_internal_single ( ) const

inline

Return the value that is returned for every index. This invokes undefined behavior if the virtual array would not return the same value for every index.

Definition at line 713 of file BLI_virtual_array.hh.

References BLI_assert, blender::CommonVArrayInfo::data, impl_, is_single(), and T.

Referenced by blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), BKE_mesh_material_index_used(), BKE_sculpt_sync_face_visibility_to_grids(), blender::io::obj::OBJMesh::calc_face_order(), blender::geometry::convert_curves_to_nurbs(), corner_tris_no_hidden_map_get(), blender::ed::curves::duplicate_points(), blender::fn::FieldEvaluator::get_evaluated_as_mask(), blender::nodes::node_geo_input_curve_handles_cc::HandlePositionFieldInput::get_varray_for_context(), blender::bke::mesh_hide_face_flush(), blender::bke::mesh_hide_vert_flush(), blender::bke::mesh_select_edge_flush(), blender::bke::mesh_select_face_flush(), blender::bke::mesh_select_vert_flush(), blender::nodes::node_geo_curve_subdivide_cc::subdivide_curves(), blender::nodes::node_geo_curve_subdivide_cc::subdivide_grease_pencil_curves(), and blender::tests::TEST().

◆ get_internal_span()

template<typename T>

Span< T > blender::VArrayCommon< T >::get_internal_span ( ) const

inline

Returns the internally used span of the virtual array. This invokes undefined behavior if the virtual array is not stored as a span internally.

Definition at line 694 of file BLI_virtual_array.hh.

References BLI_assert, blender::CommonVArrayInfo::data, impl_, is_span(), and T.

Referenced by blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::geometry::preprocess_pointclouds(), blender::ed::sculpt_paint::greasepencil::simplify_stroke(), blender::tests::TEST(), and blender::ed::sculpt_paint::greasepencil::trim_stroke_ends().

◆ impl_from_storage()

template<typename T>

const VArrayImpl< T > * blender::VArrayCommon< T >::impl_from_storage ( ) const

inlineprotected

Get a pointer to the virtual array implementation that is currently stored in storage_, or null.

Definition at line 602 of file BLI_virtual_array.hh.

References storage_.

Referenced by copy_from(), move_from(), VArrayCommon(), and VArrayCommon().

◆ index_range()

template<typename T>

IndexRange blender::VArrayCommon< T >::index_range ( ) const

inline

Definition at line 671 of file BLI_virtual_array.hh.

References size().

Referenced by blender::array_utils::booleans_mix_calc(), blender::array_utils::copy(), blender::bke::copy_with_checked_indices(), blender::nodes::node_geo_sample_index_cc::copy_with_clamped_indices(), blender::array_utils::count_booleans(), blender::index_mask::IndexMask::from_bools(), blender::ed::greasepencil::grease_pencil_weight_invert_exec(), blender::io::grease_pencil::PDFExporter::GreasePencilExporter(), blender::bke::mesh_select_edge_flush(), blender::bke::mesh_select_vert_flush(), paintface_reveal(), and blender::nodes::node_geo_interpolate_curves_cc::separate_guides_by_group().

◆ is_empty()

template<typename T>

bool blender::VArrayCommon< T >::is_empty ( ) const

inline

True when the size is zero or when there is no virtual array.

Definition at line 666 of file BLI_virtual_array.hh.

References size().

Referenced by blender::array_utils::booleans_mix_calc(), blender::nodes::node_shader_tex_gabor_cc::GaborNoiseFunction::call(), blender::array_utils::count_booleans(), blender::io::grease_pencil::PDFExporter::GreasePencilExporter(), blender::io::ply::load_plydata(), blender::ed::sculpt_paint::greasepencil::EraseOperation::on_stroke_done(), and blender::tests::TEST().

◆ is_single()

template<typename T>

bool blender::VArrayCommon< T >::is_single ( ) const

inline

Return true when the virtual array returns the same value for every index.

Definition at line 702 of file BLI_virtual_array.hh.

References BLI_assert, impl_, blender::CommonVArrayInfo::Single, and blender::CommonVArrayInfo::type.

◆ is_span()

template<typename T>

bool blender::VArrayCommon< T >::is_span ( ) const

inline

Return true when the virtual array is stored as a span internally.

Definition at line 683 of file BLI_virtual_array.hh.

References BLI_assert, impl_, blender::CommonVArrayInfo::Span, and blender::CommonVArrayInfo::type.

Referenced by blender::deform_drawing(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), get_internal_span(), blender::VMutableArray< T >::get_internal_span(), blender::ed::greasepencil::grease_pencil_stroke_simplify_exec(), blender::ed::greasepencil::grease_pencil_stroke_smooth_exec(), blender::ed::sculpt_paint::greasepencil::simplify_stroke(), blender::ed::sculpt_paint::greasepencil::smooth_stroke(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), and blender::ed::sculpt_paint::greasepencil::trim_stroke_ends().

◆ last()

template<typename T>

T blender::VArrayCommon< T >::last ( const int64_t n = 0 ) const

inline

Get the nth last element.

Definition at line 660 of file BLI_virtual_array.hh.

References size(), and T.

Referenced by blender::get_factor_from_draw_speed().

◆ materialize() [1/2]

template<typename T>

void blender::VArrayCommon< T >::materialize	(	const IndexMask &	mask,
		MutableSpan< T >	r_span ) const

inline

Copy some indices of the virtual array into a span.

Definition at line 739 of file BLI_virtual_array.hh.

References BLI_assert, blender::MutableSpan< T >::data(), impl_, and mask().

◆ materialize() [2/2]

template<typename T>

void blender::VArrayCommon< T >::materialize ( MutableSpan< T > r_span ) const

inline

Copy the entire virtual array into a span.

Definition at line 733 of file BLI_virtual_array.hh.

References materialize(), and size().

Referenced by blender::nodes::node_geo_points_to_curves_cc::curves_from_points(), ED_mesh_split_faces(), blender::geometry::execute_realize_curve_task(), blender::geometry::execute_realize_pointcloud_task(), blender::ed::geometry::geometry_attribute_convert_exec(), blender::draw::grease_pencil_weight_batch_ensure(), materialize(), paintface_flush_flags(), paintvert_flush_flags(), and blender::nodes::node_geo_set_id_cc::set_id_in_component().

◆ materialize_compressed()

template<typename T>

void blender::VArrayCommon< T >::materialize_compressed	(	const IndexMask &	mask,
		MutableSpan< T >	r_span ) const

inline

Copy some elements of the virtual array into a span.

Definition at line 757 of file BLI_virtual_array.hh.

References blender::MutableSpan< T >::data(), impl_, and mask().

Referenced by blender::geometry::calculate_result_offsets(), blender::geometry::calculate_result_offsets(), blender::geometry::fillet_curves(), blender::array_utils::gather_group_to_group(), blender::nodes::node_geo_curve_topology_points_of_curve_cc::PointsOfCurveInput::get_varray_for_context(), blender::nodes::node_geo_mesh_topology_corners_of_edge_cc::CornersOfEdgeInput::get_varray_for_context(), blender::nodes::node_geo_mesh_topology_corners_of_face_cc::CornersOfFaceInput::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(), and blender::tests::TEST().

◆ materialize_compressed_to_uninitialized()

template<typename T>

void blender::VArrayCommon< T >::materialize_compressed_to_uninitialized	(	const IndexMask &	mask,
		MutableSpan< T >	r_span ) const

inline

Definition at line 762 of file BLI_virtual_array.hh.

References blender::MutableSpan< T >::data(), impl_, and mask().

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

◆ materialize_to_uninitialized() [1/2]

template<typename T>

void blender::VArrayCommon< T >::materialize_to_uninitialized	(	const IndexMask &	mask,
		MutableSpan< T >	r_span ) const

inline

Definition at line 750 of file BLI_virtual_array.hh.

References BLI_assert, blender::MutableSpan< T >::data(), impl_, and mask().

◆ materialize_to_uninitialized() [2/2]

template<typename T>

void blender::VArrayCommon< T >::materialize_to_uninitialized ( MutableSpan< T > r_span ) const

inline

Definition at line 745 of file BLI_virtual_array.hh.

References materialize_to_uninitialized(), and size().

Referenced by materialize_to_uninitialized().

◆ move_from()

template<typename T>

void blender::VArrayCommon< T >::move_from ( VArrayCommon< T > && other )

inlineprotectednoexcept

Utility to implement a move assignment operator in a subclass.

Definition at line 589 of file BLI_virtual_array.hh.

References impl_, impl_from_storage(), storage_, and VArrayCommon().

Referenced by blender::VMutableArray< float >::operator VArray< float >(), blender::VArray< T >::operator=(), and blender::VMutableArray< T >::operator=().

◆ operator bool()

template<typename T>

blender::VArrayCommon< T >::operator bool ( ) const

inline

Return false when there is no virtual array implementation currently.

Definition at line 612 of file BLI_virtual_array.hh.

References impl_.

◆ operator[]()

template<typename T>

T blender::VArrayCommon< T >::operator[] ( const int64_t index ) const

inline

Get the element at a specific index.

Note: This can't return a reference because the value may be computed on the fly. This also implies that one can not use this method for assignments.

Definition at line 622 of file BLI_virtual_array.hh.

References BLI_assert, impl_, size(), and T.

◆ size()

template<typename T>

int64_t blender::VArrayCommon< T >::size ( ) const

inline

Return the size of the virtual array. It's allowed to call this method even when there is no virtual array. In this case 0 is returned.

Definition at line 643 of file BLI_virtual_array.hh.

References impl_.

Referenced by blender::array_utils::booleans_mix_calc(), blender::ed::sculpt_paint::greasepencil::calculate_view_radii(), blender::ed::curves::contains(), blender::array_utils::copy(), blender::io::usd::copy_blender_buffer_to_primvar(), blender::array_utils::count_booleans(), blender::array_utils::count_booleans(), blender::ed::greasepencil::create_curves_outline(), blender::nodes::node_geo_points_to_curves_cc::curve_from_points(), blender::VArrayDevirtualizer< T, UseSingle, UseSpan >::devirtualize(), blender::nodes::node_geo_curve_fill_cc::do_group_aware_cdt(), blender::VArray< T >::ForFunc(), blender::VArray< T >::ForSingle(), blender::index_mask::IndexMask::from_bools(), blender::index_mask::IndexMask::from_group_ids(), blender::index_mask::IndexMask::from_group_ids(), blender::nodes::get_closest_in_bvhtree(), blender::nodes::node_geo_sample_nearest_cc::get_closest_mesh_corners(), blender::nodes::node_geo_sample_nearest_cc::get_closest_mesh_faces(), blender::nodes::node_geo_sample_nearest_cc::get_closest_pointcloud_points(), blender::fn::FieldEvaluator::get_evaluated_as_mask(), blender::ed::greasepencil::grease_pencil_weight_invert_exec(), blender::GVMutableArray::GVMutableArray(), index_range(), is_empty(), last(), materialize(), materialize_to_uninitialized(), operator[](), blender::VMutableArray< T >::set(), 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::geometry::trim_curves(), and blender::VArray< T >::VArray().

◆ try_assign_GVArray()

template<typename T>

bool blender::VArrayCommon< T >::try_assign_GVArray ( GVArray & varray ) const

inline

See #GVArrayImpl::try_assign_GVArray.

Definition at line 768 of file BLI_virtual_array.hh.

References impl_.

Member Data Documentation

◆ impl_

template<typename T>

const VArrayImpl<T>* blender::VArrayCommon< T >::impl_ = nullptr

protected

Pointer to the currently contained virtual array implementation. This is allowed to be null.

Definition at line 510 of file BLI_virtual_array.hh.

Referenced by common_info(), copy_from(), emplace(), get_if_single(), get_implementation(), get_internal_single(), get_internal_span(), is_single(), is_span(), materialize(), materialize_compressed(), materialize_compressed_to_uninitialized(), materialize_to_uninitialized(), move_from(), operator bool(), operator[](), size(), try_assign_GVArray(), VArrayCommon(), VArrayCommon(), VArrayCommon(), and VArrayCommon().

◆ storage_

template<typename T>

Storage blender::VArrayCommon< T >::storage_

protected

Does the memory management for the virtual array implementation. It contains one of the following:

Inlined subclass of VArrayImpl.
Non-owning pointer to a VArrayImpl.
Shared pointer to a VArrayImpl.

Definition at line 518 of file BLI_virtual_array.hh.

Referenced by copy_from(), emplace(), impl_from_storage(), move_from(), VArrayCommon(), VArrayCommon(), and VArrayCommon().

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

BLI_virtual_array.hh

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Storage

Constructor & Destructor Documentation

◆ VArrayCommon() [1/5]

◆ VArrayCommon() [2/5]

◆ VArrayCommon() [3/5]

◆ VArrayCommon() [4/5]

◆ VArrayCommon() [5/5]

Member Function Documentation

◆ common_info()

◆ copy_from()

◆ emplace()

◆ first()

◆ get()

◆ get_if_single()

◆ get_implementation()

◆ get_internal_single()

◆ get_internal_span()

◆ impl_from_storage()

◆ index_range()

◆ is_empty()

◆ is_single()

◆ is_span()

◆ last()

◆ materialize() [1/2]

◆ materialize() [2/2]

◆ materialize_compressed()

◆ materialize_compressed_to_uninitialized()

◆ materialize_to_uninitialized() [1/2]

◆ materialize_to_uninitialized() [2/2]

◆ move_from()

◆ operator bool()

◆ operator[]()

◆ size()

◆ try_assign_GVArray()

Member Data Documentation

◆ impl_

◆ storage_