PPEManager.c File Reference

Go to the source code of this file.

Classes
class	PPEManagerStatic
	Static component of PPE manager, used to hold the instance. More...

Functions
void	PPEManager ()
void	Cleanup ()
void	Init ()
	Launched from 'DayZGame.DeferredInit' to make earlier access, use, and updates impossible (downside of a non-static system)
void	InitPPEManagerClassMap ()
	Ordered by 'PostProcessEffectType' for easy access through the same enum; ID saved all the same.
void	RegisterPPEClass (PPEClassBase material_class)
	Registeres material class and creates data structure within.
void	SendMaterialValueData (PPERequestParamDataBase data)
void	SetMaterialParamUpdating (int material_id, int parameter_id, int order)
	Queues material/parameter to update (once)
void	RemoveMaterialUpdating (int material_id, int order=0)
	Currently unused, requests remain in the hierarchy and are used when needed (slightly faster than constantly re-shuffilng the arrays)
void	ClearMaterialUpdating ()
void	SetRequestActive (PPERequesterBase request, bool active)
	Marks requester as 'active'. Currently indistinguiishable from 'updating' requester, can potentially be used for intermittently updated requesters.
void	SetRequestUpdating (PPERequesterBase request, bool active)
	Marks requester as 'updating' and to be processed on manager update.
bool	GetExistingRequester (typename req, out PPERequesterBase ret)
bool	IsAnyRequesterRunning (array< typename > requesters)
void	RemoveActiveRequestFromMaterials (PPERequesterBase req)
void	RequestsCleanup ()
	Unused cleanup method, should it be ever needed.
void	InsertUpdatedMaterial (int mat_id)
	Marks material class as updated and values to be set in the course of update - 'ProcessApplyValueChanges'.
void	ProcessRequesterUpdates (float timeslice)
void	ProcessMaterialUpdates (float timeslice)
void	ProcessApplyValueChanges ()
void	Update (float timeslice)
Param	GetPostProcessDefaultValues (int material, int parameter)
	Returns default values as Param. See 'PPEConstants' file for various typedefs used.
Param	GetPostProcessCurrentValues (int material, int parameter)
	Returns current values as Param. See 'PPEConstants' file for various typedefs used.
void	ChangePPEMaterial (PostProcessPrioritiesCamera priority, PostProcessEffectType type, string path, bool scriptside_only)
	Changes material file associated with the script material class. Will be used very rarely, mostly set in C++ anyway.
void	StopAllEffects (int mask=0)
	stops all effects of a certain kind
void	DbgPrnt (string text)

Variables
class PPEManagerStatic	CAMERA_ID = 0
bool	m_ManagerInitialized
ref map< int, ref PPEClassBase >	m_PPEClassMap
ref map< int, ref array< int > >	m_PPEMaterialUpdateQueueMap
ref array< int >	m_UpdatedMaterials
ref array< ref PPERequesterBase >	m_ExistingPostprocessRequests
ref array< ref PPERequesterBase >	m_UpdatingRequests

Function Documentation

ChangePPEMaterial()

void ChangePPEMaterial ( PostProcessPrioritiesCamera priority, PostProcessEffectType type, string path, bool scriptside_only )

protected

Changes material file associated with the script material class. Will be used very rarely, mostly set in C++ anyway.

Definition at line 344 of file PPEManager.c.

  {
    if (m_PPEClassMap.Contains(type))
    {
      PPEClassBase mat_class = m_PPEClassMap.Get(type);
      typename name = mat_class.Type();
      PPEClassBase postprocess_capsule = PPEClassBase.Cast(name.Spawn());
      postprocess_capsule.ChangeMaterialPathUsed(path);
 
      if (postprocess_capsule.GetMaterial() == 0x0)
      {
        Debug.Log("PPEManager | Invalid material path " + path + " used for " + name);
        return;
      }
 
      //m_PPEClassMap.Remove(type);
      m_PPEClassMap.Set(type, postprocess_capsule);
    }
 
    //can be sent script-side only to adapt to c++ options changes
    if (!scriptside_only)
      SetCameraPostProcessEffect(CAMERA_ID, priority, type, path);
  }

References CAMERA_ID, Debug::Log(), m_PPEClassMap, name, path, and SetCameraPostProcessEffect().

Cleanup()

void Cleanup ( )

protected

