Open 3D Engine ScriptCanvasDeveloper Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
ScriptCanvas::Developer::FindGroupPosition Class Reference

#include <UtilityStates.h>

Inherits ScriptCanvas::Developer::CustomActionState.

Public Member Functions

 FindGroupPosition (AutomationStateModelId groupId, AutomationStateModelId outputId, FindPositionOffsets offsets=FindPositionOffsets())
 
void OnCustomAction () override
 
- Public Member Functions inherited from ScriptCanvas::Developer::CustomActionState
 AZ_TYPE_INFO (CustomActionState, "{DA39829B-08F8-47BF-890D-9DA695BAD5A0}")
 
 CustomActionState (const char *name)
 
void OnSetupStateActions (EditorAutomationActionRunner &) override final
 
void OnStateActionsComplete () override final
 
virtual void OnCustomAction ()=0
 
- Public Member Functions inherited from ScriptCanvas::Developer::NamedAutomationState
 AZ_TYPE_INFO (NamedAutomationState, "{62DD037C-D80F-4B1B-9F3E-9F05400ABA24}")
 
 NamedAutomationState (const char *name)
 
 NamedAutomationState (const AZStd::string &stateName)
 
int GetStateId () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::EditorAutomationState
 AZ_TYPE_INFO (EditorAutomationState, "{B18A0531-E3C2-4209-8A9E-1B0195C28443}")
 
 AZ_CLASS_ALLOCATOR (EditorAutomationState, AZ::SystemAllocator)
 
virtual int GetStateId () const =0
 
virtual const char * GetStateName () const =0
 
void SetStateModel (StateModel *stateModel)
 
template<typename T >
void SetModelData (StateModel::DataKey dataKey, const T &modelData)
 
template<typename T >
const T * GetModelData (StateModel::DataKey dataKey)
 
StateModel * GetStateModel () const
 
void SetupStateActions (EditorAutomationActionRunner &actionRunner)
 
void StateActionsComplete ()
 
bool HasErrors () const
 
void ReportError (AZStd::string error)
 
const AZStd::string & GetError () const
 

Additional Inherited Members

- Static Public Attributes inherited from ScriptCanvas::Developer::EditorAutomationState
static constexpr int EXIT_STATE_ID = (-1)
 
- Protected Member Functions inherited from ScriptCanvas::Developer::NamedAutomationState
void SetStateName (const AZStd::string &stateName)
 
const char * GetStateName () const override
 
virtual void OnSetupStateActions (EditorAutomationActionRunner &actionRunner)=0
 
virtual void OnStateActionsComplete ()
 

Detailed Description

EditorAutomationState that will find the group position and store it in the supplied id.

  • By default will return the 'center' of the node. The offset vector will determine a direction on the node to offset to the edge of, and the length deterines how much extra space to apply in that offset direction

    0 is right/up, 1 is left/down

Member Function Documentation

◆ OnCustomAction()

void ScriptCanvas::Developer::FindGroupPosition::OnCustomAction ( )
overridevirtual

Implements ScriptCanvas::Developer::CustomActionState.

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