Open 3D Engine PhysX 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
PhysX::PhysXEditorSettingsRegistryManager Class Reference

Handles loading and saving the settings registry. More...

#include <PhysXEditorSettingsRegistryManager.h>

Inherits PhysX::PhysXSettingsRegistryManager.

Public Member Functions

void SaveSystemConfiguration (const PhysXSystemConfiguration &config, const OnPhysXConfigSaveComplete &saveCallback) const override
 
void SaveDefaultSceneConfiguration (const AzPhysics::SceneConfiguration &config, const OnDefaultSceneConfigSaveComplete &saveCallback) const override
 
void SaveDebugConfiguration (const Debug::DebugConfiguration &config, const OnPhysXDebugConfigSaveComplete &saveCallback) const override
 
- Public Member Functions inherited from PhysX::PhysXSettingsRegistryManager
virtual AZStd::optional< PhysXSystemConfiguration > LoadSystemConfiguration () const
 
virtual AZStd::optional< AzPhysics::SceneConfiguration > LoadDefaultSceneConfiguration () const
 
virtual AZStd::optional< Debug::DebugConfiguration > LoadDebugConfiguration () const
 
virtual void SaveSystemConfiguration (const PhysXSystemConfiguration &config, const OnPhysXConfigSaveComplete &saveCallback) const
 
virtual void SaveDefaultSceneConfiguration (const AzPhysics::SceneConfiguration &config, const OnDefaultSceneConfigSaveComplete &saveCallback) const
 
virtual void SaveDebugConfiguration (const Debug::DebugConfiguration &config, const OnPhysXDebugConfigSaveComplete &saveCallback) const
 

Additional Inherited Members

- Public Types inherited from PhysX::PhysXSettingsRegistryManager
enum class  Result : AZ::u8 { Success , Failed }
 
using OnPhysXConfigSaveComplete = AZStd::function< void(const PhysXSystemConfiguration &, Result)>
 
using OnDefaultSceneConfigSaveComplete = AZStd::function< void(const AzPhysics::SceneConfiguration &, Result)>
 
using OnPhysXDebugConfigSaveComplete = AZStd::function< void(const Debug::DebugConfiguration &, Result)>
 
- Protected Attributes inherited from PhysX::PhysXSettingsRegistryManager
AZStd::string m_settingsRegistryPath
 
AZStd::string m_defaultSceneConfigSettingsRegistryPath
 
AZStd::string m_debugSettingsRegistryPath
 

Detailed Description

Handles loading and saving the settings registry.

Member Function Documentation

◆ SaveDebugConfiguration()

void PhysX::PhysXEditorSettingsRegistryManager::SaveDebugConfiguration ( const Debug::DebugConfiguration &  config,
const OnPhysXDebugConfigSaveComplete &  saveCallback 
) const
overridevirtual

Save the PhysX Debug Configuration from the Settings Registry

Returns
Returns true if successful. When not in Editor, always returns false.

Reimplemented from PhysX::PhysXSettingsRegistryManager.

◆ SaveDefaultSceneConfiguration()

void PhysX::PhysXEditorSettingsRegistryManager::SaveDefaultSceneConfiguration ( const AzPhysics::SceneConfiguration &  config,
const OnDefaultSceneConfigSaveComplete &  saveCallback 
) const
overridevirtual

Save the Default Scene Configuration from the Settings Registry

Returns
Returns true if successful. When not in Editor, always returns false.

Reimplemented from PhysX::PhysXSettingsRegistryManager.

◆ SaveSystemConfiguration()

void PhysX::PhysXEditorSettingsRegistryManager::SaveSystemConfiguration ( const PhysXSystemConfiguration &  config,
const OnPhysXConfigSaveComplete &  saveCallback 
) const
overridevirtual

Save the PhysX Configuration from the Settings Registry

Returns
Returns true if successful. When not in Editor, always returns false.

Reimplemented from PhysX::PhysXSettingsRegistryManager.

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