Blender V4.3
Public Types | Public Member Functions | Protected Attributes | List of all members
blender::fn::FieldInput Class Referenceabstract

#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 ()
 
#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 261 of file FN_field.hh.

Member Enumeration Documentation

◆ Category

enum class blender::fn::FieldInput::Category
strong
Enumerator
NamedAttribute 
Generated 
AnonymousAttribute 
Unknown 

Definition at line 264 of file FN_field.hh.

Constructor & Destructor Documentation

◆ FieldInput()

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

Definition at line 682 of file field.cc.

References blender::fn::FieldNode::field_inputs(), and blender::fn::FieldNode::field_inputs_.

◆ ~FieldInput()

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

Member Function Documentation

◆ category()

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

Definition at line 639 of file FN_field.hh.

References category_.

◆ cpp_type()

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

Definition at line 634 of file FN_field.hh.

References type_.

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

◆ debug_name()

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

Definition at line 629 of file FN_field.hh.

References debug_name_.

◆ 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.

Implemented in blender::bke::CurvesFieldInput, blender::bke::GeometryFieldInput, blender::bke::InstancesFieldInput, blender::bke::MeshFieldInput, blender::bke::PointCloudFieldInput, blender::fn::IndexFieldInput, and blender::fn::tests::IndexFieldInput.

Referenced by blender::bke::GreasePencilLayerFieldContext::get_varray_for_input(), and blender::fn::FieldContext::get_varray_for_input().

◆ output_cpp_type()

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

Implements blender::fn::FieldNode.

Definition at line 644 of file FN_field.hh.

References BLI_assert, type_, and UNUSED_VARS_NDEBUG.

◆ socket_inspection_name()

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

Reimplemented in blender::bke::AttributeFieldInput, blender::bke::IDAttributeFieldInput, and blender::bke::NormalFieldInput.

Definition at line 624 of file FN_field.hh.

References debug_name_.

Member Data Documentation

◆ category_

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

Definition at line 274 of file FN_field.hh.

