PPEClassBase Class Reference

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

Inheritance diagram for PPEClassBase:

Protected Member Functions
void	PPEClassBase (string mat_path_override="")
void	ApplyValueChanges ()
void	ChangeMaterialPathUsed (string path)
void	CreateDataStructure ()
void	CreateMaterial ()
void	DbgPrnt (string text)
string	GetCurrentMaterialPath ()
string	GetDefaultMaterialPath ()
	override this if you want to use different path by default; '.emat' is appended automatically
Material	GetMaterial ()
PPEMatClassParameterCommandData	GetParameterCommandData (int parameter_idx)
	Some PP effects are handled as hard-coded exceptions, outside of material system. Default == PPEExceptions.NONE (systemic behaviour).
int	GetPostProcessEffectID ()
	Overriden in all material classes!
void	Init (string mat_path_override="")
void	InsertParamValueData (PPERequestParamDataBase request_data)
	Distributes requester data to the material class structure and links them to appropriate parameter.
void	InsertUpdatedParameter (int mat_id)
void	OnUpdate (float timeslice, int order)
	generic update method, take care when overriding!
void	ParamUpdateQueueCleanup (int order)
void	ParamUpdateRemove (int parameter_idx)
	Queue selected parameter for removal from the update queue.
void	RegisterMaterialParameters ()
	inserted into associative array by parameter int value, parameter registration order does not matter (still ordered, though)
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...
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...
void	RegisterParameterResource (int idx, string parameter_name, string default_path)
void	RegisterParameterScalarBool (int idx, string parameter_name, bool default_value)
void	RegisterParameterScalarFloat (int idx, string parameter_name, float default_value, float min, float max)
	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...
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...
void	RegisterParameterScalarInt (int idx, string parameter_name, int default_value, int min, int max)
void	RegisterParameterTexture (int idx, string parameter_name, string default_path)
void	RegisterParameterVector (int idx, string parameter_name, array< float > default_values)
void	RemoveRequest (int req_idx)
	unused, see 'RemoveActiveRequestFromMaterials' for more info
void	SetFinalParameterValue (int parameter_idx)
	Clamps the values being set to defaults, if there is no request setting non-zero values on the parameter.
void	SetParameterUpdating (int order, int parameter_id)
	Queue specific parameter of this material to update.

Protected Attributes
PPEManager	m_Manager
Material	m_Material
ref map< int, ref PPEMatClassParameterCommandData >	m_MaterialParamMapStructure
string	m_MaterialPath = ""
ref array< int >	m_ParameterRemovalQueue
ref map< int, ref array< int > >	m_ParameterUpdateQueueMap
ref array< int >	m_UpdatedParameters

Detailed Description

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

Definition at line 2 of file ppematclassesbase.c.

Constructor & Destructor Documentation

PPEClassBase()

void PPEClassBase ( string mat_path_override = "" )

inlineprotected

Definition at line 14 of file ppematclassesbase.c.

References CreateDataStructure(), CreateMaterial(), Init(), and RegisterMaterialParameters().

Member Function Documentation

ApplyValueChanges()

void ApplyValueChanges ( )

inlineprotected

Definition at line 269 of file ppematclassesbase.c.

References m_UpdatedParameters, and SetFinalParameterValue().

Referenced by ProcessApplyValueChanges().

ChangeMaterialPathUsed()

void ChangeMaterialPathUsed ( string path )

inlineprotected

Definition at line 326 of file ppematclassesbase.c.

References CreateMaterial(), m_Material, m_MaterialPath, and path.

Referenced by ChangePPEMaterial().

CreateDataStructure()

void CreateDataStructure ( )

inlineprotected

Definition at line 47 of file ppematclassesbase.c.

References m_MaterialParamMapStructure, m_ParameterRemovalQueue, m_ParameterUpdateQueueMap, and m_UpdatedParameters.

Referenced by PPEClassBase().

CreateMaterial()

void CreateMaterial ( )

inlineprotected

Definition at line 35 of file ppematclassesbase.c.

References g_Game, m_Material, and m_MaterialPath.

Referenced by PPEClassBase(), and ChangeMaterialPathUsed().

