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::CommandBarPlugin Class Reference

Inherits EMStudio::ToolBarPlugin.

Public Types

enum  { CLASS_ID = 0x00000002 }
 
- Public Types inherited from EMStudio::EMStudioPlugin
enum  EPluginType { PLUGINTYPE_WINDOW = 0 , PLUGINTYPE_TOOLBAR = 1 , PLUGINTYPE_RENDERING = 2 }
 

Public Slots

void OnEnter ()
 
void OnLockSelectionButton ()
 
void ResetGlobalSimSpeed ()
 
void OnGlobalSimSpeedChanged (double value)
 

Public Member Functions

const char * GetName () const override
 
uint32 GetClassID () const override
 
bool GetIsFloatable () const override
 
bool GetIsVertical () const override
 
bool GetIsMovable () const override
 
Qt::ToolBarAreas GetAllowedAreas () const override
 
Qt::ToolButtonStyle GetToolButtonStyle () const override
 
bool Init () override
 
EMStudioPluginClone () const override
 
void UpdateLockSelectionIcon ()
 
void OnProgressStart ()
 
void OnProgressEnd ()
 
void OnProgressText (const char *text)
 
void OnProgressValue (float percentage)
 
- Public Member Functions inherited from EMStudio::ToolBarPlugin
EMStudioPlugin::EPluginType GetPluginType () const override
 
void OnMainWindowClosed () override
 
virtual bool GetIsFloatable () const
 
virtual bool GetIsVertical () const
 
virtual bool GetIsMovable () const
 
virtual Qt::ToolBarAreas GetAllowedAreas () const
 
virtual Qt::ToolButtonStyle GetToolButtonStyle () const
 
virtual void SetInterfaceTitle (const char *name)
 
void CreateBaseInterface (const char *objectName) override
 
QString GetObjectName () const override
 
void SetObjectName (const QString &name) override
 
bool GetHasWindowWithObjectName (const AZStd::string &objectName) override
 
virtual Qt::ToolBarArea GetToolBarCreationArea () const
 
QToolBar * GetToolBar ()
 
- 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)
 

Additional Inherited Members

- Protected Attributes inherited from EMStudio::ToolBarPlugin
QPointer< QToolBar > m_bar
 

Member Function Documentation

◆ Clone()

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

◆ GetAllowedAreas()

Qt::ToolBarAreas EMStudio::CommandBarPlugin::GetAllowedAreas ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::ToolBarPlugin.

◆ GetClassID()

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

◆ GetIsFloatable()

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

Reimplemented from EMStudio::ToolBarPlugin.

◆ GetIsMovable()

bool EMStudio::CommandBarPlugin::GetIsMovable ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::ToolBarPlugin.

◆ GetIsVertical()

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

Reimplemented from EMStudio::ToolBarPlugin.

◆ GetName()

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

◆ GetToolButtonStyle()

Qt::ToolButtonStyle EMStudio::CommandBarPlugin::GetToolButtonStyle ( ) const
inlineoverridevirtual

Reimplemented from EMStudio::ToolBarPlugin.

◆ Init()

bool EMStudio::CommandBarPlugin::Init ( )
overridevirtual

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