Blender V5.0
blender::nodes::PanelDeclaration Class Reference

#include <NOD_node_declaration.hh>

Inherits blender::nodes::ItemDeclaration.

Public Member Functions

 ~PanelDeclaration () override=default
void build (bNodePanelState &panel) const
bool matches (const bNodePanelState &panel) const
void update_or_build (const bNodePanelState &old_panel, bNodePanelState &new_panel) const
int depth () const
const SocketDeclarationpanel_input_decl () const
Public Member Functions inherited from blender::nodes::ItemDeclaration
virtual ~ItemDeclaration ()=default

Public Attributes

int identifier
std::string name
std::string description
std::optional< std::string > translation_context
bool default_collapsed = false
Vector< ItemDeclaration * > items
int index = -1
PanelDeclarationparent_panel = nullptr
Public Attributes inherited from blender::nodes::ItemDeclaration
const PanelDeclarationparent = nullptr

Friends

class PanelDeclarationBuilder

Detailed Description

Describes a panel containing sockets or other panels.

Definition at line 522 of file NOD_node_declaration.hh.

Constructor & Destructor Documentation

◆ ~PanelDeclaration()

blender::nodes::PanelDeclaration::~PanelDeclaration ( )
overridedefault

Member Function Documentation

◆ build()

void blender::nodes::PanelDeclaration::build ( bNodePanelState & panel) const

◆ depth()

int blender::nodes::PanelDeclaration::depth ( ) const

◆ matches()

bool blender::nodes::PanelDeclaration::matches ( const bNodePanelState & panel) const

Definition at line 485 of file node_declaration.cc.

References identifier, and bNodePanelState::identifier.

Referenced by blender::nodes::refresh_node_panel().

◆ panel_input_decl()

const nodes::SocketDeclaration * blender::nodes::PanelDeclaration::panel_input_decl ( ) const

Get the declaration for a child item that should be drawn as part of the panel header.

Definition at line 508 of file node_declaration.cc.

References items, SOCK_BOOLEAN, and SOCK_IN.

Referenced by blender::ed::space_node::add_flat_items_for_panel(), and blender::ed::space_node::ui_node_draw_recursive().

◆ update_or_build()

void blender::nodes::PanelDeclaration::update_or_build ( const bNodePanelState & old_panel,
bNodePanelState & new_panel ) const

◆ PanelDeclarationBuilder

friend class PanelDeclarationBuilder
friend

Definition at line 536 of file NOD_node_declaration.hh.

References PanelDeclarationBuilder.

Referenced by PanelDeclarationBuilder.

Member Data Documentation

◆ default_collapsed

bool blender::nodes::PanelDeclaration::default_collapsed = false

◆ description

std::string blender::nodes::PanelDeclaration::description

Definition at line 526 of file NOD_node_declaration.hh.

Referenced by blender::ed::space_node::node_draw_panels().

◆ identifier

◆ index

◆ items

◆ name

◆ parent_panel

PanelDeclaration* blender::nodes::PanelDeclaration::parent_panel = nullptr

◆ translation_context

std::optional<std::string> blender::nodes::PanelDeclaration::translation_context

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