c51eb5b233
Currently, `InferenceValue` contains either a primitive value or is in the "unknown" state. Previously, all code had the assumption that when the value is not unknown, it is a primitive value. However, that may not be true anymore when we support inferencing through e.g. bundles and closures as those are not "primitive". This assumption is removed now, non-primitive values have not been added yet though. Pull Request: https://projects.blender.org/blender/blender/pulls/145532
96 lines
3.5 KiB
C++
96 lines
3.5 KiB
C++
/* SPDX-FileCopyrightText: 2024 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
#include "BLI_array.hh"
|
|
#include "BLI_generic_pointer.hh"
|
|
|
|
#include "BKE_node.hh"
|
|
|
|
#include "NOD_geometry_nodes_execute.hh"
|
|
#include "NOD_socket_usage_inference_fwd.hh"
|
|
#include "NOD_socket_value_inference.hh"
|
|
|
|
struct bNodeTree;
|
|
struct bNodeSocket;
|
|
struct IDProperty;
|
|
|
|
namespace blender::nodes::socket_usage_inference {
|
|
|
|
struct SocketUsageInferencer;
|
|
|
|
class InputSocketUsageParams {
|
|
private:
|
|
SocketUsageInferencer &inferencer_;
|
|
const ComputeContext *compute_context_ = nullptr;
|
|
|
|
public:
|
|
const bNodeTree &tree;
|
|
const bNode &node;
|
|
const bNodeSocket &socket;
|
|
|
|
InputSocketUsageParams(SocketUsageInferencer &inferencer,
|
|
const ComputeContext *compute_context,
|
|
const bNodeTree &tree,
|
|
const bNode &node,
|
|
const bNodeSocket &socket);
|
|
|
|
/**
|
|
* Get an the statically known input value for the given socket identifier. The value may be
|
|
* unknown, in which case null is returned.
|
|
*/
|
|
InferenceValue get_input(StringRef identifier) const;
|
|
|
|
/**
|
|
* Returns true if any output is known to be used or false if no output is used. std::nullopt is
|
|
* returned if it's not known yet if any output is used. In this case, the caller should return
|
|
* early, it will be checked again once new information about output usages becomes available.
|
|
*/
|
|
std::optional<bool> any_output_is_used() const;
|
|
|
|
/**
|
|
* Utility for the case when the socket depends on a specific menu input to have a certain value.
|
|
*/
|
|
bool menu_input_may_be(StringRef identifier, int enum_value) const;
|
|
};
|
|
|
|
/**
|
|
* Get a boolean value for each input socket in the given tree that indicates whether that input is
|
|
* used. It is assumed that all output sockets in the tree are used.
|
|
*/
|
|
Array<SocketUsage> infer_all_input_sockets_usage(const bNodeTree &tree);
|
|
|
|
/**
|
|
* Get a boolean value for each node group input that indicates whether that input is used by the
|
|
* outputs. The result can be used to e.g. gray out or hide individual inputs that are unused.
|
|
*
|
|
* \param group: The node group that is called.
|
|
* \param group_input_values: An optional input value for each node group input. The type is
|
|
* expected to be `bNodeSocketType::base_cpp_type`. If the input value for a socket is not known
|
|
* or can't be represented as base type, null has to be passed instead.
|
|
* \param r_input_usages: The destination array where the inferred usages are written.
|
|
*/
|
|
void infer_group_interface_inputs_usage(const bNodeTree &group,
|
|
Span<InferenceValue> group_input_values,
|
|
MutableSpan<SocketUsage> r_input_usages);
|
|
|
|
/**
|
|
* Same as above, but automatically retrieves the input values from the given sockets..
|
|
* This is used for group nodes.
|
|
*/
|
|
void infer_group_interface_inputs_usage(const bNodeTree &group,
|
|
Span<const bNodeSocket *> input_sockets,
|
|
MutableSpan<SocketUsage> r_input_usages);
|
|
|
|
/**
|
|
* Same as above, but automatically retrieves the input values from the given properties.
|
|
* This is used with the geometry nodes modifier and node tools.
|
|
*/
|
|
void infer_group_interface_inputs_usage(const bNodeTree &group,
|
|
const PropertiesVectorSet &properties,
|
|
MutableSpan<SocketUsage> r_input_usages);
|
|
|
|
} // namespace blender::nodes::socket_usage_inference
|