Open 3D Engine PhysX Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Protected Attributes | List of all members
PhysX::PhysXSettingsRegistryManager Class Reference

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

#include <PhysXSettingsRegistryManager.h>

Inherited by PhysX::PhysXEditorSettingsRegistryManager.

Public Types

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)>
 

Public Member Functions

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
 

Protected Attributes

AZStd::string m_settingsRegistryPath
 
AZStd::string m_defaultSceneConfigSettingsRegistryPath
 
AZStd::string m_debugSettingsRegistryPath
 

Detailed Description

Handles loading and saving the settings registry.

Member Function Documentation

◆ LoadDebugConfiguration()

virtual AZStd::optional<Debug::DebugConfiguration> PhysX::PhysXSettingsRegistryManager::LoadDebugConfiguration ( ) const
virtual

Load the PhysX Debug Configuration from the Settings Registry

Returns
Returns true if successful.

◆ LoadDefaultSceneConfiguration()

virtual AZStd::optional<AzPhysics::SceneConfiguration> PhysX::PhysXSettingsRegistryManager::LoadDefaultSceneConfiguration ( ) const
virtual

Load the Default Scene Configuration from the Settings Registry

Returns
Returns true if successful.

◆ LoadSystemConfiguration()

virtual AZStd::optional<PhysXSystemConfiguration> PhysX::PhysXSettingsRegistryManager::LoadSystemConfiguration ( ) const
virtual

Load the PhysX Configuration from the Settings Registry

Returns
Returns true if successful.

◆ SaveDebugConfiguration()

virtual void PhysX::PhysXSettingsRegistryManager::SaveDebugConfiguration ( const Debug::DebugConfiguration &  config,
const OnPhysXDebugConfigSaveComplete &  saveCallback 
) const
virtual

Save the PhysX Debug Configuration from the Settings Registry

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

Reimplemented in PhysX::PhysXEditorSettingsRegistryManager.

◆ SaveDefaultSceneConfiguration()

virtual void PhysX::PhysXSettingsRegistryManager::SaveDefaultSceneConfiguration ( const AzPhysics::SceneConfiguration &  config,
const OnDefaultSceneConfigSaveComplete &  saveCallback 
) const
virtual

Save the Default Scene Configuration from the Settings Registry

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

Reimplemented in PhysX::PhysXEditorSettingsRegistryManager.

◆ SaveSystemConfiguration()

virtual void PhysX::PhysXSettingsRegistryManager::SaveSystemConfiguration ( const PhysXSystemConfiguration &  config,
const OnPhysXConfigSaveComplete &  saveCallback 
) const
virtual

Save the PhysX Configuration from the Settings Registry

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

Reimplemented in PhysX::PhysXEditorSettingsRegistryManager.

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