Blender: blender::GVArray Class Reference

Blender V4.3

#include <BLI_generic_virtual_array.hh>

Inherits blender::GVArrayCommon.

Public Member Functions
	GVArray ()=default

const GVArrayImpl *	get_implementation () const

Public Member Functions inherited from blender::GVArrayCommon
bool	may_have_ownership () const

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

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

#GVArray
	GVArray (const GVArray &other)

	GVArray (GVArray &&other) noexcept

	GVArray (const GVArrayImpl *impl)

	GVArray (std::shared_ptr< const GVArrayImpl > impl)

	GVArray (varray_tag::single, const CPPType &type, int64_t size, const void *value)

GVArray	slice (IndexRange slice) const

GVArray &	operator= (const GVArray &other)

GVArray &	operator= (GVArray &&other) noexcept

static GVArray	ForSingle (const CPPType &type, int64_t size, const void *value)

static GVArray	ForSingleRef (const CPPType &type, int64_t size, const void *value)

static GVArray	ForSingleDefault (const CPPType &type, int64_t size)

static GVArray	ForSpan (GSpan span)

static GVArray	ForGArray (GArray<> array)

static GVArray	ForEmpty (const CPPType &type)

Inline methods for #GVArray.
	GVArray (varray_tag::span, GSpan span)

	GVArray (varray_tag::single_ref, const CPPType &type, int64_t size, const void *value)

template<typename T >
	GVArray (const VArray< T > &varray)

template<typename T >
	GVArray (VArray< T > &&varray)

template<typename T >
VArray< T >	typed () const

template<typename ImplT , typename... Args>
static GVArray	For (Args &&...args)

Additional Inherited Members
Protected Types inherited from blender::GVArrayCommon
using	Storage = Any<detail::GVArrayAnyExtraInfo, 40, 8>

Protected Member Functions inherited from blender::GVArrayCommon
	GVArrayCommon ()=default

	GVArrayCommon (const GVArrayCommon &other)

	GVArrayCommon (GVArrayCommon &&other) noexcept

	GVArrayCommon (const GVArrayImpl *impl)

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

	~GVArrayCommon ()

void	copy_from (const GVArrayCommon &other)

void	move_from (GVArrayCommon &&other) noexcept

const GVArrayImpl *	impl_from_storage () const

template<typename ImplT , typename... Args>
void	emplace (Args &&...args)

Protected Attributes inherited from blender::GVArrayCommon
const GVArrayImpl *	impl_ = nullptr

Storage	storage_

Detailed Description

Generic version of #VArray.

Definition at line 176 of file BLI_generic_virtual_array.hh.

Constructor & Destructor Documentation

◆ GVArray() [1/10]

blender::GVArray::GVArray ( )

default

Referenced by ForSingle(), ForSingleRef(), and ForSpan().

◆ GVArray() [2/10]

blender::GVArray::GVArray ( const GVArray & other )

default

◆ GVArray() [3/10]

blender::GVArray::GVArray ( GVArray && other )

defaultnoexcept

◆ GVArray() [4/10]

blender::GVArray::GVArray ( const GVArrayImpl * impl )

Definition at line 680 of file generic_virtual_array.cc.

◆ GVArray() [5/10]

blender::GVArray::GVArray ( std::shared_ptr< const GVArrayImpl > impl )

Definition at line 682 of file generic_virtual_array.cc.

◆ GVArray() [6/10]

blender::GVArray::GVArray	(	varray_tag::span	,
		GSpan	span )

inline

Definition at line 826 of file BLI_generic_virtual_array.hh.

References blender::GSpan::data(), blender::GVArrayCommon::emplace(), blender::GSpan::size(), and blender::GSpan::type().

◆ GVArray() [7/10]

blender::GVArray::GVArray	(	varray_tag::single_ref	,
		const CPPType &	type,
		int64_t	size,
		const void *	value )

inline

Definition at line 834 of file BLI_generic_virtual_array.hh.

References blender::GVArrayCommon::emplace().

◆ GVArray() [8/10]

blender::GVArray::GVArray	(	varray_tag::single	,
		const CPPType &	type,
		int64_t	size,
		const void *	value )

Definition at line 684 of file generic_virtual_array.cc.

References blender::GVArrayCommon::emplace(), blender::GVArrayCommon::size(), and blender::GVArrayCommon::type().

◆ GVArray() [9/10]

template<typename T >

blender::GVArray::GVArray ( const VArray< T > & varray )

inline

Definition at line 874 of file BLI_generic_virtual_array.hh.

◆ GVArray() [10/10]

template<typename T >

blender::GVArray::GVArray ( VArray< T > && varray )

inline

Definition at line 878 of file BLI_generic_virtual_array.hh.

References blender::CommonVArrayInfo::data, For(), ForSingle(), ForSpan(), blender::CPPType::get(), blender::CommonVArrayInfo::may_have_ownership, blender::CommonVArrayInfo::Single, blender::CPPType::size(), blender::CommonVArrayInfo::Span, and blender::CommonVArrayInfo::type.

Member Function Documentation

◆ For()

template<typename ImplT , typename... Args>

GVArray blender::GVArray::For ( Args &&... args )

inlinestatic

Definition at line 866 of file BLI_generic_virtual_array.hh.

References blender::GVArrayCommon::emplace().

Referenced by ForGArray(), GVArray(), slice(), and blender::bke::DataTypeConversions::try_convert().

◆ ForEmpty()

GVArray blender::GVArray::ForEmpty ( const CPPType & type )

static

