Open 3D Engine EMotionFX 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.
EMStudio::AnimGraphPlugin Class Reference

Inherits EMStudio::DockWidgetPlugin.

Public Types

enum  { CLASS_ID = 0x06def5df }
 
enum  { DISPLAYFLAG_PLAYSPEED = 1 << 0 , DISPLAYFLAG_GLOBALWEIGHT = 1 << 1 , DISPLAYFLAG_SYNCSTATUS = 1 << 2 , DISPLAYFLAG_PLAYPOSITION = 1 << 3 }
 
- Public Types inherited from EMStudio::EMStudioPlugin
enum  EPluginType { PLUGINTYPE_WINDOW = 0 , PLUGINTYPE_TOOLBAR = 1 , PLUGINTYPE_RENDERING = 2 }
 

Public Slots

void OnFileOpen ()
 
void OnFileSave ()
 
void OnFileSaveAs ()
 
void OnDoubleClickedRecorderNodeHistoryItem (EMotionFX::Recorder::ActorInstanceData *actorInstanceData, EMotionFX::Recorder::NodeHistoryItem *historyItem)
 
void OnClickedRecorderNodeHistoryItem (EMotionFX::Recorder::ActorInstanceData *actorInstanceData, EMotionFX::Recorder::NodeHistoryItem *historyItem)
 

Signals

void ActionFilterChanged ()
 

Public Member Functions

const char * GetName () const override
 
uint32 GetClassID () const override
 
bool GetIsClosable () const override
 
bool GetIsFloatable () const override
 
bool GetIsVertical () const override
 
uint32 GetProcessFramePriority () const override
 
void AddWindowMenuEntries (QMenu *parent) override
 
void SetActiveAnimGraph (EMotionFX::AnimGraph *animGraph)
 
EMotionFX::AnimGraphGetActiveAnimGraph ()
 
int OnSaveDirtyAnimGraphs ()
 
PluginOptionsGetOptions () override
 
void LoadOptions ()
 
void SaveOptions ()
 
bool CheckIfCanCreateObject (EMotionFX::AnimGraphObject *parentObject, const EMotionFX::AnimGraphObject *object, EMotionFX::AnimGraphObject::ECategory category) const
 
void ProcessFrame (float timePassedInSeconds) override
 
TimeViewPluginFindTimeViewPlugin () const
 
void RegisterPerFrameCallback (AnimGraphPerFrameCallback *callback)
 
void UnregisterPerFrameCallback (AnimGraphPerFrameCallback *callback)
 
void OnMainWindowClosed () override
 
AnimGraphModelGetAnimGraphModel ()
 
AnimGraphActionManagerGetActionManager ()
 
bool IsAnimGraphActive (EMotionFX::AnimGraph *animGraph) const
 Is the given anim graph running on any selected actor instance?
 
BlendGraphWidgetGetGraphWidget ()
 
NavigateWidgetGetNavigateWidget ()
 
NodePaletteWidgetGetPaletteWidget ()
 
AttributesWindowGetAttributesWindow ()
 
ParameterWindowGetParameterWindow ()
 
BlendGraphViewWidgetGetViewWidget ()
 
NavigationHistoryGetNavigationHistory () const
 
QDockWidget * GetNodePaletteDock ()
 
QDockWidget * GetParameterDock ()
 
void SetDisplayFlagEnabled (uint32 flags, bool enabled)
 
bool GetIsDisplayFlagEnabled (uint32 flags) const
 
uint32 GetDisplayFlags () const
 
const EMotionFX::AnimGraphObjectFactoryGetAnimGraphObjectFactory () const
 
GraphNodeFactoryGetGraphNodeFactory ()
 
void Reflect (AZ::ReflectContext *serializeContext) override
 
bool Init () override
 
void OnAfterLoadLayout () override
 
EMStudioPluginClone () const override
 
const AnimGraphOptionsGetAnimGraphOptions () const
 
void SetDisableRendering (bool flag)
 
bool GetDisableRendering () const
 
void SetActionFilter (const AnimGraphActionFilter &actionFilter)
 
const AnimGraphActionFilterGetActionFilter () const
 
void FileOpen (AZStd::string filename)
 
- Public Member Functions inherited from EMStudio::DockWidgetPlugin
EMStudioPlugin::EPluginType GetPluginType () const override
 
void OnMainWindowClosed () override
 
virtual bool GetIsClosable () const
 
virtual bool GetIsFloatable () const
 
virtual bool GetIsVertical () const
 
virtual bool GetIsMovable () const
 
virtual void SetInterfaceTitle (const char *name)
 
void CreateBaseInterface (const char *objectName) override
 
QString GetObjectName () const override
 
void SetObjectName (const QString &name) override
 
virtual QSize GetInitialWindowSize () const
 
bool GetHasWindowWithObjectName (const AZStd::string &objectName) override
 
QDockWidget * GetDockWidget ()
 
- Public Member Functions inherited from EMStudio::EMStudioPlugin
virtual const char * GetName () const =0
 
virtual uint32 GetClassID () const =0
 
virtual void Reflect (AZ::ReflectContext *)
 
virtual bool Init ()=0
 
virtual EMStudioPluginClone () const =0
 
virtual EMStudioPlugin::EPluginType GetPluginType () const =0
 
