XII Release 0.1.0
Loading...
Searching...
No Matches
xiiEditorPreferencesUser Class Reference

Stores editor specific preferences for the current user. More...

#include <EditorPreferences.h>

Inheritance diagram for xiiEditorPreferencesUser:
[legend]

Public Member Functions

void ApplyDefaultValues (xiiEngineViewLightSettings &ref_settings)
 
void SetAsDefaultValues (const xiiEngineViewLightSettings &settings)
 
void SetShowInDevelopmentFeatures (bool b)
 
bool GetShowInDevelopmentFeatures () const
 
void SetHighlightUntranslatedUI (bool b)
 
bool GetHighlightUntranslatedUI () const
 
void SetGizmoSize (float f)
 
float GetGizmoSize () const
 
void SetMaxFramerate (xiiUInt16 uiFPS)
 
xiiUInt16 GetMaxFramerate () const
 
void SetMaxFramerateWhenUnfocused (xiiUInt16 uiFPS)
 
xiiUInt16 GetMaxFramerateWhenUnfocused () const
 
- Public Member Functions inherited from xiiPreferences
Domain GetDomain () const
 Whether the preferences are app, project or document specific.
 
xiiString GetName () const
 Within the same domain and visibility the name must be unique, but across those it can be reused.
 
const xiiDocumentGetDocumentAssociation () const
 If these preferences are per document, the pointer is valid, otherwise nullptr.
 
void TriggerPreferencesChangedEvent ()
 Call this to broadcast that this preference object was modified.
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

float m_fPerspectiveFieldOfView = 70.0f
 
xiiAngle m_RotationSnapValue = xiiAngle::MakeFromDegree(15.0f)
 
float m_fScaleSnapValue = 0.125f
 
float m_fTranslationSnapValue = 0.25f
 
bool m_bUsePrecompiledTools = true
 
xiiString m_sCustomPrecompiledToolsFolder
 
bool m_bLoadLastProjectAtStartup = true
 
bool m_bShowSplashScreen = true
 
bool m_bExpandSceneTreeOnSelection = true
 
bool m_bBackgroundAssetProcessing = false
 
bool m_bHighlightUntranslatedUI = false
 
bool m_bAssetBrowserShowItemsInSubFolders = true
 
bool m_bSkyBox = true
 
bool m_bSkyLight = true
 
xiiString m_sSkyLightCubeMap = "{ 0b202e08-a64f-465d-b38e-15b81d161822 }"
 
float m_fSkyLightIntensity = 1.0f
 
bool m_bDirectionalLight = true
 
xiiAngle m_DirectionalLightAngle = xiiAngle::MakeFromDegree(70.0f)
 
bool m_bDirectionalLightShadows = false
 
float m_fDirectionalLightIntensity = 10.0f
 
bool m_bFog = false
 
bool m_bClearEditorLogsOnPlay = true
 
bool m_bCombinedEditorAndEngineLogs = true
 
xiiHybridArray< xiiString, 8 > m_RecentlyCreatedTypes
 
- Public Attributes inherited from xiiPreferences
xiiEvent< xiiPreferences * > m_ChangedEvent
 A simple event that can be fired when any preference property changes. No specific change details are given.
 

Additional Inherited Members

- Public Types inherited from xiiPreferences
enum class  Domain { Application , Project , Document }
 
- Static Public Member Functions inherited from xiiPreferences
template<typename TYPE>
static TYPE * QueryPreferences (const xiiDocument *pDocument=nullptr)
 Static function to query a preferences object of the given type. If the instance does not exist yet, it is created and the data is restored from file.
 
static xiiPreferencesQueryPreferences (const xiiRTTI *pRtti, const xiiDocument *pDocument=nullptr)
 Static function to query a preferences object of the given type. If the instance does not exist yet, it is created and the data is restored from file.
 
static void SaveDocumentPreferences (const xiiDocument *pDocument)
 Saves all preferences that are tied to the given document.
 
static void ClearDocumentPreferences (const xiiDocument *pDocument)
 Removes all preferences for the given document. Does not save them. Afterwards the preferences will not appear in the UI any further.
 
static void SaveProjectPreferences ()
 Saves all project specific preferences.
 
static void ClearProjectPreferences ()
 Removes all project specific preferences. Does not save them. Afterwards the preferences will not appear in the UI any further.
 
static void SaveApplicationPreferences ()
 Saves all application specific preferences.
 
static void ClearApplicationPreferences ()
 Removes all application specific preferences. Does not save them. Afterwards the preferences will not appear in the UI any further.
 
static void GatherAllPreferences (xiiHybridArray< xiiPreferences *, 16 > &out_allPreferences)
 
- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTIGetStaticRTTI ()
 
- Protected Member Functions inherited from xiiPreferences
 xiiPreferences (Domain domain, const char *szUniqueName)
 
xiiString GetFilePath () const
 

Detailed Description

Stores editor specific preferences for the current user.


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