#include <NOD_fn_format_string.hh>

Inherits blender::nodes::socket_items::SocketItemsAccessorDefaults.

Classes
struct	operator_idnames
struct	ui_idnames
struct	rna_names

Public Types
using	ItemT = NodeFunctionFormatStringItem

Static Public Member Functions
static socket_items::SocketItemsRef< NodeFunctionFormatStringItem >	get_items_from_node (bNode &node)
static void	copy_item (const NodeFunctionFormatStringItem &src, NodeFunctionFormatStringItem &dst)
static void	destruct_item (NodeFunctionFormatStringItem *item)
static void	blend_write_item (BlendWriter *writer, const ItemT &item)
static void	blend_read_data_item (BlendDataReader *reader, ItemT &item)
static eNodeSocketDatatype	get_socket_type (const NodeFunctionFormatStringItem &item)
static char **	get_name (NodeFunctionFormatStringItem &item)
static bool	supports_socket_type (const eNodeSocketDatatype socket_type, const int)
static void	init_with_socket_type_and_name (bNode &node, NodeFunctionFormatStringItem &item, const eNodeSocketDatatype socket_type, const char *name)
static std::string	custom_initial_name (const bNode &node, StringRef src_name)
static std::string	validate_name (const StringRef name)
static std::string	socket_identifier_for_item (const NodeFunctionFormatStringItem &item)

Static Public Attributes
static StructRNA *	item_srna = &RNA_NodeFunctionFormatStringItem
static constexpr StringRefNull	node_idname = "FunctionNodeFormatString"
static constexpr bool	has_type = true
static constexpr bool	has_name = true
static constexpr bool	has_name_validation = true
static constexpr bool	has_custom_initial_name = true
static constexpr char	unique_name_separator = '_'
Static Public Attributes inherited from blender::nodes::socket_items::SocketItemsAccessorDefaults
static constexpr bool	has_single_identifier_str = true
static constexpr bool	has_name_validation = false
static constexpr bool	has_custom_initial_name = false
static constexpr bool	has_vector_dimensions = false
static constexpr bool	can_have_empty_name = false
static constexpr char	unique_name_separator = '.'

Detailed Description

Makes it possible to use various functions (e.g. the ones in NOD_socket_items.hh) for format string items.

Definition at line 17 of file NOD_fn_format_string.hh.

Member Typedef Documentation

◆ ItemT

using blender::nodes::FormatStringItemsAccessor::ItemT = NodeFunctionFormatStringItem

Definition at line 18 of file NOD_fn_format_string.hh.

Member Function Documentation

◆ blend_read_data_item()

void blender::nodes::FormatStringItemsAccessor::blend_read_data_item	(	BlendDataReader *	reader,
		ItemT &	item )

static

Definition at line 803 of file node_fn_format_string.cc.

References BLO_read_string(), and NodeFunctionFormatStringItem::name.

◆ blend_write_item()

void blender::nodes::FormatStringItemsAccessor::blend_write_item	(	BlendWriter *	writer,
		const ItemT &	item )

static

Definition at line 798 of file node_fn_format_string.cc.

References BLO_write_string(), and NodeFunctionFormatStringItem::name.

◆ copy_item()

void blender::nodes::FormatStringItemsAccessor::copy_item	(	const NodeFunctionFormatStringItem &	src,
		NodeFunctionFormatStringItem &	dst )

inlinestatic

Definition at line 46 of file NOD_fn_format_string.hh.

References BLI_strdup_null(), and NodeFunctionFormatStringItem::name.

◆ custom_initial_name()

std::string blender::nodes::FormatStringItemsAccessor::custom_initial_name	(	const bNode &	node,
		StringRef	src_name )

static

Definition at line 808 of file node_fn_format_string.cc.

References i, blender::StringRefBase::is_empty(), and bNode::storage.

◆ destruct_item()

void blender::nodes::FormatStringItemsAccessor::destruct_item ( NodeFunctionFormatStringItem * item )

inlinestatic

Definition at line 52 of file NOD_fn_format_string.hh.

References MEM_SAFE_FREE, and NodeFunctionFormatStringItem::name.

◆ get_items_from_node()

socket_items::SocketItemsRef< NodeFunctionFormatStringItem > blender::nodes::FormatStringItemsAccessor::get_items_from_node ( bNode & node )

