blender::nodes::FieldInput Class Reference

#include <FN_field.hh>

Inherits blender::fn::FieldNode.

Inherited by blender::bke::CurvesFieldInput, blender::bke::GeometryFieldInput, blender::bke::InstancesFieldInput, blender::bke::MeshFieldInput, blender::bke::PointCloudFieldInput, blender::fn::IndexFieldInput, and blender::fn::tests::IndexFieldInput.

Public Types
enum class	Category { NamedAttribute = 0 , Generated = 1 , AnonymousAttribute = 2 , Unknown }

Public Member Functions
virtual GVArray	get_varray_for_context (const FieldContext &context, const IndexMask &mask, ResourceScope &scope) const=0
#FieldInput
	FieldInput (const CPPType &type, std::string debug_name="")
	~FieldInput () override
#FieldInput Inline Methods
virtual std::string	socket_inspection_name () const
blender::StringRef	debug_name () const
const CPPType &	cpp_type () const
Category	category () const
const CPPType &	output_cpp_type (int output_index) const override
Public Member Functions inherited from blender::fn::FieldNode
	FieldNode (FieldNodeType node_type)
FieldNodeType	node_type () const
bool	depends_on_input () const
const std::shared_ptr< const FieldInputs > &	field_inputs () const
virtual uint64_t	hash () const
virtual bool	is_equal_to (const FieldNode &other) const
virtual	~FieldNode ()
virtual void	for_each_field_input_recursive (FunctionRef< void(const FieldInput &)> fn) const

Protected Attributes
const CPPType *	type_
std::string	debug_name_
Category	category_ = Category::Unknown
Protected Attributes inherited from blender::fn::FieldNode
std::shared_ptr< const FieldInputs >	field_inputs_

Detailed Description

A FieldNode that represents an input to the entire field-tree.

Definition at line 259 of file FN_field.hh.

Member Enumeration Documentation

Category

enum class blender::fn::FieldInput::Category

strong

Enumerator
NamedAttribute
Generated
AnonymousAttribute
Unknown

Definition at line 262 of file FN_field.hh.

Constructor & Destructor Documentation

FieldInput()

blender::fn::FieldInput::FieldInput	(	const CPPType &	type,
		std::string	debug_name = "" )

Definition at line 677 of file field.cc.

~FieldInput()

blender::fn::FieldInput::~FieldInput ( )

overridedefault

Member Function Documentation

category()

FieldInput::Category blender::fn::FieldInput::category ( ) const

inline

Definition at line 637 of file FN_field.hh.

cpp_type()

const CPPType & blender::fn::FieldInput::cpp_type ( ) const

inline

Definition at line 632 of file FN_field.hh.

debug_name()

StringRef blender::fn::FieldInput::debug_name ( ) const

inline

Definition at line 627 of file FN_field.hh.

get_varray_for_context()

virtual GVArray blender::fn::FieldInput::get_varray_for_context ( const FieldContext & context, const IndexMask & mask, ResourceScope & scope ) const

pure virtual

Get the value of this specific input based on the given context. The returned virtual array, should live at least as long as the passed in #scope. May return null.

output_cpp_type()

const CPPType & blender::fn::FieldInput::output_cpp_type ( int output_index ) const

inlineoverridevirtual

Implements blender::fn::FieldNode.

Definition at line 642 of file FN_field.hh.

socket_inspection_name()

std::string blender::fn::FieldInput::socket_inspection_name ( ) const

inlinevirtual

Definition at line 622 of file FN_field.hh.

Member Data Documentation

category_

Category blender::fn::FieldInput::category_ = Category::Unknown

protected

Definition at line 272 of file FN_field.hh.

debug_name_

std::string blender::fn::FieldInput::debug_name_

protected

Definition at line 271 of file FN_field.hh.

type_

const CPPType* blender::fn::FieldInput::type_

protected

Definition at line 270 of file FN_field.hh.

---

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

• FN_field.hh
• field.cc