C# Class HoudiniEngineUnity.HEU_PluginStorage

Manages storage for Houdini Engine plugin data.

显示文件 Open project: sideeffects/HoudiniEngineForUnity Class Usage Examples

Public Methods

Method	Description
ClearPluginData ( ) : void	Removes all plugin data from persistent storage.
ConvertEnvKeyedPathToReal ( string inPath ) : string	Convert environment mapped path to real path, if there is a mapping for it. For example, if inPath is $HEU_ENVPATH_HDAS/trees/tree1.hda and mapping is HEU_ENVPATH_HDAS=C:\temp\hdas\ then the result will be C:\temp\hdas\trees/tree1.
ConvertRealPathToEnvKeyedPath ( string inPath ) : string	Convert the given real path to its environment mapped version, if there is a mapping for it. For example, if inPath is C:\temp\hdas\trees\tree1.hda and environment map is HEU_ENVPATH_HDAS=C:\temp\hdas\ then the result will be $HEU_ENVPATH_HDAS/trees\tree1.hda
DeleteAllSavedSessionData ( ) : void	Removes the session data file.
Get ( string key, List &values, char delimiter = ';' ) : bool
Get ( string key, bool &value, bool defaultValue ) : bool
Get ( string key, float &value, float defaultValue ) : bool
Get ( string key, int &value, int defaultValue ) : bool
Get ( string key, long &value, long defaultValue ) : bool
Get ( string key, string &value, string defaultValue ) : bool
GetEnvironmentPathMap ( ) : string>.Dictionary
InstantiateAndLoad ( ) : void	Create new instance if none found. Loads plugin data from file.
LoadAllSessionData ( ) : List	Returns list of session data retrieved from storage.
LoadAssetEnvironmentPaths ( ) : void	Build up the asset environment paths set in unity_houdini.env. The paths must have key prefixes start with HEU_Defines.HEU_ENVPATH_PREFIX. When assets are loaded, these mappings are used to find real paths.
LoadFromSavedFile ( ) : void	Load setings data from saved file.
LoadPluginData ( ) : bool	Load the saved plugin settings from disk.
SaveAllSessionData ( List allSessions ) : void	Save given list of sessions (HEU_SessionData) into storage for retrieval later. A way to persist current session information through code refresh/compiles.
SaveIfRequired ( ) : void	Saves plugin data if there are outstanding changes.
SavePluginData ( ) : bool	Save plugin data to disk.
SessionFilePath ( ) : string
Set ( string key, List values, char delimiter = ';' ) : void
Set ( string key, bool value ) : void
Set ( string key, float value ) : void
Set ( string key, int value ) : void
Set ( string key, long value ) : void
Set ( string key, string value ) : void
SetCurrentCulture ( bool useInvariant ) : void	Sets the System.Threading.Thread.CurrentThread.CurrentCulture to System.Globalization.CultureInfo.InvariantCulture if useInvariant is true. This fixes issues with locale-specific parsing issues such as commas for dots in decimals.
SettingsFilePath ( ) : string

Private Methods

Method	Description
GetJSONArray ( string jsonArray ) : T[]	Retrieve the array from given JSON string.
MarkDirtyForSave ( ) : void	Set flag so that the plugin data will be saved out at end of update.
ReadFromEditorPrefs ( ) : bool

Method Details

ClearPluginData() public static method

Removes all plugin data from persistent storage.

public static ClearPluginData ( ) : void
return	void

ConvertEnvKeyedPathToReal() public method

Convert environment mapped path to real path, if there is a mapping for it. For example, if inPath is $HEU_ENVPATH_HDAS/trees/tree1.hda and mapping is HEU_ENVPATH_HDAS=C:\temp\hdas\ then the result will be C:\temp\hdas\trees/tree1.

public ConvertEnvKeyedPathToReal ( string inPath ) : string
inPath	string
return	string

ConvertRealPathToEnvKeyedPath() public method