inlinestatic

Definition at line 39 of file NOD_fn_format_string.hh.

References bNode::storage.

◆ get_name()

char ** blender::nodes::FormatStringItemsAccessor::get_name ( NodeFunctionFormatStringItem & item )

inlinestatic

Definition at line 65 of file NOD_fn_format_string.hh.

References NodeFunctionFormatStringItem::name.

◆ get_socket_type()

eNodeSocketDatatype blender::nodes::FormatStringItemsAccessor::get_socket_type ( const NodeFunctionFormatStringItem & item )

inlinestatic

Definition at line 60 of file NOD_fn_format_string.hh.

References NodeFunctionFormatStringItem::socket_type.

◆ init_with_socket_type_and_name()

void blender::nodes::FormatStringItemsAccessor::init_with_socket_type_and_name	(	bNode &	node,
		NodeFunctionFormatStringItem &	item,
		const eNodeSocketDatatype	socket_type,
		const char *	name )

inlinestatic

Definition at line 75 of file NOD_fn_format_string.hh.

References NodeFunctionFormatStringItem::identifier, name, blender::nodes::socket_items::set_item_name_and_make_unique(), NodeFunctionFormatStringItem::socket_type, and bNode::storage.

◆ socket_identifier_for_item()

std::string blender::nodes::FormatStringItemsAccessor::socket_identifier_for_item ( const NodeFunctionFormatStringItem & item )

inlinestatic

Definition at line 89 of file NOD_fn_format_string.hh.

References NodeFunctionFormatStringItem::identifier.

Referenced by blender::nodes::node_fn_format_string_cc::node_declare().

◆ supports_socket_type()

bool blender::nodes::FormatStringItemsAccessor::supports_socket_type	(	const eNodeSocketDatatype	socket_type,
		const int	)

inlinestatic

Definition at line 70 of file NOD_fn_format_string.hh.

References ELEM, SOCK_FLOAT, SOCK_INT, and SOCK_STRING.

◆ validate_name()

std::string blender::nodes::FormatStringItemsAccessor::validate_name ( const StringRef name )

static

Definition at line 842 of file node_fn_format_string.cc.

References ELEM, name, and result.

Member Data Documentation

◆ has_custom_initial_name

bool blender::nodes::FormatStringItemsAccessor::has_custom_initial_name = true

staticconstexpr

Definition at line 24 of file NOD_fn_format_string.hh.

◆ has_name

bool blender::nodes::FormatStringItemsAccessor::has_name = true

staticconstexpr

Definition at line 22 of file NOD_fn_format_string.hh.

◆ has_name_validation

bool blender::nodes::FormatStringItemsAccessor::has_name_validation = true

staticconstexpr

Definition at line 23 of file NOD_fn_format_string.hh.

◆ has_type

bool blender::nodes::FormatStringItemsAccessor::has_type = true

staticconstexpr

Definition at line 21 of file NOD_fn_format_string.hh.

◆ item_srna

StructRNA * blender::nodes::FormatStringItemsAccessor::item_srna = &RNA_NodeFunctionFormatStringItem

static

Definition at line 19 of file NOD_fn_format_string.hh.

Referenced by blender::nodes::node_fn_format_string_cc::node_declare().

◆ node_idname

StringRefNull blender::nodes::FormatStringItemsAccessor::node_idname = "FunctionNodeFormatString"

staticconstexpr

Definition at line 20 of file NOD_fn_format_string.hh.

◆ unique_name_separator

char blender::nodes::FormatStringItemsAccessor::unique_name_separator = '_'

staticconstexpr

Definition at line 25 of file NOD_fn_format_string.hh.

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

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ItemT

Member Function Documentation

◆ blend_read_data_item()

◆ blend_write_item()

◆ copy_item()

◆ custom_initial_name()

◆ destruct_item()

◆ get_items_from_node()

◆ get_name()

◆ get_socket_type()

◆ init_with_socket_type_and_name()

◆ socket_identifier_for_item()

◆ supports_socket_type()

◆ validate_name()

Member Data Documentation

◆ has_custom_initial_name

◆ has_name

◆ has_name_validation

◆ has_type

◆ item_srna

◆ node_idname

◆ unique_name_separator