Definition at line 730 of file generic_virtual_array.cc.

References ForSpan().

Referenced by blender::fn::evaluate_fields().

◆ ForGArray()

GVArray blender::GVArray::ForGArray ( GArray<> array )

static

Definition at line 725 of file generic_virtual_array.cc.

References For().

Referenced by blender::bke::EvaluateAtIndexInput::get_varray_for_context(), and blender::bke::EvaluateOnDomainInput::get_varray_for_context().

◆ ForSingle()

GVArray blender::GVArray::ForSingle	(	const CPPType &	type,
		int64_t	size,
		const void *	value )

static

Definition at line 694 of file generic_virtual_array.cc.

References GVArray(), blender::GVArrayCommon::size(), and blender::GVArrayCommon::type().

Referenced by blender::bke::CurvesGeometry::adapt_domain(), blender::bke::adapt_mesh_attribute_domain(), blender::bke::AttributeFieldInput::get_varray_for_context(), blender::bke::EvaluateOnDomainInput::get_varray_for_context(), blender::nodes::node_geo_tool_selection_cc::SculptSelectionFieldInput::get_varray_for_context(), GVArray(), blender::bke::AttributeAccessor::lookup_or_default(), and slice().

◆ ForSingleDefault()

GVArray blender::GVArray::ForSingleDefault	(	const CPPType &	type,
		int64_t	size )

static

Definition at line 704 of file generic_virtual_array.cc.

References ForSingleRef().

Referenced by blender::fn::get_field_context_inputs(), and blender::bke::EvaluateOnDomainInput::get_varray_for_context().

◆ ForSingleRef()

GVArray blender::GVArray::ForSingleRef	(	const CPPType &	type,
		int64_t	size,
		const void *	value )

static

Definition at line 699 of file generic_virtual_array.cc.

References GVArray(), blender::GVArrayCommon::size(), and blender::GVArrayCommon::type().

Referenced by blender::fn::evaluate_fields(), ForSingleDefault(), and blender::bke::AttributeAccessor::lookup_or_default().

◆ ForSpan()

GVArray blender::GVArray::ForSpan ( GSpan span )

static

Definition at line 709 of file generic_virtual_array.cc.

References GVArray().

Referenced by blender::bke::DataTypeConversions::convert_to_initialized_n(), blender::fn::evaluate_fields(), blender::GVectorArray::extend(), blender::bke::CustomDataAttributeProvider::foreach_attribute(), ForEmpty(), blender::array_utils::gather(), blender::ed::spreadsheet::ExtraColumns::get_column_values(), GVArray(), slice(), blender::bke::BuiltinCustomDataLayerProvider::try_get_for_read(), and blender::bke::CustomDataAttributeProvider::try_get_for_read().

◆ get_implementation()

const GVArrayImpl * blender::GVArray::get_implementation ( ) const

inline

Definition at line 210 of file BLI_generic_virtual_array.hh.

References blender::GVArrayCommon::impl_.

◆ operator=() [1/2]

GVArray & blender::GVArray::operator= ( const GVArray & other )

Definition at line 749 of file generic_virtual_array.cc.

References blender::GVArrayCommon::copy_from().

◆ operator=() [2/2]

GVArray & blender::GVArray::operator= ( GVArray && other )

noexcept

Definition at line 755 of file generic_virtual_array.cc.

◆ slice()

GVArray blender::GVArray::slice ( IndexRange slice ) const

Definition at line 735 of file generic_virtual_array.cc.

References blender::GVArrayCommon::common_info(), blender::CommonVArrayInfo::data, For(), ForSingle(), ForSpan(), blender::CommonVArrayInfo::may_have_ownership, blender::CommonVArrayInfo::Single, blender::IndexRange::size(), blender::GSpan::slice(), slice(), blender::CommonVArrayInfo::Span, blender::CommonVArrayInfo::type, and blender::GVArrayCommon::type().

Referenced by blender::draw::overlay::add_instance_attributes_to_text_cache(), blender::fn::multi_function::add_sliced_parameters(), and slice().

◆ typed()

template<typename T >

VArray< T > blender::GVArray::typed ( ) const

inline

Definition at line 900 of file BLI_generic_virtual_array.hh.

References BLI_assert, blender::GVArrayCommon::common_info(), blender::CommonVArrayInfo::data, blender::VArray< T >::ForSingle(), blender::VArray< T >::ForSpan(), blender::GVArrayCommon::impl_, blender::CPPType::is(), blender::CommonVArrayInfo::may_have_ownership, blender::CommonVArrayInfo::Single, blender::CommonVArrayInfo::Span, blender::GVArrayCommon::try_assign_VArray(), blender::CommonVArrayInfo::type, and blender::GVArrayImpl::type().

Referenced by blender::bke::AttributeAccessor::adapt_domain(), blender::bke::CurvesGeometry::adapt_domain(), blender::ed::spreadsheet::apply_row_filter(), attr_create_generic(), blender::nodes::node_geo_sample_index_cc::SampleIndexFunction::call(), 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::fn::multi_function::build::detail::execute_element_fn_as_multi_function(), blender::fn::FieldEvaluator::get_evaluated(), blender::fn::FieldEvaluator::get_evaluated_as_mask(), blender::geometry::merge_layers(), blender::fn::multi_function::Params::readonly_single_input(), blender::bke::mesh_surface_sample::sample_corner_attribute(), blender::bke::mesh_surface_sample::sample_face_attribute(), blender::bke::mesh_surface_sample::sample_point_attribute(), and blender::bke::GAttributeReader::typed().

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