virtual void OnAfterLoadLayout ()
 
virtual void OnAfterLoadProject ()
 
virtual void OnAfterLoadActors ()
 
virtual void OnBeforeRemovePlugin (uint32 classID)
 
virtual void OnMainWindowClosed ()
 
virtual void Render (EMotionFX::ActorRenderFlags renderFlags)
 Render function will call atom auxGeom internally to render. This is the replacement for LegacyRender function.
 
virtual PluginOptionsGetOptions ()
 
virtual void WriteLayoutData (MCore::MemoryFile &outFile)
 
virtual bool ReadLayoutSettings (QFile &file, uint32 dataSize, uint32 dataVersion)
 
virtual uint32 GetLayoutDataVersion () const
 
virtual void ProcessFrame (float timePassedInSeconds)
 
virtual uint32 GetProcessFramePriority () const
 
bool operator< (const EMStudioPlugin &plugin)
 
bool operator> (const EMStudioPlugin &plugin)
 
virtual bool GetHasWindowWithObjectName (const AZStd::string &objectName)=0
 
virtual QString GetObjectName () const =0
 
virtual void SetObjectName (const QString &objectName)=0
 
virtual void CreateBaseInterface (const char *objectName)=0
 
virtual bool AllowMultipleInstances () const
 
virtual void AddWindowMenuEntries (QMenu *parent)
 

Static Public Attributes

static constexpr AZStd::string_view s_animGraphWindowShortcutGroupName = "Anim Graph Window"
 
static constexpr AZStd::string_view s_fitEntireGraphShortcutName = "Fit Entire Graph"
 
static constexpr AZStd::string_view s_zoomOnSelectedNodesShortcutName = "Zoom On Selected Nodes"
 
static constexpr AZStd::string_view s_openParentNodeShortcutName = "Open Parent Node"
 
static constexpr AZStd::string_view s_openSelectedNodeShortcutName = "Open Selected Node"
 
static constexpr AZStd::string_view s_historyBackShortcutName = "History Back"
 
static constexpr AZStd::string_view s_historyForwardShortcutName = "History Forward"
 
static constexpr AZStd::string_view s_alignLeftShortcutName = "Align Left"
 
static constexpr AZStd::string_view s_alignRightShortcutName = "Align Right"
 
static constexpr AZStd::string_view s_alignTopShortcutName = "Align Top"
 
static constexpr AZStd::string_view s_alignBottomShortcutName = "Align Bottom"
 
static constexpr AZStd::string_view s_cutShortcutName = "Cut"
 
static constexpr AZStd::string_view s_copyShortcutName = "Copy"
 
static constexpr AZStd::string_view s_pasteShortcutName = "Paste"
 
static constexpr AZStd::string_view s_selectAllShortcutName = "Select All"
 
static constexpr AZStd::string_view s_unselectAllShortcutName = "Unselect All"
 
static constexpr AZStd::string_view s_deleteSelectedNodesShortcutName = "Delete Selected Nodes"
 

Additional Inherited Members

- Protected Member Functions inherited from EMStudio::DockWidgetPlugin
QWidget * CreateErrorContentWidget (const char *errorMessage) const
 
- Protected Attributes inherited from EMStudio::DockWidgetPlugin
QPointer< QDockWidget > m_dock
 

Member Function Documentation

◆ AddWindowMenuEntries()

void EMStudio::AnimGraphPlugin::AddWindowMenuEntries ( QMenu *  parent)
overridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ Clone()

EMStudioPlugin * EMStudio::AnimGraphPlugin::Clone ( ) const
inlineoverridevirtual

◆ GetClassID()

uint32 EMStudio::AnimGraphPlugin::GetClassID ( ) const
overridevirtual

◆ GetIsClosable()

bool EMStudio::AnimGraphPlugin::GetIsClosable ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::DockWidgetPlugin.

◆ GetIsFloatable()

bool EMStudio::AnimGraphPlugin::GetIsFloatable ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::DockWidgetPlugin.

◆ GetIsVertical()

bool EMStudio::AnimGraphPlugin::GetIsVertical ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::DockWidgetPlugin.

◆ GetName()

const char * EMStudio::AnimGraphPlugin::GetName ( ) const
overridevirtual

◆ GetOptions()

PluginOptions * EMStudio::AnimGraphPlugin::GetOptions ( )
inlineoverridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ GetProcessFramePriority()

uint32 EMStudio::AnimGraphPlugin::GetProcessFramePriority ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ Init()

bool EMStudio::AnimGraphPlugin::Init ( )
overridevirtual

◆ OnAfterLoadLayout()

void EMStudio::AnimGraphPlugin::OnAfterLoadLayout ( )
overridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ OnMainWindowClosed()

void EMStudio::AnimGraphPlugin::OnMainWindowClosed ( )
overridevirtual

Reimplemented from EMStudio::DockWidgetPlugin.

◆ ProcessFrame()

void EMStudio::AnimGraphPlugin::ProcessFrame ( float  timePassedInSeconds)
overridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ Reflect()

void EMStudio::AnimGraphPlugin::Reflect ( AZ::ReflectContext *  serializeContext)
overridevirtual

Reimplemented from EMStudio::EMStudioPlugin.


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