DIFF

class PPEClassBaseSource

Derived classes
PPEChromAberPPEColorGradingPPEColorsPPEDepthOfField
View all 28 descendants

Created once, on manager init. Script-side representation of C++ material class, separate handling.

Constructors 1

void PPEClassBase(string mat_path_override = "")
References CreateDataStructure(), CreateMaterial(), Init()
Show 1 more, RegisterMaterialParameters()

Members 7

protected PPEManager m_Manager
Referenced by Init(), and OnUpdate()
protected string m_MaterialPath = ""
Referenced by ChangeMaterialPathUsed(), CreateMaterial(), GetCurrentMaterialPath()
Show 1 more, Init()
protected Material m_Material
Referenced by ChangeMaterialPathUsed(), CreateMaterial(), GetMaterial()
Show 1 more, SetFinalParameterValue()
protected ref map<int, ref array<int>> m_ParameterUpdateQueueMap
Referenced by CreateDataStructure(), OnUpdate(), ParamUpdateQueueCleanup()
Show 1 more, SetParameterUpdating()
protected ref array<int> m_ParameterRemovalQueue
Referenced by CreateDataStructure(), ParamUpdateQueueCleanup(), and ParamUpdateRemove()

Methods 29

protected void Init(string mat_path_override = "")
References GetDefaultMaterialPath(), PPEManagerStatic.GetPPEManager(), m_Manager
Show 1 more, m_MaterialPath
Referenced by PPEClassBase()
protected void CreateMaterial()
References World.GetMaterial(), CGame.GetWorld(), m_Material
Show 1 more, m_MaterialPath
Referenced by ChangeMaterialPathUsed(), and PPEClassBase()
Material GetMaterial()
References m_Material
Referenced by PPEManager.ChangePPEMaterial()
protected void CreateDataStructure()
References m_MaterialParamMapStructure, m_ParameterRemovalQueue, m_ParameterUpdateQueueMap
Show 1 more, m_UpdatedParameters
Referenced by PPEClassBase()
protected void RegisterMaterialParameters()

inserted into associative array by parameter int value, parameter registration order does not matter (still ordered, though)

Referenced by PPEClassBase()
protected void RegisterParameterScalarFloatEx(int idx, string parameter_name, float default_value, float min, float max, typename type)

WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

References Class.CastTo(), GetPostProcessEffectID(), new PPETemplateDefFloat()
Show 7 more, PPEMatClassParameterCommandData.RegisterDefaults(), map.Set(), PPEMatClassParameterCommandData.SetMaterialIndex(), PPEMatClassParameterCommandData.SetParameterIndex(), PPEMatClassParameterCommandData.SetParent(), typename.Spawn(), and m_MaterialParamMapStructure
Referenced by PPEColors.RegisterMaterialParameters(), and PPEGlow.RegisterMaterialParameters()
protected void RegisterParameterColor(int idx, string parameter_name, float r, float g, float b, float a)

WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

References GetPostProcessEffectID(), new PPEMatClassParameterColor(), new PPETemplateDefColor()
Show 3 more, PPEMatClassParameterCommandData.RegisterDefaults(), map.Set(), and m_MaterialParamMapStructure
Referenced by PPEColors.RegisterMaterialParameters(), PPEDistort.RegisterMaterialParameters(), PPEGhost.RegisterMaterialParameters()
Show 1 more, PPEGlow.RegisterMaterialParameters()
protected void RegisterParameterColorEx(int idx, string parameter_name, float r, float g, float b, float a, typename type)

WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

References Class.CastTo(), GetPostProcessEffectID(), new PPETemplateDefColor()
Show 7 more, PPEMatClassParameterCommandData.RegisterDefaults(), map.Set(), PPEMatClassParameterCommandData.SetMaterialIndex(), PPEMatClassParameterCommandData.SetParameterIndex(), PPEMatClassParameterCommandData.SetParent(), typename.Spawn(), and m_MaterialParamMapStructure
Referenced by PPEColors.RegisterMaterialParameters(), and PPEGlow.RegisterMaterialParameters()
protected void RegisterParameterTexture(int idx, string parameter_name, string default_path)
References GetPostProcessEffectID(), new PPEMatClassParameterTexture(), new PPETemplateDefTexture()
Show 3 more, PPEMatClassParameterCommandData.RegisterDefaults(), map.Set(), and m_MaterialParamMapStructure
protected void RegisterParameterResource(int idx, string parameter_name, string default_path)
References GetPostProcessEffectID(), new PPEMatClassParameterResource(), new PPETemplateDefResource()
Show 3 more, PPEMatClassParameterCommandData.RegisterDefaults(), map.Set(), and m_MaterialParamMapStructure
void RemoveRequest(int req_idx)

unused, see 'RemoveActiveRequestFromMaterials' for more info

Referenced by PPEManager.RemoveActiveRequestFromMaterials()
void OnUpdate(float timeslice, int order)

generic update method, take care when overriding!

References map.Contains(), Count(), map.Get()
Show 10 more, map.Get(), Get(), GetPostProcessEffectID(), PPEManager.InsertUpdatedMaterial(), InsertUpdatedParameter(), ParamUpdateQueueCleanup(), Update(), m_Manager, m_MaterialParamMapStructure, and m_ParameterUpdateQueueMap
Referenced by PPEManager.ProcessMaterialUpdates()
void SetFinalParameterValue(int parameter_idx)

Clamps the values being set to defaults, if there is no request setting non-zero values on the parameter

References Class.Cast(), Class.Cast(), PPEMatClassParameterCommandData.GetCurrentValues()
Show 8 more, GetParameterCommandData(), PPEMatClassParameterCommandData.GetParameterVarType(), Material.SetParamByIndex(), m_Material, PPEConstants.VAR_TYPE_BOOL, PPEConstants.VAR_TYPE_COLOR, PPEConstants.VAR_TYPE_FLOAT, and PPEConstants.VAR_TYPE_INT
Referenced by ApplyValueChanges()
void ApplyValueChanges()
References array.Clear(), array.Count(), array.Get()
Show 2 more, SetFinalParameterValue(), and m_UpdatedParameters
Referenced by PPEManager.ProcessApplyValueChanges()
protected void InsertUpdatedParameter(int mat_id)
References array.Find(), array.Insert(), and m_UpdatedParameters
Referenced by OnUpdate()
void ParamUpdateRemove(int parameter_idx)

Queue selected parameter for removal from the update queue

References array.Find(), array.Insert(), and m_ParameterRemovalQueue
Referenced by PPEMatClassParameterBool.Update(), PPEMatClassParameterColor.Update(), PPEMatClassParameterFloat.Update()
Show 1 more, PPEMatClassParameterInt.Update()
void SetParameterUpdating(int order, int parameter_id)

Queue specific parameter of this material to update

References map.Contains(), Find(), map.Get()
Show 3 more, Insert(), map.Set(), and m_ParameterUpdateQueueMap
Referenced by PPEManager.SetMaterialParamUpdating()
protected void ParamUpdateQueueCleanup(int order)
References Clear(), Count(), array.Find()
Show 4 more, map.Get(), Get(), m_ParameterRemovalQueue, and m_ParameterUpdateQueueMap
Referenced by OnUpdate()
string GetDefaultMaterialPath()

override this if you want to use different path by default; '.emat' is appended automatically

Referenced by Init()
void ChangeMaterialPathUsed(string path)
References CreateMaterial(), m_Material, and m_MaterialPath
Referenced by PPEManager.ChangePPEMaterial()
string GetCurrentMaterialPath()
References m_MaterialPath
void DbgPrnt(string text)