Olympe::EditParameterCommand Class Reference

Command to edit a node parameter. More...

#include <BTEditorCommand.h>

Inheritance diagram for Olympe::EditParameterCommand:

Collaboration diagram for Olympe::EditParameterCommand:

Public Types
enum class	ParamType { String , Int , Float }

Public Member Functions
	EditParameterCommand (BehaviorTreeAsset *tree, uint32_t nodeId, const std::string &paramName, const std::string &oldValue, const std::string &newValue, ParamType type)
void	Execute () override
	Execute the command.
void	Undo () override
	Undo the command.
std::string	GetDescription () const override
	Get a human-readable description of the command.
	EditParameterCommand (int32_t nodeID, const std::string &paramName, const ParameterBinding &oldBinding, const ParameterBinding &newBinding)
void	Execute (TaskGraphTemplate &graph) override
	Applies the command to the graph.
void	Undo (TaskGraphTemplate &graph) override
	Reverses the command on the graph.
std::string	GetDescription () const override
	Get a human-readable description of the command.
Public Member Functions inherited from Olympe::BTEditorCommand
virtual	~BTEditorCommand ()=default
virtual	~BTEditorCommand ()=default
Public Member Functions inherited from Olympe::ICommand
virtual	~ICommand ()=default

Private Attributes
BehaviorTreeAsset *	m_tree
uint32_t	m_nodeId
std::string	m_paramName
std::string	m_oldValue
std::string	m_newValue
ParamType	m_paramType
int32_t	m_nodeID
ParameterBinding	m_oldBinding
ParameterBinding	m_newBinding

Detailed Description

Command to edit a node parameter.

Records an edit to a single named parameter binding on a node.

Stores the old and new ParameterBinding (type + literal value + variable name) so that the change can be reversed via Undo() and re-applied via Execute().

Definition at line 215 of file BTEditorCommand.h.

Member Enumeration Documentation

ParamType

enum class Olympe::EditParameterCommand::ParamType

strong

Enumerator
String
Int
Float

Definition at line 218 of file BTEditorCommand.h.

Constructor & Destructor Documentation

EditParameterCommand() [1/2]

Olympe::EditParameterCommand::EditParameterCommand	(	BehaviorTreeAsset *	tree,
		uint32_t	nodeId,
		const std::string &	paramName,
		const std::string &	oldValue,
		const std::string &	newValue,
		ParamType	type
	)

Definition at line 334 of file BTEditorCommand.cpp.

EditParameterCommand() [2/2]

Olympe::EditParameterCommand::EditParameterCommand	(	int32_t	nodeID,
		const std::string &	paramName,
		const ParameterBinding &	oldBinding,
		const ParameterBinding &	newBinding
	)

Definition at line 603 of file UndoRedoStack.cpp.

Member Function Documentation

Execute() [1/2]

void Olympe::EditParameterCommand::Execute ( )

overridevirtual

Execute the command.

Implements Olympe::BTEditorCommand.

Definition at line 346 of file BTEditorCommand.cpp.

References Float, GetComponentTypeID_Static(), BehaviorTreeAsset::GetNode(), Int, m_newValue, m_nodeId, m_paramName, m_paramType, m_tree, String, and BTNode::stringParams.

Here is the call graph for this function:

Execute() [2/2]

void Olympe::EditParameterCommand::Execute ( TaskGraphTemplate &  graph )

overridevirtual

Applies the command to the graph.

Implements Olympe::ICommand.

Definition at line 613 of file UndoRedoStack.cpp.

References GetComponentTypeID_Static(), m_newBinding, m_nodeID, and m_paramName.

Here is the call graph for this function:

GetDescription() [1/2]

std::string Olympe::EditParameterCommand::GetDescription ( ) const

overridevirtual

Get a human-readable description of the command.

Implements Olympe::BTEditorCommand.

Definition at line 398 of file BTEditorCommand.cpp.

References m_paramName.

GetDescription() [2/2]

std::string Olympe::EditParameterCommand::GetDescription ( ) const

overridevirtual

Get a human-readable description of the command.

Implements Olympe::BTEditorCommand.

Undo() [1/2]

void Olympe::EditParameterCommand::Undo ( )

overridevirtual

Undo the command.

Implements Olympe::BTEditorCommand.

Definition at line 372 of file BTEditorCommand.cpp.

References Float, GetComponentTypeID_Static(), BehaviorTreeAsset::GetNode(), Int, m_nodeId, m_oldValue, m_paramName, m_paramType, m_tree, String, and BTNode::stringParams.

Here is the call graph for this function:

Undo() [2/2]

void Olympe::EditParameterCommand::Undo ( TaskGraphTemplate &  graph )

overridevirtual

Reverses the command on the graph.

Implements Olympe::ICommand.

Definition at line 625 of file UndoRedoStack.cpp.

References GetComponentTypeID_Static(), m_nodeID, m_oldBinding, and m_paramName.

Here is the call graph for this function:

Member Data Documentation

m_newBinding

ParameterBinding Olympe::EditParameterCommand::m_newBinding

private

Definition at line 343 of file UndoRedoStack.h.

Referenced by Execute().

m_newValue

std::string Olympe::EditParameterCommand::m_newValue

private

Definition at line 233 of file BTEditorCommand.h.

Referenced by Execute().

m_nodeId

uint32_t Olympe::EditParameterCommand::m_nodeId

private

Definition at line 230 of file BTEditorCommand.h.

Referenced by Execute(), and Undo().

m_nodeID

int32_t Olympe::EditParameterCommand::m_nodeID

private

Definition at line 340 of file UndoRedoStack.h.

Referenced by Execute(), and Undo().

m_oldBinding

ParameterBinding Olympe::EditParameterCommand::m_oldBinding

private

Definition at line 342 of file UndoRedoStack.h.

Referenced by Undo().

m_oldValue

std::string Olympe::EditParameterCommand::m_oldValue

private

Definition at line 232 of file BTEditorCommand.h.

Referenced by Undo().

m_paramName

std::string Olympe::EditParameterCommand::m_paramName

private

Definition at line 231 of file BTEditorCommand.h.

Referenced by Execute(), Execute(), GetDescription(), Undo(), and Undo().

m_paramType

ParamType Olympe::EditParameterCommand::m_paramType

private

Definition at line 234 of file BTEditorCommand.h.

Referenced by Execute(), and Undo().

m_tree

BehaviorTreeAsset* Olympe::EditParameterCommand::m_tree

private

Definition at line 229 of file BTEditorCommand.h.

Referenced by Execute(), and Undo().

---

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

• Source/_deprecated/BTEditorCommand.h
• Source/BlueprintEditor/UndoRedoStack.h
• Source/_deprecated/BTEditorCommand.cpp
• Source/BlueprintEditor/UndoRedoStack.cpp