Structure used to data drive appearance and other settings for dynamic graph model nodes. More...

#include <DynamicNodeConfig.h>

Public Member Functions
	AZ_CLASS_ALLOCATOR (DynamicNodeConfig, AZ::SystemAllocator)

	AZ_RTTI (DynamicNodeConfig, "{D43A2D1A-B67F-4144-99AF-72EA606CA026}")

	DynamicNodeConfig (const AZStd::string &category, const AZStd::string &title, const AZStd::string &subTitle, const DynamicNodeSettingsMap &settings, const AZStd::vector< DynamicNodeSlotConfig > &inputSlots, const AZStd::vector< DynamicNodeSlotConfig > &outputSlots, const AZStd::vector< DynamicNodeSlotConfig > &propertySlots)

bool	Save (const AZStd::string &path) const

bool	Load (const AZStd::string &path)

void	ValidateSlots ()
	Validate data types, default data types, and default values for all slots on this node.

void	AutoFillMissingData ()
	Automatically fill in the display name and description based off of the slot name if they are empty.

AZStd::vector< AZStd::string >	GetSlotNames () const
	Return the container with the names of all slots on this node.

AZ::Crc32	AddRegisteredSettingGroups ()
	Prompt the user to select and add a settings group to the node configuration.

AZ::Crc32	ResetUuid ()
	Set the UUID to a new random value.

AZStd::string	GetUuidText () const
	Get the display text for the UUID button.

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Public Attributes
AZ::Uuid	m_id = AZ::Uuid::CreateRandom()
	Globally unique identifier for referencing this node config inside of DynamicNodeManager and graphs.

AZStd::string	m_category
	The category will be used by the DynamicNodeManager to sort and group node palette tree items.

AZStd::string	m_title = "untitled"
	Title will be displayed at the top of every DynamicNode in the graph view.

AZStd::string	m_subTitle
	Subtitle will be displayed below the main title of every DynamicNode.

AZStd::string	m_titlePaletteName
	Name of the node title bar UI palette style sheet entry.

AZStd::string	m_description
	Brief description about the node.

AZStd::vector< AZStd::string >	m_slotDataTypeGroups
	Vector of delimited strings, each representing a group of slot names that should share the same type.

DynamicNodeSettingsMap	m_settings
	Settings is a container of key value string pairs that can be used for any custom or application specific data.

AZStd::vector< DynamicNodeSlotConfig >	m_propertySlots
	Property slots is a container of DynamicNodeSlotConfig for property widgets that appear directly on the node.

AZStd::vector< DynamicNodeSlotConfig >	m_inputSlots
	Input slots is a container of DynamicNodeSlotConfig for all inputs into a node.

AZStd::vector< DynamicNodeSlotConfig >	m_outputSlots
	Output slots is a container of DynamicNodeSlotConfig for all outputs from a node.

Detailed Description

Structure used to data drive appearance and other settings for dynamic graph model nodes.

Member Function Documentation

bool AtomToolsFramework::DynamicNodeConfig::Load ( const AZStd::string & path )

Load all of the configuration settings from JSON file at the specified path

Parameters

path	Absolute or aliased path from where the configuration will be loaded

bool AtomToolsFramework::DynamicNodeConfig::Save ( const AZStd::string & path ) const

Save all the configuration settings to a JSON file at the specified path

Parameters

path	Absolute or aliased path where the configuration will be saved

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

Gems/Atom/Tools/AtomToolsFramework/Code/Include/AtomToolsFramework/Graph/DynamicNode/DynamicNodeConfig.h