Blender V5.3
blender::GVArrayCommon Class Reference

#include <BLI_generic_virtual_array.hh>

Inherited by blender::GVArray, and blender::GVMutableArray.

Public Member Functions

bool may_have_ownership () const

Protected Member Functions

 GVArrayCommon ()=default

Protected Attributes

AnyDerived< const GVArrayImpl, 40 > impl_

#GVArrayCommon

 GVArrayCommon (const GVArrayImpl *impl)
 GVArrayCommon (std::shared_ptr< const GVArrayImpl > impl)
IndexRange index_range () const
void materialize (void *dst) const
void materialize (const IndexMask &mask, void *dst) const
void materialize_to_uninitialized (void *dst) const
void materialize_to_uninitialized (const IndexMask &mask, void *dst) const
void materialize_compressed (const IndexMask &mask, void *dst) const
void materialize_compressed_to_uninitialized (const IndexMask &mask, void *dst) const
bool is_span () const
GSpan get_internal_span () const
bool is_single () const
void get_internal_single (void *r_value) const
void get_internal_single_to_uninitialized (void *r_value) const

Inline methods for #GVArrayCommon.

template<typename ImplT, typename... Args>
void emplace (Args &&...args)
const CPPType & type () const
 operator bool () const
int64_t size () const
bool is_empty () const
template<typename T>
bool try_assign_VArray (VArray< T > &varray) const
CommonVArrayInfo common_info () const
void get (int64_t index, void *r_value) const
template<typename T>
T get (int64_t index) const
void get_to_uninitialized (int64_t index, void *r_value) const

Detailed Description

Utility class to reduce code duplication between GVArray and GVMutableArray. It pretty much follows VArrayCommon. Don't use this class outside of this header.

Definition at line 91 of file BLI_generic_virtual_array.hh.

Constructor & Destructor Documentation

◆ GVArrayCommon() [1/3]

◆ GVArrayCommon() [2/3]

blender::GVArrayCommon::GVArrayCommon ( const GVArrayImpl * impl)
protected

Definition at line 548 of file generic_virtual_array.cc.

References impl_.

◆ GVArrayCommon() [3/3]

blender::GVArrayCommon::GVArrayCommon ( std::shared_ptr< const GVArrayImpl > impl)
protected

Definition at line 550 of file generic_virtual_array.cc.

References impl_.

Member Function Documentation

◆ common_info()

CommonVArrayInfo blender::GVArrayCommon::common_info ( ) const
inline

Definition at line 770 of file BLI_generic_virtual_array.hh.

References impl_.

