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

Inherits EMStudio::EMStudioPlugin.

Inherited by EMStudio::ActionHistoryPlugin, EMStudio::AnimGraphPlugin, EMStudio::InspectorWindow, EMStudio::LogWindowPlugin, EMStudio::MorphTargetsWindowPlugin, EMStudio::MotionSetsWindowPlugin, EMStudio::SceneManagerPlugin, EMStudio::TimeViewPlugin, EMotionFX::SimulatedObjectWidget, and EMotionFX::SkeletonOutlinerPlugin.

Public Member Functions

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)
 

Protected Member Functions

QWidget * CreateErrorContentWidget (const char *errorMessage) const
 

Protected Attributes

QPointer< QDockWidget > m_dock
 

Additional Inherited Members

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

Member Function Documentation

◆ CreateBaseInterface()

void EMStudio::DockWidgetPlugin::CreateBaseInterface ( const char *  objectName)
overridevirtual

◆ GetHasWindowWithObjectName()

bool EMStudio::DockWidgetPlugin::GetHasWindowWithObjectName ( const AZStd::string &  objectName)
overridevirtual

◆ GetObjectName()

QString EMStudio::DockWidgetPlugin::GetObjectName ( ) const
inlineoverridevirtual

◆ GetPluginType()

EMStudioPlugin::EPluginType EMStudio::DockWidgetPlugin::GetPluginType ( ) const
inlineoverridevirtual

◆ OnMainWindowClosed()

void EMStudio::DockWidgetPlugin::OnMainWindowClosed ( )
overridevirtual

Reimplemented from EMStudio::EMStudioPlugin.

◆ SetObjectName()

void EMStudio::DockWidgetPlugin::SetObjectName ( const QString &  name)
inlineoverridevirtual

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