GraphDocument implements support for creating, loading, saving, and manipulating graph model and canvas graphs. More...

#include <GraphDocument.h>

Inherits AtomToolsFramework::AtomToolsDocument, GraphDocumentRequestBus::Handler, GraphModelIntegration::GraphControllerNotificationBus::Handler, GraphCanvas::SceneNotificationBus::Handler, and AZ::SystemTickBus::Handler.

Public Member Functions
	AZ_RTTI (GraphDocument, "{7AFB5F8B-2E83-47E6-9DC8-AB70E0194D3E}", AtomToolsDocument)

	AZ_CLASS_ALLOCATOR (GraphDocument, AZ::SystemAllocator)

	AZ_DISABLE_COPY_MOVE (GraphDocument)

	GraphDocument (const AZ::Crc32 &toolId, const DocumentTypeInfo &documentTypeInfo, AZStd::shared_ptr< GraphModel::GraphContext > graphContext, AZStd::shared_ptr< GraphCompiler > graphCompiler)

DocumentObjectInfoVector	GetObjectInfo () const override

bool	Open (const AZStd::string &loadPath) override

bool	Save () override

bool	SaveAsCopy (const AZStd::string &savePath) override

bool	SaveAsChild (const AZStd::string &savePath) override

bool	IsModified () const override

bool	BeginEdit () override

bool	EndEdit () override

void	Clear () override

GraphModel::GraphPtr	GetGraph () const override

GraphCanvas::GraphId	GetGraphId () const override

AZStd::string	GetGraphName () const override

void	SetGeneratedFilePaths (const AZStd::vector< AZStd::string > &pathas) override

const AZStd::vector< AZStd::string > &	GetGeneratedFilePaths () const override

bool	CompileGraph () override

void	QueueCompileGraph () override

bool	IsCompileGraphQueued () const override

Public Member Functions inherited from AtomToolsFramework::AtomToolsDocument
	AZ_RTTI (AtomToolsDocument, "{7E6CA0C4-077C-4849-B24C-6796AF3B640B}")

	AZ_CLASS_ALLOCATOR (AtomToolsDocument, AZ::SystemAllocator)

	AZ_DISABLE_COPY_MOVE (AtomToolsDocument)

	AtomToolsDocument (const AZ::Crc32 &toolId, const DocumentTypeInfo &documentTypeInfo)

const DocumentTypeInfo &	GetDocumentTypeInfo () const override

DocumentObjectInfoVector	GetObjectInfo () const override

const AZ::Uuid &	GetId () const override

const AZStd::string &	GetAbsolutePath () const override

bool	Open (const AZStd::string &loadPath) override

bool	Reopen () override

bool	Save () override

bool	SaveAsCopy (const AZStd::string &savePath) override

bool	SaveAsChild (const AZStd::string &savePath) override

bool	Close () override

void	Clear () override

bool	IsOpen () const override

bool	IsModified () const override

bool	CanSaveAsChild () const override

bool	CanUndo () const override

bool	CanRedo () const override

bool	Undo () override

bool	Redo () override

bool	BeginEdit () override

bool	EndEdit () override

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

static DocumentTypeInfo	BuildDocumentTypeInfo (const AZStd::string &documentTypeName, const AZStd::vector< AZStd::string > &documentTypeExtensions, const AZStd::vector< AZStd::string > &documentTypeTemplateExtensions, const AZStd::string &defaultDocumentTypeTemplatePath, AZStd::shared_ptr< GraphModel::GraphContext > graphContext, AZStd::function< AZStd::shared_ptr< GraphCompiler >()> graphCompilerCreateFn={})

Static Public Member Functions inherited from AtomToolsFramework::AtomToolsDocument
static void	Reflect (AZ::ReflectContext *context)

Additional Inherited Members
Protected Types inherited from AtomToolsFramework::AtomToolsDocument
using	UndoRedoFunction = AZStd::function< void()>

using	UndoRedoFunctionPair = AZStd::pair< UndoRedoFunction, UndoRedoFunction >

using	UndoRedoHistory = AZStd::vector< UndoRedoFunctionPair >

Protected Member Functions inherited from AtomToolsFramework::AtomToolsDocument
virtual bool	OpenSucceeded ()

virtual bool	OpenFailed ()

virtual bool	SaveSucceeded ()

virtual bool	SaveFailed ()

virtual bool	ReopenRecordState ()

virtual bool	ReopenRestoreState ()

void	AddUndoRedoHistory (const UndoRedoFunction &undoCommand, const UndoRedoFunction &redoCommand)
	Add new undo redo command functions at the current position in the undo history.

void	SourceFileChanged (AZStd::string relativePath, AZStd::string scanFolder, AZ::Uuid sourceUUID) override

Protected Attributes inherited from AtomToolsFramework::AtomToolsDocument
const AZ::Crc32	m_toolId = {}

const DocumentTypeInfo	m_documentTypeInfo = {}

const AZ::Uuid	m_id = AZ::Uuid::CreateRandom()
	The unique id of this document, used for all bus notifications and requests.

AZStd::string	m_absolutePath
	The absolute path to the document source file.

AZStd::string	m_savePathNormalized
	The normalized, absolute path where the document will be saved.

AZ::RPI::MaterialUtils::ImportedJsonFiles	m_sourceDependencies

bool	m_ignoreSourceFileChangeToSelf = false
	If this flag is true then the next source file change notification for this document will be ignored.

UndoRedoHistory	m_undoHistory

UndoRedoHistory	m_undoHistoryBeforeReopen

int	m_undoHistoryIndex = {}

int	m_undoHistoryIndexBeforeReopen = {}

Detailed Description

GraphDocument implements support for creating, loading, saving, and manipulating graph model and canvas graphs.

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

Gems/Atom/Tools/AtomToolsFramework/Code/Include/AtomToolsFramework/Graph/GraphDocument.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description