Convert the given real path to its environment mapped version, if there is a mapping for it. For example, if inPath is C:\temp\hdas\trees\tree1.hda and environment map is HEU_ENVPATH_HDAS=C:\temp\hdas\ then the result will be $HEU_ENVPATH_HDAS/trees\tree1.hda

public ConvertRealPathToEnvKeyedPath ( string inPath ) : string
inPath	string	The real path to convert
return	string

DeleteAllSavedSessionData() public static method

Removes the session data file.

public static DeleteAllSavedSessionData ( ) : void
return	void

Get() public method

public Get ( string key, List &values, char delimiter = ';' ) : bool
key	string
values	List
delimiter	char
return	bool

Get() public method

public Get ( string key, bool &value, bool defaultValue ) : bool
key	string
value	bool
defaultValue	bool
return	bool

Get() public method

public Get ( string key, float &value, float defaultValue ) : bool
key	string
value	float
defaultValue	float
return	bool

Get() public method

public Get ( string key, int &value, int defaultValue ) : bool
key	string
value	int
defaultValue	int
return	bool

Get() public method

public Get ( string key, long &value, long defaultValue ) : bool
key	string
value	long
defaultValue	long
return	bool

Get() public method

public Get ( string key, string &value, string defaultValue ) : bool
key	string
value	string
defaultValue	string
return	bool

GetEnvironmentPathMap() public method

public GetEnvironmentPathMap ( ) : string>.Dictionary
return	string>.Dictionary

InstantiateAndLoad() public static method

Create new instance if none found. Loads plugin data from file.

public static InstantiateAndLoad ( ) : void
return	void

LoadAllSessionData() public static method

Returns list of session data retrieved from storage.

public static LoadAllSessionData ( ) : List
return	List

LoadAssetEnvironmentPaths() public method

Build up the asset environment paths set in unity_houdini.env. The paths must have key prefixes start with HEU_Defines.HEU_ENVPATH_PREFIX. When assets are loaded, these mappings are used to find real paths.

public LoadAssetEnvironmentPaths ( ) : void
return	void

LoadFromSavedFile() public static method

Load setings data from saved file.

public static LoadFromSavedFile ( ) : void
return	void

LoadPluginData() public method

Load the saved plugin settings from disk.

public LoadPluginData ( ) : bool
return	bool

SaveAllSessionData() public static method

Save given list of sessions (HEU_SessionData) into storage for retrieval later. A way to persist current session information through code refresh/compiles.

public static SaveAllSessionData ( List allSessions ) : void
allSessions	List
return	void

SaveIfRequired() public static method

Saves plugin data if there are outstanding changes.

public static SaveIfRequired ( ) : void
return	void

SavePluginData() public method

Save plugin data to disk.

public SavePluginData ( ) : bool
return	bool

SessionFilePath() public static method

public static SessionFilePath ( ) : string
return	string

Set() public method

public Set ( string key, List values, char delimiter = ';' ) : void
key	string
values	List
delimiter	char
return	void

Set() public method

public Set ( string key, bool value ) : void
key	string
value	bool
return	void

Set() public method

public Set ( string key, float value ) : void
key	string
value	float
return	void

Set() public method

public Set ( string key, int value ) : void
key	string
value	int
return	void

Set() public method

public Set ( string key, long value ) : void
key	string
value	long
return	void

Set() public method

public Set ( string key, string value ) : void
key	string
value	string
return	void

SetCurrentCulture() public static method

Sets the System.Threading.Thread.CurrentThread.CurrentCulture to System.Globalization.CultureInfo.InvariantCulture if useInvariant is true. This fixes issues with locale-specific parsing issues such as commas for dots in decimals.

public static SetCurrentCulture ( bool useInvariant ) : void
useInvariant	bool	True to use InvariatCulture. False will reset to DefaultThreadCurrentCulture.
return	void

SettingsFilePath() public static method

public static SettingsFilePath ( ) : string
return	string