Referenced by blender::nodes::node_geo_input_mesh_edge_angle_cc::AngleFieldInput::AngleFieldInput(), blender::bke::AttributeExistsFieldInput::AttributeExistsFieldInput(), blender::bke::AttributeFieldInput::AttributeFieldInput(), blender::nodes::node_geo_mesh_face_group_boundaries_cc::BoundaryFieldInput::BoundaryFieldInput(), category(), blender::nodes::node_geo_offset_point_in_curve_cc::ControlPointNeighborFieldInput::ControlPointNeighborFieldInput(), blender::nodes::node_geo_mesh_topology_face_of_corner_cc::CornerFaceIndexInput::CornerFaceIndexInput(), blender::nodes::node_geo_mesh_topology_face_of_corner_cc::CornerIndexInFaceInput::CornerIndexInFaceInput(), blender::nodes::node_geo_mesh_topology_edges_of_corner_cc::CornerNextEdgeFieldInput::CornerNextEdgeFieldInput(), blender::nodes::node_geo_mesh_topology_edges_of_corner_cc::CornerPreviousEdgeFieldInput::CornerPreviousEdgeFieldInput(), blender::nodes::node_geo_mesh_topology_corners_of_edge_cc::CornersOfEdgeCountInput::CornersOfEdgeCountInput(), blender::nodes::node_geo_mesh_topology_corners_of_edge_cc::CornersOfEdgeInput::CornersOfEdgeInput(), blender::nodes::node_geo_mesh_topology_corners_of_face_cc::CornersOfFaceCountInput::CornersOfFaceCountInput(), blender::nodes::node_geo_mesh_topology_corners_of_face_cc::CornersOfFaceInput::CornersOfFaceInput(), blender::nodes::node_geo_mesh_topology_corners_of_vertex_cc::CornersOfVertCountInput::CornersOfVertCountInput(), blender::nodes::node_geo_mesh_topology_corners_of_vertex_cc::CornersOfVertInput::CornersOfVertInput(), blender::nodes::node_geo_mesh_topology_vertex_of_corner_cc::CornerVertFieldInput::CornerVertFieldInput(), blender::bke::CurveLengthFieldInput::CurveLengthFieldInput(), blender::nodes::node_geo_curve_topology_curve_of_point_cc::CurveOfPointInput::CurveOfPointInput(), blender::nodes::node_geo_curve_topology_points_of_curve_cc::CurvePointCountInput::CurvePointCountInput(), blender::nodes::node_geo_curve_topology_points_of_curve_cc::CurveStartPointInput::CurveStartPointInput(), blender::nodes::node_geo_input_mesh_edge_neighbors_cc::EdgeNeighborCountFieldInput::EdgeNeighborCountFieldInput(), blender::nodes::node_geo_input_mesh_edge_vertices_cc::EdgePositionFieldInput::EdgePositionFieldInput(), blender::nodes::node_geo_mesh_topology_edges_of_vertex_cc::EdgesOfVertCountInput::EdgesOfVertCountInput(), blender::nodes::node_geo_mesh_topology_edges_of_vertex_cc::EdgesOfVertInput::EdgesOfVertInput(), blender::nodes::node_geo_input_mesh_edge_vertices_cc::EdgeVertsInput::EdgeVertsInput(), blender::nodes::node_geo_tool_selection_cc::EditSelectionFieldInput::EditSelectionFieldInput(), blender::nodes::node_geo_curve_endpoint_selection_cc::EndpointFieldInput::EndpointFieldInput(), blender::nodes::node_geo_input_mesh_face_area_cc::FaceAreaFieldInput::FaceAreaFieldInput(), blender::nodes::node_geo_curve_handle_type_selection_cc::HandleTypeFieldInput::HandleTypeFieldInput(), blender::bke::IDAttributeFieldInput::IDAttributeFieldInput(), blender::fn::IndexFieldInput::IndexFieldInput(), blender::nodes::node_geo_input_mesh_island_cc::IslandFieldInput::IslandFieldInput(), blender::nodes::node_geo_material_selection_cc::MaterialSelectionFieldInput::MaterialSelectionFieldInput(), blender::bke::NamedLayerSelectionFieldInput::NamedLayerSelectionFieldInput(), blender::bke::NormalFieldInput::NormalFieldInput(), blender::nodes::node_geo_mesh_topology_offset_corner_in_face_cc::OffsetCornerInFaceFieldInput::OffsetCornerInFaceFieldInput(), blender::nodes::node_geo_offset_point_in_curve_cc::OffsetValidFieldInput::OffsetValidFieldInput(), blender::nodes::node_geo_uv_pack_islands_cc::PackIslandsFieldInput::PackIslandsFieldInput(), blender::nodes::node_geo_input_mesh_face_is_planar_cc::PlanarFieldInput::PlanarFieldInput(), blender::nodes::node_geo_curve_topology_curve_of_point_cc::PointIndexInCurveInput::PointIndexInCurveInput(), blender::nodes::node_geo_curve_topology_points_of_curve_cc::PointsOfCurveInput::PointsOfCurveInput(), blender::nodes::node_geo_input_spline_resolution_cc::ResolutionFieldInput::ResolutionFieldInput(), blender::nodes::node_geo_tool_selection_cc::SculptSelectionFieldInput::SculptSelectionFieldInput(), blender::nodes::node_geo_input_mesh_edge_angle_cc::SignedAngleFieldInput::SignedAngleFieldInput(), blender::nodes::node_geo_input_spline_length_cc::SplineCountFieldInput::SplineCountFieldInput(), blender::nodes::node_geo_uv_unwrap_cc::UnwrapFieldInput::UnwrapFieldInput(), blender::nodes::node_geo_input_mesh_vertex_neighbors_cc::VertexCountFieldInput::VertexCountFieldInput(), and blender::nodes::node_geo_input_mesh_vertex_neighbors_cc::VertexFaceCountFieldInput::VertexFaceCountFieldInput().

◆ debug_name_

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

Definition at line 273 of file FN_field.hh.

Referenced by debug_name(), and socket_inspection_name().

◆ type_

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

Definition at line 272 of file FN_field.hh.

Referenced by cpp_type(), blender::bke::AttributeFieldInput::get_varray_for_context(), blender::nodes::node_geo_tool_selection_cc::EditSelectionFieldInput::get_varray_for_context(), blender::nodes::node_geo_tool_selection_cc::SculptSelectionFieldInput::get_varray_for_context(), blender::bke::AttributeFieldInput::hash(), blender::bke::NamedLayerSelectionFieldInput::hash(), blender::bke::AttributeFieldInput::is_equal_to(), and output_cpp_type().

The documentation for this class was generated from the following files:
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0