DbgPrnt()

void DbgPrnt ( string text )

inlineprotected

Definition at line 380 of file ppematclassesbase.c.

GetCurrentMaterialPath()

string GetCurrentMaterialPath ( )

inlineprotected

Definition at line 333 of file ppematclassesbase.c.

References m_MaterialPath.

GetDefaultMaterialPath()

string GetDefaultMaterialPath ( )

protected

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

Referenced by Init().

GetMaterial()

Material GetMaterial ( )

inlineprotected

Definition at line 41 of file ppematclassesbase.c.

References m_Material.

Referenced by ChangePPEMaterial().

GetParameterCommandData()

PPEMatClassParameterCommandData GetParameterCommandData ( int parameter_idx )

inlineprotected

Some PP effects are handled as hard-coded exceptions, outside of material system. Default == PPEExceptions.NONE (systemic behaviour).

Definition at line 350 of file ppematclassesbase.c.

References m_MaterialParamMapStructure.

Referenced by GetPostProcessCurrentValues(), GetPostProcessDefaultValues(), SetFinalParameterValue(), PPEDOF::SetFinalParameterValue(), PPEExposureNative::SetFinalParameterValue(), PPEEyeAccomodationNative::SetFinalParameterValue(), and PPELightIntensityParamsNative::SetFinalParameterValue().

GetPostProcessEffectID()

int GetPostProcessEffectID ( )

inlineprotected

Overriden in all material classes!

Definition at line 339 of file ppematclassesbase.c.

Referenced by InsertParamValueData(), OnUpdate(), RegisterParameterColor(), RegisterParameterColorEx(), RegisterParameterResource(), RegisterParameterScalarBool(), RegisterParameterScalarFloat(), RegisterParameterScalarFloatEx(), RegisterParameterScalarInt(), RegisterParameterTexture(), RegisterParameterVector(), and RegisterPPEClass().

Init()

void Init ( string mat_path_override = "" )

inlineprotected

Definition at line 22 of file ppematclassesbase.c.

References GetDefaultMaterialPath(), PPEManagerStatic::GetPPEManager(), m_Manager, and m_MaterialPath.

InsertParamValueData()

void InsertParamValueData ( PPERequestParamDataBase request_data )

inlineprotected

Distributes requester data to the material class structure and links them to appropriate parameter.

Definition at line 151 of file ppematclassesbase.c.

References Error(), PPERequestParamDataBase::GetParameterID(), GetPostProcessEffectID(), PPERequestParamDataBase::GetRequesterIDX(), PPEMatClassParameterCommandData::InsertRequestData(), m_MaterialParamMapStructure, PPERequestParamDataBase::SetDataActive(), and PPERequestParamDataBase::SetUpdatingDataValues().

Referenced by SendMaterialValueData().

InsertUpdatedParameter()

void InsertUpdatedParameter ( int mat_id )

inlineprotected

Definition at line 281 of file ppematclassesbase.c.

References m_UpdatedParameters.

Referenced by OnUpdate().

OnUpdate()

void OnUpdate ( float timeslice, int order )

inlineprotected

generic update method, take care when overriding!

Definition at line 201 of file ppematclassesbase.c.

References Count, GetPostProcessEffectID(), InsertUpdatedParameter(), m_Manager, m_MaterialParamMapStructure, m_ParameterUpdateQueueMap, and ParamUpdateQueueCleanup().

Referenced by ProcessMaterialUpdates().

ParamUpdateQueueCleanup()

void ParamUpdateQueueCleanup ( int order )

inlineprotected

Definition at line 308 of file ppematclassesbase.c.

References Count, m_ParameterRemovalQueue, and m_ParameterUpdateQueueMap.

Referenced by OnUpdate().

ParamUpdateRemove()

void ParamUpdateRemove ( int parameter_idx )

inlineprotected

Queue selected parameter for removal from the update queue.

Definition at line 288 of file ppematclassesbase.c.

References m_ParameterRemovalQueue.

RegisterMaterialParameters()

void RegisterMaterialParameters ( )

protected

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

Referenced by PPEClassBase().

RegisterParameterColor()