Definition at line 70 of file PPEManager.c.

  {
    PPERequesterBank.Cleanup();
 
    if (m_ManagerInitialized)
    {
      m_PPEMaterialUpdateQueueMap.Clear();
      m_ExistingPostprocessRequests.Clear();
      m_UpdatingRequests.Clear();
      m_PPEClassMap.Clear();
    }
  }

References m_ExistingPostprocessRequests, m_ManagerInitialized, m_PPEClassMap, m_PPEMaterialUpdateQueueMap, and m_UpdatingRequests.

ClearMaterialUpdating()

void ClearMaterialUpdating ( )

protected

Definition at line 183 of file PPEManager.c.

  {
    m_PPEMaterialUpdateQueueMap.Clear();
  }

References m_PPEMaterialUpdateQueueMap.

Referenced by ProcessApplyValueChanges().

DbgPrnt()

void DbgPrnt ( string text )

protected

Definition at line 381 of file PPEManager.c.

  {
    //Debug.Log(""+text);
  }

GetExistingRequester()

bool GetExistingRequester ( typename req , out PPERequesterBase ret )

protected

Definition at line 220 of file PPEManager.c.

  {
    int idx = m_ExistingPostprocessRequests.Find(PPERequesterBank.GetRequester(req));
    if (idx > -1)
    {
      ret = m_ExistingPostprocessRequests.Get(idx);
      return true;
    }
    return false;
  }

References m_ExistingPostprocessRequests.

Referenced by IsAnyRequesterRunning().

GetPostProcessCurrentValues()

Param GetPostProcessCurrentValues ( int material, int parameter )

protected

Returns current values as Param. See 'PPEConstants' file for various typedefs used.

Definition at line 335 of file PPEManager.c.

  {
    PPEClassBase mat_class = m_PPEClassMap.Get(material);
    return mat_class.GetParameterCommandData(parameter).GetCurrentValues();
  }

References m_PPEClassMap.

GetPostProcessDefaultValues()

Param GetPostProcessDefaultValues ( int material, int parameter )

protected

Returns default values as Param. See 'PPEConstants' file for various typedefs used.

Definition at line 328 of file PPEManager.c.

  {
    PPEClassBase mat_class = m_PPEClassMap.Get(material);
    return mat_class.GetParameterCommandData(parameter).GetDefaultValues();
  }

References m_PPEClassMap.

Init()

void Init ( )

protected

Launched from 'DayZGame.DeferredInit' to make earlier access, use, and updates impossible (downside of a non-static system)

Definition at line 84 of file PPEManager.c.

  {
    //DbgPrnt("PPEDebug | PPEManager | m_ManagerInitialized: " + m_ManagerInitialized);
    if (!m_ManagerInitialized)
    {
      m_PPEMaterialUpdateQueueMap = new map<int, ref array<int>>;
      m_UpdatedMaterials = new array<int>;
      m_ExistingPostprocessRequests = new array<ref PPERequesterBase>;
      m_UpdatingRequests = new array<ref PPERequesterBase>;
      InitPPEManagerClassMap();
 
      GetGame().GetUpdateQueue(CALL_CATEGORY_GUI).Insert(this.Update); //can be safely and easily 'disabled' here
      m_ManagerInitialized = true;
    }
  }

References CALL_CATEGORY_GUI, GetGame(), InitPPEManagerClassMap(), m_ExistingPostprocessRequests, m_ManagerInitialized, m_PPEMaterialUpdateQueueMap, m_UpdatedMaterials, m_UpdatingRequests, and Update().

InitPPEManagerClassMap()

void InitPPEManagerClassMap ( )

protected

Ordered by 'PostProcessEffectType' for easy access through the same enum; ID saved all the same.

Definition at line 101 of file PPEManager.c.

  {
    if (m_PPEClassMap)
      delete m_PPEClassMap;
    m_PPEClassMap = new map<int, ref PPEClassBase>;
 
    RegisterPPEClass(new PPENone()); //dummy
    RegisterPPEClass(new PPEUnderWater());
    RegisterPPEClass(new PPESSAO());
    RegisterPPEClass(new PPEDepthOfField());
    RegisterPPEClass(new PPEHBAO());
    RegisterPPEClass(new PPERotBlur());
    RegisterPPEClass(new PPEGodRays());
    RegisterPPEClass(new PPERain());
    RegisterPPEClass(new PPEFilmGrain());
    RegisterPPEClass(new PPERadialBlur());
    RegisterPPEClass(new PPEChromAber());
    RegisterPPEClass(new PPEWetDistort());
    RegisterPPEClass(new PPEDynamicBlur());
    RegisterPPEClass(new PPEColorGrading());
    RegisterPPEClass(new PPEColors());
    RegisterPPEClass(new PPEGlow());
    RegisterPPEClass(new PPESMAA());
    RegisterPPEClass(new PPEFXAA());
    RegisterPPEClass(new PPEMedian());
    RegisterPPEClass(new PPESunMask());
    RegisterPPEClass(new PPEGaussFilter());
    RegisterPPEClass(new PPEExposureNative());
    RegisterPPEClass(new PPEEyeAccomodationNative());
    RegisterPPEClass(new PPEDOF());
    RegisterPPEClass(new PPELightIntensityParamsNative());
  }