Referenced by blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), blender::bke::attribute_init_to_data(), blender::GVArrayImpl_For_SlicedGVArray::common_info(), blender::VArrayImpl_For_GVArray< T >::common_info(), blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::geometry::copy_and_mix_attributes(), blender::nodes::node_geo_duplicate_elements_cc::copy_attributes_from_other_domains(), blender::bke::subdiv::create_attrs_and_retrieve_interp_spans(), blender::geometry::create_curve_from_vert_indices(), blender::bke::curve_to_mesh_sweep(), blender::ed::pointcloud::duplicate_points(), blender::GVMutableArray::fill(), blender::bke::fill_attribute_range_default(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::nodes::node_geo_points_to_vertices_cc::geometry_set_points_to_vertices(), blender::nodes::node_geo_interpolate_curves_cc::interpolate_curve_attributes(), may_have_ownership(), blender::geometry::merge_points(), blender::bke::mesh_remesh_reproject_attributes(), blender::nodes::node_geo_distribute_points_on_faces_cc::propagate_attributes(), blender::geometry::reorder_and_flip_attributes_group_to_group(), blender::geometry::reorder_attributes_group_to_group(), blender::ed::curves::resize_curves(), blender::geometry::retrieve_attribute_spans(), blender::bke::retrieve_attributes_for_transfer(), blender::GVArray::slice(), blender::nodes::node_geo_dual_mesh_cc::transfer_attributes(), blender::nodes::node_geo_transfer_attributes_cc::transfer_attributes(), blender::bke::try_add_single_value_attribute(), blender::bke::try_capture_fields_on_geometry(), blender::ed::mesh::try_join_single_value_attribute(), blender::geometry::try_join_single_value_attribute(), blender::geometry::construct::try_propagate_single_value(), blender::GVArray::typed(), and blender::GVMutableArray::typed().

◆ emplace()

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

◆ get() [1/2]

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

Returns a copy of the value at the given index. Usually a typed virtual array should be used instead, but sometimes this is simpler when only a few indices are needed.

Definition at line 736 of file BLI_generic_virtual_array.hh.

References blender::BLI_assert(), impl_, size(), T, and type().

◆ get() [2/2]

◆ get_internal_single()

void blender::GVArrayCommon::get_internal_single ( void * r_value) const

Copies the value that is used for every element into r_value, which is expected to point to initialized memory. This invokes undefined behavior if the virtual array would not return the same value for every index.

Definition at line 602 of file generic_virtual_array.cc.

References blender::BLI_assert(), blender::CPPType::copy_assign(), blender::CommonVArrayInfo::data, impl_, is_single(), and type().

Referenced by blender::bke::CurvesGeometry::adapt_domain(), blender::bke::adapt_mesh_attribute_domain(), blender::fn::multi_function::DivideFunction::call(), blender::fn::multi_function::PowFunction::call(), get_internal_single_to_uninitialized(), and may_have_ownership().

◆ get_internal_single_to_uninitialized()

void blender::GVArrayCommon::get_internal_single_to_uninitialized ( void * r_value) const

Same as get_internal_single, but r_value points to initialized memory.

Definition at line 609 of file generic_virtual_array.cc.

References get_internal_single(), and impl_.

Referenced by may_have_ownership().

◆ get_internal_span()

◆ get_to_uninitialized()

◆ index_range()

◆ is_empty()

bool blender::GVArrayCommon::is_empty ( ) const
inline

◆ is_single()

◆ is_span()

◆ materialize() [1/2]

void blender::GVArrayCommon::materialize ( const IndexMask & mask,
void * dst ) const

Definition at line 557 of file generic_virtual_array.cc.

References impl_.

◆ materialize() [2/2]

◆ materialize_compressed()

void blender::GVArrayCommon::materialize_compressed ( const IndexMask & mask,
void * dst ) const

Definition at line 573 of file generic_virtual_array.cc.

References impl_.

Referenced by blender::array_utils::gather(), and may_have_ownership().

◆ materialize_compressed_to_uninitialized()

void blender::GVArrayCommon::materialize_compressed_to_uninitialized ( const IndexMask & mask,
void * dst ) const

Definition at line 578 of file generic_virtual_array.cc.

References impl_.

Referenced by may_have_ownership().

◆ materialize_to_uninitialized() [1/2]

void blender::GVArrayCommon::materialize_to_uninitialized ( const IndexMask & mask,
void * dst ) const

Definition at line 567 of file generic_virtual_array.cc.

References blender::BLI_assert(), and impl_.

◆ materialize_to_uninitialized() [2/2]

◆ may_have_ownership()

◆ operator bool()

blender::GVArrayCommon::operator bool ( ) const
inline

Definition at line 765 of file BLI_generic_virtual_array.hh.

References impl_.

◆ size()

int64_t blender::GVArrayCommon::size ( ) const
inline

◆ try_assign_VArray()

template<typename T>
bool blender::GVArrayCommon::try_assign_VArray ( VArray< T > & varray) const
inline

Definition at line 754 of file BLI_generic_virtual_array.hh.

References blender::BLI_assert(), impl_, and T.

Referenced by GVArrayCommon(), and blender::GVArray::typed().

◆ type()

const CPPType & blender::GVArrayCommon::type ( ) const
inline

Definition at line 760 of file BLI_generic_virtual_array.hh.

References impl_.

Referenced by blender::ed::sculpt_paint::color::active_color_attribute(), blender::bke::adapt_curve_domain_curve_to_point(), blender::bke::adapt_curve_domain_point_to_curve(), blender::bke::CurvesGeometry::adapt_domain(), blender::bke::adapt_mesh_attribute_domain(), blender::bke::adapt_mesh_domain_corner_to_edge(), blender::bke::adapt_mesh_domain_corner_to_face(), blender::bke::adapt_mesh_domain_corner_to_point(), blender::bke::adapt_mesh_domain_edge_to_corner(), blender::bke::adapt_mesh_domain_edge_to_face(), blender::bke::adapt_mesh_domain_edge_to_point(), blender::bke::adapt_mesh_domain_face_to_corner(), blender::bke::adapt_mesh_domain_face_to_edge(), blender::bke::adapt_mesh_domain_face_to_point(), blender::bke::adapt_mesh_domain_point_to_corner(), blender::bke::adapt_mesh_domain_point_to_edge(), blender::bke::adapt_mesh_domain_point_to_face(), blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::ed::spreadsheet::apply_row_filter(), attr_create_generic(), attr_create_generic(), attr_create_motion_corner_normals(), attr_need_motion_vertex_normals(), blender::bke::attribute_init_to_data(), blender::ed::greasepencil::attributes_varrays_not_equal(), blender::BKE_mesh_mirror_apply_mirror_on_axis_for_modifier(), blender::geometry::construct::build_output_mesh(), blender::fn::multi_function::tests::GenericAppendFunction::call(), blender::ed::geometry::convert_attribute(), blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::bke::MutableAttributeAccessor::convert_or_add_for_write(), blender::array_utils::copy(), blender::array_utils::copy(), blender::geometry::copy_and_mix_attributes(), copy_attributes(), blender::nodes::node_geo_duplicate_elements_cc::copy_attributes_from_other_domains(), blender::bke::copy_curve_domain_attribute_to_mesh(), blender::bke::copy_main_point_domain_attribute_to_mesh(), blender::nodes::node_geo_duplicate_elements_cc::copy_stable_id_curves(), blender::nodes::node_geo_duplicate_elements_cc::copy_stable_id_edges(), blender::nodes::node_geo_duplicate_elements_cc::copy_stable_id_faces(), blender::nodes::node_geo_duplicate_elements_cc::copy_stable_id_point(), blender::bke::subdiv::create_attrs_and_retrieve_interp_spans(), blender::geometry::create_curve_from_vert_indices(), blender::geometry::create_id_index_map(), blender::bke::curve_to_mesh_sweep(), blender::ed::greasepencil::curves_geometry_is_equal(), blender::ed::pointcloud::duplicate_points(), blender::ed::greasepencil::ensure_selection_domain(), blender::bke::evaluate_attribute(), blender::fn::evaluate_fields(), blender::GVectorArray::extend(), blender::draw::extract_attribute(), blender::draw::extract_attribute_data(), blender::draw::extract_attribute_subdiv(), blender::ed::curves::extrude_curves(), blender::GVMutableArray::fill(), blender::bke::fill_attribute_range_default(), blender::ed::spreadsheet::ColumnValues::fit_column_values_width_px(), blender::nodes::node_fn_format_string_cc::format_with_fmt(), blender::nodes::node_fn_format_string_cc::format_with_hash_syntax(), blender::nodes::node_fn_format_string_cc::format_with_python_compatible_syntax(), blender::nodes::node_fn_format_string_cc::format_without_format_specifier(), blender::GVArray::from_empty(), blender::GVArray::from_func(), blender::GVArray::from_single(), blender::GVArray::from_single_default(), blender::GVArray::from_single_ref(), blender::GVArray::from_std_func(), blender::array_utils::gather(), blender::bke::attribute_math::gather(), blender::geometry::gather_realize_tasks_for_instances(), blender::ed::geometry::geometry_color_attribute_duplicate_exec(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::nodes::node_geo_points_to_vertices_cc::geometry_set_points_to_vertices(), get(), get_internal_single(), get_internal_span(), blender::GVMutableArray::get_internal_span(), blender::bke::EvaluateAtIndexInput::get_varray_for_context(), 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_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::GVArray::GVArray(), blender::GVArray::GVArray(), blender::GVArray::GVArray(), GVArrayCommon(), blender::nodes::LazyFunctionForReduceForeachGeometryElement::handle_generation_items_group(), blender::nodes::node_geo_interpolate_curves_cc::interpolate_curve_attributes(), blender::ed::mesh::join_normals(), blender::geometry::merge_points(), blender::bke::mesh_remesh_reproject_attributes(), blender::geometry::preprocess_curves(), blender::geometry::preprocess_meshes(), blender::geometry::preprocess_pointclouds(), blender::nodes::node_geo_distribute_points_on_faces_cc::propagate_attributes(), blender::geometry::reorder_and_flip_attributes_group_to_group(), blender::geometry::reorder_attributes_group_to_group(), blender::ed::curves::resize_curves(), blender::geometry::retrieve_attribute_spans(), blender::geometry::retrieve_attribute_spans(), blender::bke::retrieve_attributes_for_transfer(), blender::bke::mesh_surface_sample::sample_corner_attribute(), blender::bke::sample_corner_attributes(), blender::bke::mesh_surface_sample::sample_face_attribute(), blender::bke::mesh_surface_sample::sample_point_attribute(), blender::bke::sample_vertex_attributes(), blender::GVArray::slice(), blender::bke::compare_geometry::sort_domain_using_attributes(), blender::geometry::threaded_copy(), blender::nodes::node_geo_dual_mesh_cc::transfer_attributes(), blender::nodes::node_geo_transfer_attributes_cc::transfer_attributes(), blender::transform_active_color_data(), blender::bke::transform_custom_normal_attribute(), blender::bke::try_add_single_value_attribute(), blender::bke::try_capture_fields_on_geometry(), blender::bke::DataTypeConversions::try_convert(), blender::bke::DataTypeConversions::try_convert(), blender::ed::mesh::try_join_single_value_attribute(), blender::geometry::try_join_single_value_attribute(), blender::geometry::construct::try_propagate_single_value(), blender::bke::try_sharing_point_data(), blender::ed::spreadsheet::ColumnValues::type(), blender::draw::pbvh::update_generic_attribute_grids(), blender::draw::pbvh::update_generic_attribute_mesh(), blender::VArrayImpl_For_GVArray< T >::VArrayImpl_For_GVArray(), blender::bke::compare_geometry::verify_attributes_compatible(), blender::vertex_paint_from_weight(), and blender::VMutableArrayImpl_For_GVMutableArray< T >::VMutableArrayImpl_For_GVMutableArray().

Member Data Documentation

◆ impl_


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