#include <BKE_attribute.hh>

Public Member Functions
	operator bool () const
Attribute API
fn::GField	validate_field_if_necessary (const fn::GField &field) const

Public Attributes
const fn::multi_function::MultiFunction *	function

Detailed Description

A utility to make sure attribute values are valid, for attributes like "material_index" which can only be positive, or attributes that represent enum options. This is usually only necessary when writing attributes from an untrusted/arbitrary user input.

Definition at line 227 of file BKE_attribute.hh.

Member Function Documentation

◆ operator bool()

blender::bke::AttributeValidator::operator bool ( ) const

inline

Definition at line 233 of file BKE_attribute.hh.

◆ validate_field_if_necessary()

fn::GField blender::bke::AttributeValidator::validate_field_if_necessary ( const fn::GField & field ) const

Return a field that creates corrected attribute values.

Definition at line 924 of file attribute_access.cc.

References blender::fn::FieldOperation::from(), and function.

Referenced by blender::nodes::compute_attributes_to_store(), and blender::bke::try_capture_fields_on_geometry().

Member Data Documentation

◆ function

const fn::multi_function::MultiFunction* blender::bke::AttributeValidator::function

Single input, single output function that corrects attribute values if necessary.

Definition at line 231 of file BKE_attribute.hh.

Referenced by validate_field_if_necessary(), blender::ed::curves::validate_value(), and blender::ed::pointcloud::validate_value().

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