References m_PPEClassMap, and RegisterPPEClass().

Referenced by Init().

InsertUpdatedMaterial()

void InsertUpdatedMaterial ( int mat_id )

protected

Marks material class as updated and values to be set in the course of update - 'ProcessApplyValueChanges'.

Definition at line 266 of file PPEManager.c.

  {
    if (m_UpdatedMaterials.Find(mat_id) == -1)
      m_UpdatedMaterials.Insert(mat_id);
  }

References m_UpdatedMaterials.

IsAnyRequesterRunning()

bool IsAnyRequesterRunning ( array< typename > requesters )

protected

Definition at line 231 of file PPEManager.c.

  {
    foreach (typename requesterType : requesters)
    {
      PPERequesterBase ppeRequester;
      GetExistingRequester(requesterType, ppeRequester);
      if (ppeRequester && ppeRequester.IsRequesterRunning())
        return true;
    }
 
    return false;
  }

References GetExistingRequester().

PPEManager()

void PPEManager ( )

protected

Definition at line 64 of file PPEManager.c.

  {
    m_ManagerInitialized = false;
    PPERequesterBank.Init();
  }

References m_ManagerInitialized.

Referenced by PPEManagerStatic::CreateManagerStatic().

ProcessApplyValueChanges()

void ProcessApplyValueChanges ( )

protected

Definition at line 302 of file PPEManager.c.

  {
    int material_id;
    for (int i = 0; i < m_UpdatedMaterials.Count(); i++)
    {
      material_id = m_UpdatedMaterials.Get(i);
      PPEClassBase mat_class = m_PPEClassMap.Get(material_id);
      mat_class.ApplyValueChanges();
    }
 
    m_UpdatedMaterials.Clear();
    ClearMaterialUpdating();
  }

References ClearMaterialUpdating(), m_PPEClassMap, and m_UpdatedMaterials.

Referenced by Update().

ProcessMaterialUpdates()

void ProcessMaterialUpdates ( float timeslice )

protected

Definition at line 287 of file PPEManager.c.

  {
    for (int i = 0; i < m_PPEMaterialUpdateQueueMap.Count(); i++) //orders (levels?)
    {
      //DbgPrnt("PPEDebug | ProcessMaterialUpdates | GetKey " + i + ": " + m_PPEMaterialUpdateQueueMap.GetKey(i));
      //DbgPrnt("PPEDebug | ProcessMaterialUpdates | GetElement - count " + i + ": " + m_PPEMaterialUpdateQueueMap.GetElement(i).Count());
 
      for (int j = 0; j < m_PPEMaterialUpdateQueueMap.GetElement(i).Count(); j++)
      {
        PPEClassBase mat_class = m_PPEClassMap.Get(m_PPEMaterialUpdateQueueMap.GetElement(i).Get(j));
        mat_class.OnUpdate(timeslice, i);
      }
    }
  }

References Count, m_PPEClassMap, and m_PPEMaterialUpdateQueueMap.

Referenced by Update().

ProcessRequesterUpdates()

void ProcessRequesterUpdates ( float timeslice )

protected

Definition at line 275 of file PPEManager.c.

  {
    PPERequesterBase req;
    for (int i = 0; i < m_UpdatingRequests.Count(); i++)
    {
      //DbgPrnt("PPEDebug | ProcessRequesterUpdates | m_UpdatingRequests[i]: " + m_UpdatingRequests[i]);
      req = m_UpdatingRequests.Get(i);
      if (req)
        req.OnUpdate(timeslice);
    }
  }

References m_UpdatingRequests.

Referenced by Update().

RegisterPPEClass()

void RegisterPPEClass ( PPEClassBase material_class )

protected

Registeres material class and creates data structure within.

Definition at line 135 of file PPEManager.c.

  {
    m_PPEClassMap.Set(material_class.GetPostProcessEffectID(), material_class);
  }