void RegisterParameterColor ( int idx, string parameter_name, float r, float g, float b, float a )

inlineprotected

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

Definition at line 102 of file ppematclassesbase.c.

References GetPostProcessEffectID(), m_MaterialParamMapStructure, and PPEMatClassParameterColor().

Referenced by PPEColors::RegisterMaterialParameters(), PPEDistort::RegisterMaterialParameters(), PPEGhost::RegisterMaterialParameters(), and PPEGlow::RegisterMaterialParameters().

RegisterParameterColorEx()

void RegisterParameterColorEx ( int idx, string parameter_name, float r, float g, float b, float a, typename type  )

inlineprotected

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

Definition at line 111 of file ppematclassesbase.c.

References Class::CastTo(), GetPostProcessEffectID(), and m_MaterialParamMapStructure.

Referenced by PPEColors::RegisterMaterialParameters(), and PPEGlow::RegisterMaterialParameters().

RegisterParameterResource()

void RegisterParameterResource ( int idx, string parameter_name, string default_path )

inlineprotected

Definition at line 141 of file ppematclassesbase.c.

References GetPostProcessEffectID(), and m_MaterialParamMapStructure.

RegisterParameterScalarBool()

void RegisterParameterScalarBool ( int idx, string parameter_name, bool default_value )

inlineprotected

Definition at line 59 of file ppematclassesbase.c.

References GetPostProcessEffectID(), and m_MaterialParamMapStructure.

Referenced by PPEDepthOfField::RegisterMaterialParameters(), PPEDOF::RegisterMaterialParameters(), PPEFilmGrain::RegisterMaterialParameters(), PPEGlow::RegisterMaterialParameters(), and PPEHBAO::RegisterMaterialParameters().

RegisterParameterScalarFloat()

void RegisterParameterScalarFloat ( int idx, string parameter_name, float default_value, float min, float max )

inlineprotected

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

Definition at line 77 of file ppematclassesbase.c.

References GetPostProcessEffectID(), m_MaterialParamMapStructure, and PPEMatClassParameterFloat().

Referenced by PPEChromAber::RegisterMaterialParameters(), PPEColors::RegisterMaterialParameters(), PPEDepthOfField::RegisterMaterialParameters(), PPEDistort::RegisterMaterialParameters(), PPEDOF::RegisterMaterialParameters(), PPEDynamicBlur::RegisterMaterialParameters(), PPEExposureNative::RegisterMaterialParameters(), PPEEyeAccomodationNative::RegisterMaterialParameters(), PPEFilmGrain::RegisterMaterialParameters(), PPEGaussFilter::RegisterMaterialParameters(), PPEGhost::RegisterMaterialParameters(), PPEGlow::RegisterMaterialParameters(), PPEGodRays::RegisterMaterialParameters(), PPEHBAO::RegisterMaterialParameters(), PPELightIntensityParamsNative::RegisterMaterialParameters(), PPERadialBlur::RegisterMaterialParameters(), PPERain::RegisterMaterialParameters(), PPERotBlur::RegisterMaterialParameters(), PPESnowfall::RegisterMaterialParameters(), PPESSAO::RegisterMaterialParameters(), PPEUnderWater::RegisterMaterialParameters(), and PPEWetDistort::RegisterMaterialParameters().

RegisterParameterScalarFloatEx()

void RegisterParameterScalarFloatEx ( int idx, string parameter_name, float default_value, float min, float max, typename type  )

inlineprotected

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

Definition at line 87 of file ppematclassesbase.c.

References Class::CastTo(), GetPostProcessEffectID(), m_MaterialParamMapStructure, and PPEMatClassParameterFloat().

Referenced by PPEColors::RegisterMaterialParameters(), and PPEGlow::RegisterMaterialParameters().

RegisterParameterScalarInt()

void RegisterParameterScalarInt ( int idx, string parameter_name, int default_value, int min, int max )

inlineprotected

Definition at line 67 of file ppematclassesbase.c.

References GetPostProcessEffectID(), and m_MaterialParamMapStructure.

