Blender V5.3
blender::VArrayCommon< T > Class Template Reference

#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 Member Functions

 VArrayCommon ()=default
 VArrayCommon (const VArrayImpl< T > *impl)
 VArrayCommon (std::shared_ptr< const VArrayImpl< T > > impl)
template<typename ImplT, typename... Args>
void emplace (Args &&...args)

Protected Attributes

AnyDerived< const VArrayImpl< T > > impl_

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 511 of file BLI_virtual_array.hh.

Constructor & Destructor Documentation

◆ VArrayCommon() [1/3]

◆ VArrayCommon() [2/3]

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 521 of file BLI_virtual_array.hh.

References impl_.

◆ VArrayCommon() [3/3]

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 526 of file BLI_virtual_array.hh.

References impl_.

Member Function Documentation

◆ common_info()

◆ emplace()

template<typename T>
template<typename ImplT, typename... Args>
void blender::VArrayCommon< T >::emplace ( Args &&... args)
inlineprotected

◆ first()

template<typename T>
T blender::VArrayCommon< T >::first ( ) const
inline

Get the first element.

Definition at line 579 of file BLI_virtual_array.hh.

References T.

Referenced by blender::bounds::min_max().

◆ get()

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

◆ 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 649 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::bke::build_mesh_positions(), blender::geometry::calc_radius_without_interpolation(), blender::geometry::calc_single_value_material_index(), blender::bke::calculate_type_counts(), blender::nodes::node_fn_combine_transform_cc::CombineTransformFunction::call(), blender::nodes::node_fn_format_string_cc::FormatStringMultiFunction::call(), blender::nodes::node_fn_separate_matrix_cc::SeparateMatrixFunction::call(), blender::nodes::node_geo_index_switch_cc::IndexSwitchFunction::call(), blender::nodes::node_geo_menu_switch_cc::MenuSwitchBoolsFn::call(), blender::nodes::node_geo_menu_switch_cc::MenuSwitchFn::call(), blender::io::usd::copy_blender_buffer_to_primvar(), blender::bke::curve_types_are_valid(), blender::geometry::gather_attributes_to_propagate(), blender::nodes::node_geo_scale_elements_cc::gather_means(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::ed::greasepencil::grease_pencil_material_lock_unselected_exec(), blender::ed::transform::curves::handles_by_type(), blender::bounds::max(), blender::geometry::mesh_copy_selection(), blender::ed::greasepencil::retrieve_visible_points(), blender::nodes::node_geo_material_selection_cc::select_by_material(), and blender::bke::validate_material_indices().

◆ get_implementation()

◆ get_internal_single()

template<typename T>
T blender::VArrayCommon< T >::get_internal_single ( ) const
inline

◆ get_internal_span()

◆ index_range()

◆ is_empty()

◆ 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 628 of file BLI_virtual_array.hh.

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

Referenced by blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), blender::BKE_mesh_material_index_used(), blender::BKE_sculpt_sync_face_visibility_to_grids(), blender::io::obj::OBJMesh::calc_face_order(), blender::geometry::convert_curves_to_nurbs(), blender::io::alembic::create_geom_param_for_attribute(), blender::nodes::node_geo_points_to_curves_cc::curve_from_points(), blender::nodes::node_geo_points_to_curves_cc::curves_from_points(), blender::nodes::node_geo_curve_fill_cc::do_group_aware_cdt(), blender::io::alembic::ABCCurveWriter::do_write(), blender::io::alembic::ABCPointCloudWriter::do_write(), blender::ed::curves::duplicate_points(), blender::bke::CurvesGeometry::evaluated_normals(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_edges(), blender::nodes::node_geo_extrude_mesh_cc::extrude_mesh_face_regions(), blender::index_mask::IndexMask::from_group_ids(), blender::geometry::gather_all_fill_ids(), blender::fn::FieldEvaluator::get_evaluated_as_mask(), get_internal_single(), blender::io::usd::get_loops_polys(), blender::nodes::node_geo_accumulate_field_cc::AccumulateFieldInput::get_varray_for_context(), blender::nodes::node_geo_accumulate_field_cc::TotalFieldInput::get_varray_for_context(), blender::nodes::node_geo_curve_topology_points_of_curve_cc::PointsOfCurveInput::get_varray_for_context(), blender::nodes::node_geo_field_average_cc::FieldAverageInput::get_varray_for_context(), blender::nodes::node_geo_field_min_and_max_cc::FieldMinMaxInput::get_varray_for_context(), blender::nodes::node_geo_field_variance_cc::FieldVarianceInput::get_varray_for_context(), blender::nodes::node_geo_index_of_nearest_cc::HasNeighborFieldInput::get_varray_for_context(), blender::nodes::node_geo_input_curve_handles_cc::HandlePositionFieldInput::get_varray_for_context(), blender::nodes::node_geo_mesh_face_group_boundaries_cc::BoundaryFieldInput::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(), blender::bke::curves::indices_for_type(), blender::draw::interpolate_corners(), 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::ed::curves::retrieve_selected_curves(), blender::geometry::sort_indices_by_weights(), blender::nodes::node_geo_curve_subdivide_cc::subdivide_curves(), blender::nodes::node_geo_curve_subdivide_cc::subdivide_grease_pencil_curves(), blender::tests::TEST_F(), and blender::tests::TEST_F().

◆ is_span()

◆ last()

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

Get the nth last element.

Definition at line 586 of file BLI_virtual_array.hh.

References size(), and T.

◆ 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 665 of file BLI_virtual_array.hh.

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

◆ materialize() [2/2]

◆ materialize_compressed()

◆ 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 688 of file BLI_virtual_array.hh.

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

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

◆ materialize_to_uninitialized() [1/2]

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

◆ materialize_to_uninitialized() [2/2]

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

◆ 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 538 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 548 of file BLI_virtual_array.hh.

References blender::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 569 of file BLI_virtual_array.hh.

References impl_.

Referenced by blender::ArrayState< T >::ArrayState(), blender::bke::CurvesGeometry::blend_read(), blender::array_utils::booleans_mix_calc(), blender::nodes::node_geo_proximity_cc::ProximityFunction::build_group_trees(), blender::bke::calculate_type_counts(), blender::array_utils::contains(), 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::io::alembic::create_geom_param_for_attribute(), blender::nodes::node_geo_points_to_curves_cc::curve_from_points(), blender::deform_drawing(), blender::VArrayDevirtualizer< T, UseSingle, UseSpan >::devirtualize(), blender::nodes::node_geo_curve_fill_cc::do_group_aware_cdt(), blender::io::alembic::ABCPointCloudWriter::do_write(), blender::draw::GSplatEvalCache::ensure_builtin_buffers(), blender::geometry::fit_poly_to_bezier_curves(), blender::ed::sculpt_paint::float_selection_ensure(), blender::index_mask::IndexMask::from_bools(), blender::index_mask::IndexMask::from_bools_inverse(), blender::VArray< T >::from_func(), blender::index_mask::IndexMask::from_group_ids(), blender::index_mask::IndexMask::from_group_ids(), blender::VArray< T >::from_single(), blender::VArray< T >::from_std_func(), 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::modifier::greasepencil::get_influence_vertex_weights(), blender::ed::greasepencil::grease_pencil_weight_invert_exec(), blender::GVMutableArray::GVMutableArray(), index_range(), blender::bke::curves::indices_for_type(), is_empty(), blender::ed::greasepencil::join_geometries_with_transforms(), last(), materialize(), materialize_to_uninitialized(), blender::bounds::min_max(), operator[](), blender::io::usd::populate_curve_widths(), blender::ArrayState< T >::same_as(), blender::VMutableArray< T >::set(), blender::bke::greasepencil::shapes_from_fill_ids(), blender::ed::geometry::store_attributes_to_shape_keys(), blender::bke::tests::TEST_F(), blender::fn::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::tests::TEST_F(), blender::geometry::trim_curves(), blender::VArray< T >::VArray(), and blender::ed::sculpt_paint::greasepencil::view_radii_from_point_selection().

◆ 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 694 of file BLI_virtual_array.hh.

References impl_.

Member Data Documentation

◆ impl_


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