References m_PPEClassMap.

Referenced by InitPPEManagerClassMap().

RemoveActiveRequestFromMaterials()

void RemoveActiveRequestFromMaterials ( PPERequesterBase req )

protected

/brief Originally designed to rip the requester data from all relevant mat/params, but that proved too costly and volatile. /note Still, it is here, use at your own peril.

Definition at line 248 of file PPEManager.c.

  {
    int count = req.GetActiveRequestStructure().Count();
    int mat_id;
    for (int i = 0; i < count; i++)
    {
      mat_id = req.GetActiveRequestStructure().GetKey(i);
      PPEClassBase mat_class = m_PPEClassMap.Get(mat_id);
      mat_class.RemoveRequest(req.GetRequesterIDX());
    }
  }

References m_PPEClassMap.

RemoveMaterialUpdating()

void RemoveMaterialUpdating ( int material_id, int order = 0 )

protected

Currently unused, requests remain in the hierarchy and are used when needed (slightly faster than constantly re-shuffilng the arrays)

Definition at line 172 of file PPEManager.c.

  {
    if (m_PPEMaterialUpdateQueueMap.Contains(order))
    {
      m_PPEMaterialUpdateQueueMap.Get(order).RemoveItem(material_id);
 
      if (m_PPEMaterialUpdateQueueMap.Get(order).Count() == 0)
        m_PPEMaterialUpdateQueueMap.Remove(order);
    }
  }

References m_PPEMaterialUpdateQueueMap.

RequestsCleanup()

void RequestsCleanup ( )

protected

Unused cleanup method, should it be ever needed.

Definition at line 261 of file PPEManager.c.

  {
  }

Referenced by Update().

SendMaterialValueData()

void SendMaterialValueData ( PPERequestParamDataBase data )

protected

Definition at line 140 of file PPEManager.c.

  {
    //DbgPrnt("DataVerification | m_ColorTarget | SendMaterialValueData: " + PPERequestParamDataColor.Cast(data).m_ColorTarget[0] + "/" + PPERequestParamDataColor.Cast(data).m_ColorTarget[1] + "/" + PPERequestParamDataColor.Cast(data).m_ColorTarget[2] + "/" + PPERequestParamDataColor.Cast(data).m_ColorTarget[3]);
    PPEClassBase mat_class = m_PPEClassMap.Get(data.GetMaterialID());
    mat_class.InsertParamValueData(data);
    SetMaterialParamUpdating(data.GetMaterialID(), data.GetParameterID(), PPEConstants.DEPENDENCY_ORDER_BASE);
  }

References m_PPEClassMap, and SetMaterialParamUpdating().

SetMaterialParamUpdating()

void SetMaterialParamUpdating ( int material_id, int parameter_id, int order )

protected

Queues material/parameter to update (once)

Definition at line 149 of file PPEManager.c.

  {
    if (order > PPEConstants.DEPENDENCY_ORDER_HIGHEST)
    {
      //DbgPrnt("PPEDebug | PPEManager - SetMaterialParamUpdating | Order higher than max, ignoring! | mat/par/ord: " + material_id + "/" + parameter_id + "/" + order);
      return;
    }
 
    PPEClassBase mat_class = m_PPEClassMap.Get(material_id);
 
    //DbgPrnt("PPEDebug | PPEManager - SetMaterialParamUpdating | mat/par: " + material_id + "/" + parameter_id);
    //insert material into queue
    if (!m_PPEMaterialUpdateQueueMap.Contains(order))
      m_PPEMaterialUpdateQueueMap.Set(order, new array<int>);
 
    int found = m_PPEMaterialUpdateQueueMap.Get(order).Find(material_id);
    if (found == -1)
      m_PPEMaterialUpdateQueueMap.Get(order).Insert(material_id);
 
    mat_class.SetParameterUpdating(order, parameter_id);
  }

References m_PPEClassMap, and m_PPEMaterialUpdateQueueMap.

Referenced by SendMaterialValueData().

SetRequestActive()

void SetRequestActive ( PPERequesterBase request, bool active )

protected

Marks requester as 'active'. Currently indistinguiishable from 'updating' requester, can potentially be used for intermittently updated requesters.

Definition at line 189 of file PPEManager.c.

  {
    int found = m_ExistingPostprocessRequests.Find(request);
    if (active && found == -1)
      m_ExistingPostprocessRequests.Insert(request);
    else if (!active && found > -1) //should always be found in this case, redundant?
    {
      //RemoveActiveRequestFromMaterials(request);
 
      m_ExistingPostprocessRequests.Remove(found);
    }
  }

