blender::nodes::PanelDeclaration Class Reference

#include <NOD_node_declaration.hh>

Inherits blender::nodes::ItemDeclaration.

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

Public Attributes
int	identifier
std::string	name
std::string	description
std::string	translation_context
bool	default_collapsed = false
int	num_child_decls = 0
PanelDrawButtonsFunction	draw_buttons = nullptr

Friends
class	PanelDeclarationBuilder

Detailed Description

Describes a panel containing sockets or other panels.

Definition at line 418 of file NOD_node_declaration.hh.

Constructor & Destructor Documentation

~PanelDeclaration()

virtual blender::nodes::PanelDeclaration::~PanelDeclaration ( )

virtualdefault

Member Function Documentation

build()

void blender::nodes::PanelDeclaration::build

(

bNodePanelState &

panel

)

const

Definition at line 382 of file node_declaration.cc.

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

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

matches()

bool blender::nodes::PanelDeclaration::matches

(

const bNodePanelState &

panel

)

const

Definition at line 389 of file node_declaration.cc.

References identifier, and bNodePanelState::identifier.

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

update_or_build()

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

Definition at line 394 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 430 of file NOD_node_declaration.hh.

Member Data Documentation

default_collapsed

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

Definition at line 424 of file NOD_node_declaration.hh.

Referenced by blender::nodes::PanelDeclarationBuilder::default_closed().

description

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

Definition at line 422 of file NOD_node_declaration.hh.

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

draw_buttons

PanelDrawButtonsFunction blender::nodes::PanelDeclaration::draw_buttons = nullptr

Definition at line 426 of file NOD_node_declaration.hh.

Referenced by blender::ed::space_node::add_panel_items_recursive(), blender::nodes::PanelDeclarationBuilder::draw_buttons(), blender::ed::space_node::node_update_panel_items_visibility_recursive(), and blender::ed::space_node::ui_node_draw_panel().

identifier

int blender::nodes::PanelDeclaration::identifier

Definition at line 420 of file NOD_node_declaration.hh.

Referenced by build(), matches(), and blender::nodes::refresh_node_panel().

name

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

Definition at line 421 of file NOD_node_declaration.hh.

Referenced by blender::ed::space_node::add_panel_items_recursive(), blender::ed::space_node::node_draw_panels(), and blender::ed::space_node::ui_node_draw_panel().

num_child_decls

int blender::nodes::PanelDeclaration::num_child_decls = 0

Definition at line 425 of file NOD_node_declaration.hh.

Referenced by blender::nodes::PanelDeclarationBuilder::add_input(), blender::nodes::PanelDeclarationBuilder::add_output(), blender::ed::space_node::add_panel_items_recursive(), blender::nodes::PanelDeclarationBuilder::add_separator(), and blender::ed::space_node::node_update_panel_items_visibility_recursive().

translation_context

std::string blender::nodes::PanelDeclaration::translation_context

Definition at line 423 of file NOD_node_declaration.hh.

---

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

• NOD_node_declaration.hh
• node_declaration.cc