Blender V4.3
blender::bke::AttributeValidator Struct Reference

#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::MultiFunctionfunction
 

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 195 of file BKE_attribute.hh.

Member Function Documentation

◆ operator bool()

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

Definition at line 201 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 824 of file attribute_access.cc.

References blender::fn::FieldOperation::Create().

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 199 of file BKE_attribute.hh.

Referenced by blender::ed::curves::validate_value().


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