|
Blender V5.3
|
#include <NOD_node_declaration.hh>
Inherits blender::nodes::ItemDeclaration.
Inherited by blender::nodes::decl::Bool, blender::nodes::decl::Bundle, blender::nodes::decl::Closure, blender::nodes::decl::Color, blender::nodes::decl::Custom, blender::nodes::decl::Extend, blender::nodes::decl::Float, blender::nodes::decl::Geometry, blender::nodes::decl::IDSocketDeclaration, blender::nodes::decl::Int, blender::nodes::decl::IntVector, blender::nodes::decl::Matrix, blender::nodes::decl::Menu, blender::nodes::decl::Rotation, blender::nodes::decl::Shader, blender::nodes::decl::String, and blender::nodes::decl::Vector.
Public Member Functions | |
| ~SocketDeclaration () override=default | |
| virtual bNodeSocket & | build (bNodeTree &ntree, bNode &node) const=0 |
| virtual bool | matches (const bNodeSocket &socket) const=0 |
| virtual bNodeSocket & | update_or_build (bNodeTree &ntree, bNode &node, bNodeSocket &socket) const |
| virtual bool | can_connect (const bNodeSocket &socket) const=0 |
| void | make_available (bNode &node) const |
| const CompositorInputRealizationMode & | compositor_realization_mode () const |
| int | compositor_domain_priority () const |
| Public Member Functions inherited from blender::nodes::ItemDeclaration | |
| virtual | ~ItemDeclaration ()=default |
Protected Member Functions | |
| void | set_common_flags (bNodeSocket &socket) const |
| bool | matches_common_data (const bNodeSocket &socket) const |
Friends | |
| class | FlatBundleTypeBuilder |
| class | BaseSocketDeclarationBuilder |
| template<typename SocketDecl> | |
| class | SocketDeclarationBuilder |
Describes a single input or output socket. This is subclassed for different socket types.
Definition at line 175 of file NOD_node_declaration.hh.
|
overridedefault |
|
pure virtual |
|
pure virtual |
Determine if a new socket described by this declaration could have a valid connection the other socket.
Definition at line 1046 of file node_declaration.cc.
| const CompositorInputRealizationMode & blender::nodes::SocketDeclaration::compositor_realization_mode | ( | ) | const |
Definition at line 1041 of file node_declaration.cc.
| void blender::nodes::SocketDeclaration::make_available | ( | bNode & | node | ) | const |
Change the node such that the socket will become visible. The node type's update method should be called afterwards.
Definition at line 1051 of file node_declaration.cc.
|
pure virtual |
|
protected |
Definition at line 300 of file node_declaration.cc.
|
protected |
Definition at line 293 of file node_declaration.cc.
|
virtual |
Definition at line 283 of file node_declaration.cc.
|
friend |
Definition at line 254 of file NOD_node_declaration.hh.
|
friend |
Definition at line 253 of file NOD_node_declaration.hh.
|
friend |
Definition at line 255 of file NOD_node_declaration.hh.
Puts this socket on the same line as the previous one in the UI.
Definition at line 202 of file NOD_node_declaration.hh.
Definition at line 195 of file NOD_node_declaration.hh.
| std::unique_ptr<CustomSocketDrawFn> blender::nodes::SocketDeclaration::custom_draw_fn |
Draw function that overrides how the socket is drawn for a specific node.
Definition at line 241 of file NOD_node_declaration.hh.
| NodeDefaultInputType blender::nodes::SocketDeclaration::default_input_type = NodeDefaultInputType::NODE_DEFAULT_INPUT_VALUE |
Some input sockets can have non-trivial values in the case when they are unlinked.
Definition at line 232 of file NOD_node_declaration.hh.
| std::string blender::nodes::SocketDeclaration::description |
Definition at line 180 of file NOD_node_declaration.hh.
Definition at line 194 of file NOD_node_declaration.hh.
Definition at line 179 of file NOD_node_declaration.hh.
Defined by whether the socket is part of the node's input or output socket declaration list. Included here for convenience.
Definition at line 186 of file NOD_node_declaration.hh.
Index in the list of inputs or outputs of the node.
Definition at line 210 of file NOD_node_declaration.hh.
Definition at line 207 of file NOD_node_declaration.hh.
Definition at line 199 of file NOD_node_declaration.hh.
Definition at line 198 of file NOD_node_declaration.hh.
Definition at line 200 of file NOD_node_declaration.hh.
Definition at line 205 of file NOD_node_declaration.hh.
Definition at line 196 of file NOD_node_declaration.hh.
This socket is used as a toggle for the parent panel.
Definition at line 204 of file NOD_node_declaration.hh.
Definition at line 206 of file NOD_node_declaration.hh.
| std::unique_ptr<CustomSocketLabelFn> blender::nodes::SocketDeclaration::label_fn |
Custom label function so a socket can display a different text depending on what it does.
Definition at line 245 of file NOD_node_declaration.hh.
Definition at line 177 of file NOD_node_declaration.hh.
Definition at line 197 of file NOD_node_declaration.hh.
Definition at line 252 of file NOD_node_declaration.hh.
Indicates that the meaning of the socket values is clear even if the label is not shown. This can result in cleaner UIs in some cases. The drawing code will still draw the label sometimes.
Definition at line 193 of file NOD_node_declaration.hh.
Definition at line 178 of file NOD_node_declaration.hh.
| std::unique_ptr<SocketNameRNA> blender::nodes::SocketDeclaration::socket_name_rna |
Property that stores the name of the socket so that it can be modified directly from the node without going to the side-bar.
Definition at line 237 of file NOD_node_declaration.hh.
Socket type that corresponds to this socket declaration.
Definition at line 188 of file NOD_node_declaration.hh.
| StructureType blender::nodes::SocketDeclaration::structure_type = StructureType::Single |
Definition at line 214 of file NOD_node_declaration.hh.
Definition at line 212 of file NOD_node_declaration.hh.
| std::optional<std::string> blender::nodes::SocketDeclaration::translation_context |
Definition at line 181 of file NOD_node_declaration.hh.
Determines whether this socket is used based on other input values and based on which outputs are used.
Definition at line 250 of file NOD_node_declaration.hh.