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 SocketDeclaration *	panel_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
PanelDeclaration *	parent_panel = nullptr
Public Attributes inherited from blender::nodes::ItemDeclaration
const PanelDeclaration *	parent = nullptr

Friends
class	PanelDeclarationBuilder

Detailed Description

Describes a panel containing sockets or other panels.

Definition at line 487 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

Definition at line 483 of file node_declaration.cc.

References bNodePanelState::flag, identifier, bNodePanelState::identifier, NODE_PANEL_COLLAPSED, SET_FLAG_FROM_TEST, and this.

Referenced by blender::nodes::refresh_node_panel(), and update_or_build().

depth()

int blender::nodes::PanelDeclaration::depth

(

)

const

Definition at line 503 of file node_declaration.cc.

References count, blender::nodes::ItemDeclaration::parent, and parent_panel.

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

matches()

bool blender::nodes::PanelDeclaration::matches

(

const bNodePanelState &

panel

)

const

Definition at line 490 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 513 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

Definition at line 495 of file node_declaration.cc.

References build(), bNodePanelState::flag, NODE_PANEL_COLLAPSED, and SET_FLAG_FROM_TEST.

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

Friends And Related Symbol Documentation

PanelDeclarationBuilder

friend class PanelDeclarationBuilder

friend

Definition at line 501 of file NOD_node_declaration.hh.

Member Data Documentation

default_collapsed

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

Definition at line 493 of file NOD_node_declaration.hh.

Referenced by blender::nodes::PanelDeclarationBuilder::default_closed(), blender::ui::nodes::draw_node_inputs_recursive(), and blender::ed::space_node::ui_node_draw_recursive().

description

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

Definition at line 491 of file NOD_node_declaration.hh.

Referenced by blender::nodes::PanelDeclarationBuilder::description(), and blender::ed::space_node::node_draw_panels().

identifier

int blender::nodes::PanelDeclaration::identifier

Definition at line 489 of file NOD_node_declaration.hh.

Referenced by blender::nodes::DeclarationListBuilder::add_panel(), build(), blender::ui::nodes::draw_node_inputs_recursive(), matches(), blender::nodes::refresh_node_panel(), and blender::ed::space_node::ui_node_draw_recursive().

index

int blender::nodes::PanelDeclaration::index = -1

Index in the list of panels on the node.

Definition at line 496 of file NOD_node_declaration.hh.

Referenced by blender::ed::space_node::add_flat_items_for_panel(), blender::nodes::DeclarationListBuilder::add_panel(), blender::ed::space_node::determine_potentially_visible_panels_recursive(), blender::ed::space_node::determine_visible_panels_impl_recursive(), blender::ed::space_node::mark_sockets_collapsed_recursive(), blender::ed::space_node::node_draw_panels_background(), blender::ed::space_node::node_update_basis_from_declaration(), blender::ed::space_node::tag_final_panel(), and blender::ed::space_node::update_collapsed_sockets_recursive().

items

Vector<ItemDeclaration *> blender::nodes::PanelDeclaration::items

Definition at line 494 of file NOD_node_declaration.hh.

Referenced by blender::ed::space_node::add_flat_items_for_panel(), blender::ed::space_node::determine_potentially_visible_panels_recursive(), blender::ed::space_node::determine_visible_panels_impl_recursive(), blender::ui::nodes::draw_node_inputs_recursive(), blender::ed::space_node::mark_sockets_collapsed_recursive(), blender::ed::space_node::panel_has_only_inactive_inputs(), blender::ui::nodes::panel_has_used_inputs(), panel_input_decl(), blender::ed::space_node::ui_node_draw_recursive(), and blender::ed::space_node::update_collapsed_sockets_recursive().

name

std::string blender::nodes::PanelDeclaration::name

Definition at line 490 of file NOD_node_declaration.hh.

Referenced by blender::nodes::DeclarationListBuilder::add_panel(), blender::ui::nodes::draw_node_inputs_recursive(), blender::ed::space_node::node_draw_panels(), blender::ed::space_node::node_update_basis_from_declaration(), and blender::ed::space_node::ui_node_draw_recursive().

parent_panel

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

Definition at line 497 of file NOD_node_declaration.hh.

Referenced by blender::nodes::DeclarationListBuilder::add_panel(), and depth().

translation_context

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

Definition at line 492 of file NOD_node_declaration.hh.

Referenced by blender::ui::nodes::draw_node_inputs_recursive(), blender::ed::space_node::node_draw_panels(), blender::nodes::PanelDeclarationBuilder::translation_context(), and blender::ed::space_node::ui_node_draw_recursive().

---

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

• NOD_node_declaration.hh
• node_declaration.cc