Referenced by PPEDepthOfField::RegisterMaterialParameters(), PPEFXAA::RegisterMaterialParameters(), PPEGlow::RegisterMaterialParameters(), PPEHBAO::RegisterMaterialParameters(), PPEMedian::RegisterMaterialParameters(), PPESMAA::RegisterMaterialParameters(), PPESSAO::RegisterMaterialParameters(), and PPEWetDistort::RegisterMaterialParameters().

RegisterParameterTexture()

void RegisterParameterTexture ( int idx, string parameter_name, string default_path )

inlineprotected

Definition at line 133 of file ppematclassesbase.c.

References GetPostProcessEffectID(), and m_MaterialParamMapStructure.

RegisterParameterVector()

void RegisterParameterVector ( int idx, string parameter_name, array< float > default_values )

inlineprotected

Definition at line 124 of file ppematclassesbase.c.

References GetPostProcessEffectID(), and m_MaterialParamMapStructure.

Referenced by PPEColors::RegisterMaterialParameters(), and PPEGlow::RegisterMaterialParameters().

RemoveRequest()

void RemoveRequest ( int req_idx )

inlineprotected

unused, see 'RemoveActiveRequestFromMaterials' for more info

Definition at line 170 of file ppematclassesbase.c.

Referenced by RemoveActiveRequestFromMaterials().

SetFinalParameterValue()

void SetFinalParameterValue ( int parameter_idx )

inlineprotected

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

Definition at line 228 of file ppematclassesbase.c.

References PPEMatClassParameterCommandData::GetCurrentValues(), GetParameterCommandData(), PPEMatClassParameterCommandData::GetParameterVarType(), and m_Material.

Referenced by ApplyValueChanges().

SetParameterUpdating()

void SetParameterUpdating ( int order, int parameter_id )

inlineprotected

Queue specific parameter of this material to update.

Definition at line 295 of file ppematclassesbase.c.

References m_ParameterUpdateQueueMap.

Referenced by SetMaterialParamUpdating().

Field Documentation

m_Manager

PPEManager m_Manager

protected

Definition at line 4 of file ppematclassesbase.c.

Referenced by Init(), and OnUpdate().

m_Material

Material m_Material

protected

Definition at line 6 of file ppematclassesbase.c.

Referenced by ChangeMaterialPathUsed(), CreateMaterial(), GetMaterial(), and SetFinalParameterValue().

m_MaterialParamMapStructure

ref map<int,ref PPEMatClassParameterCommandData> m_MaterialParamMapStructure

protected

Definition at line 12 of file ppematclassesbase.c.

Referenced by CreateDataStructure(), GetParameterCommandData(), InsertParamValueData(), OnUpdate(), RegisterParameterColor(), RegisterParameterColorEx(), RegisterParameterResource(), RegisterParameterScalarBool(), RegisterParameterScalarFloat(), RegisterParameterScalarFloatEx(), RegisterParameterScalarInt(), RegisterParameterTexture(), and RegisterParameterVector().

m_MaterialPath

string m_MaterialPath = ""

protected

Definition at line 5 of file ppematclassesbase.c.

Referenced by ChangeMaterialPathUsed(), CreateMaterial(), GetCurrentMaterialPath(), and Init().

m_ParameterRemovalQueue

ref array<int> m_ParameterRemovalQueue

protected

Definition at line 9 of file ppematclassesbase.c.

Referenced by CreateDataStructure(), ParamUpdateQueueCleanup(), and ParamUpdateRemove().

m_ParameterUpdateQueueMap

ref map<int, ref array<int> > m_ParameterUpdateQueueMap

protected

Definition at line 8 of file ppematclassesbase.c.

Referenced by CreateDataStructure(), OnUpdate(), ParamUpdateQueueCleanup(), and SetParameterUpdating().

m_UpdatedParameters

ref array<int> m_UpdatedParameters

protected

Definition at line 10 of file ppematclassesbase.c.

Referenced by ApplyValueChanges(), PPEDOF::ApplyValueChanges(), PPELightIntensityParamsNative::ApplyValueChanges(), CreateDataStructure(), and InsertUpdatedParameter().

---

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

• F:/Games/Dayz/scripts/3_game/ppemanager/materials/ppematclassesbase.c