References m_ExistingPostprocessRequests.

SetRequestUpdating()

void SetRequestUpdating ( PPERequesterBase request, bool active )

protected

Marks requester as 'updating' and to be processed on manager update.

Definition at line 203 of file PPEManager.c.

  {
    if (!m_UpdatingRequests)
    {
      Debug.Log("PPEManager | SetRequestUpdating | !m_UpdatingRequests");
      return;
    }
 
    int idx = m_UpdatingRequests.Find(request);
 
    if (active && idx == -1)
      m_UpdatingRequests.Insert(request);
    else if (!active && idx > -1)
      m_UpdatingRequests.Remove(idx);
  }

References Debug::Log(), and m_UpdatingRequests.

StopAllEffects()

void StopAllEffects ( int mask = 0 )

protected

stops all effects of a certain kind

Definition at line 369 of file PPEManager.c.

  {
    if (m_ExistingPostprocessRequests)
    {
      foreach (PPERequesterBase requester : m_ExistingPostprocessRequests)
      {
        if (requester.GetCategoryMask() & mask)
          requester.Stop();
      }
    }
  }

References m_ExistingPostprocessRequests.

Update()

void Update ( float timeslice )

protected

Definition at line 316 of file PPEManager.c.

  {
    if (!m_ManagerInitialized)
      return;
 
    ProcessRequesterUpdates(timeslice);
    ProcessMaterialUpdates(timeslice);
    ProcessApplyValueChanges();
    RequestsCleanup(); //unused
  }

References m_ManagerInitialized, ProcessApplyValueChanges(), ProcessMaterialUpdates(), ProcessRequesterUpdates(), and RequestsCleanup().

Variable Documentation

CAMERA_ID

class PPEManagerStatic CAMERA_ID = 0

/brief Postprocess manager, responsible for updates, receiving, and re-distributing requester data to their respective destinations. /par Basic post process flow outline: Getting a registered 'PPERequester' instance from the 'PPERequesterBank'

/par Launching the requester, either through an overriden 'Start' method, or custom method with some setters (both flag it as active and to be processed)

/par On render update, PPEManager: Handles queued requester changes, re-distributes individual commands to material structure

/par Updates the material/parameter structure and calculates the blend values

/par Sets the final values via native functions (only called once per changed parameter - optimization stonks)

/note Requester serves as a centralized platform for specific effec/group of effects. Although technically the direct commands to mat/param would be feasible, this allows for easier control of effect groups, /note and clearer command hierarchy (no value setters without clear parentage).

Referenced by ChangePPEMaterial().

m_ExistingPostprocessRequests

ref array<ref PPERequesterBase> m_ExistingPostprocessRequests

protected

Definition at line 61 of file PPEManager.c.

Referenced by Cleanup(), GetExistingRequester(), Init(), SetRequestActive(), and StopAllEffects().

m_ManagerInitialized

bool m_ManagerInitialized

protected

Definition at line 57 of file PPEManager.c.

Referenced by Cleanup(), Init(), PPEManager(), and Update().

m_PPEClassMap

ref map<int, ref PPEClassBase> m_PPEClassMap

protected

Definition at line 58 of file PPEManager.c.

Referenced by ChangePPEMaterial(), Cleanup(), GetPostProcessCurrentValues(), GetPostProcessDefaultValues(), InitPPEManagerClassMap(), ProcessApplyValueChanges(), ProcessMaterialUpdates(), RegisterPPEClass(), RemoveActiveRequestFromMaterials(), SendMaterialValueData(), and SetMaterialParamUpdating().

m_PPEMaterialUpdateQueueMap

ref map<int, ref array<int> > m_PPEMaterialUpdateQueueMap

protected

Definition at line 59 of file PPEManager.c.

Referenced by Cleanup(), ClearMaterialUpdating(), Init(), ProcessMaterialUpdates(), RemoveMaterialUpdating(), and SetMaterialParamUpdating().

m_UpdatedMaterials

ref array<int> m_UpdatedMaterials

protected

Definition at line 60 of file PPEManager.c.

Referenced by Init(), InsertUpdatedMaterial(), and ProcessApplyValueChanges().

m_UpdatingRequests

ref array<ref PPERequesterBase> m_UpdatingRequests

protected

Definition at line 62 of file PPEManager.c.

Referenced by Cleanup(), Init(), ProcessRequesterUpdates(), and SetRequestUpdating().