PPEWetDistort Class Reference

WetDistort - PostProcessEffectType.WetDistort. More...

Inheritance diagram for PPEWetDistort:

Private Member Functions
override string	GetDefaultMaterialPath ()
override int	GetPostProcessEffectID ()
override void	RegisterMaterialParameters ()
Private Member Functions inherited from PPEClassBase
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.

Static Private Attributes
static const int	PARAM_BLURDOWNSIZE = 4
static const int	PARAM_BLURGAUSS = 5
static const int	PARAM_BLURPOWER = 0
static const int	PARAM_EFFPOWERBOTTOM = 3
static const int	PARAM_EFFPOWERTOP = 2
static const int	PARAM_LOCALBLURPOWER = 1
static const int	PARAM_PHASEPOSX = 16
static const int	PARAM_PHASEPOSY = 17
static const int	PARAM_PHASERANDX = 14
static const int	PARAM_PHASERANDY = 15
static const int	PARAM_WAVEAMPX1 = 10
static const int	PARAM_WAVEAMPX2 = 11
static const int	PARAM_WAVEAMPY1 = 12
static const int	PARAM_WAVEAMPY2 = 13
static const int	PARAM_WAVSPDX1 = 6
static const int	PARAM_WAVSPDX2 = 7
static const int	PARAM_WAVSPDY1 = 8
static const int	PARAM_WAVSPDY2 = 9

Additional Inherited Members
Private Attributes inherited from PPEClassBase
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

WetDistort - PostProcessEffectType.WetDistort.

Definition at line 2 of file ppewetdistort.c.

Member Function Documentation

GetDefaultMaterialPath()

override string GetDefaultMaterialPath ( )

inlineprivate

Definition at line 28 of file ppewetdistort.c.

GetPostProcessEffectID()

override int GetPostProcessEffectID ( )

inlineprivate

Definition at line 23 of file ppewetdistort.c.

RegisterMaterialParameters()

override void RegisterMaterialParameters ( )

inlineprivate

Definition at line 33 of file ppewetdistort.c.

References PARAM_BLURDOWNSIZE, PARAM_BLURGAUSS, PARAM_BLURPOWER, PARAM_EFFPOWERBOTTOM, PARAM_EFFPOWERTOP, PARAM_LOCALBLURPOWER, PARAM_PHASEPOSX, PARAM_PHASEPOSY, PARAM_PHASERANDX, PARAM_PHASERANDY, PARAM_WAVEAMPX1, PARAM_WAVEAMPX2, PARAM_WAVEAMPY1, PARAM_WAVEAMPY2, PARAM_WAVSPDX1, PARAM_WAVSPDX2, PARAM_WAVSPDY1, PARAM_WAVSPDY2, PPEClassBase::RegisterParameterScalarFloat(), and PPEClassBase::RegisterParameterScalarInt().

Field Documentation

PARAM_BLURDOWNSIZE

const int PARAM_BLURDOWNSIZE = 4

staticprivate

Definition at line 8 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_BLURGAUSS

const int PARAM_BLURGAUSS = 5

staticprivate

Definition at line 9 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_BLURPOWER

const int PARAM_BLURPOWER = 0

staticprivate

Definition at line 4 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_EFFPOWERBOTTOM

const int PARAM_EFFPOWERBOTTOM = 3

staticprivate

Definition at line 7 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_EFFPOWERTOP

const int PARAM_EFFPOWERTOP = 2

staticprivate

Definition at line 6 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_LOCALBLURPOWER

const int PARAM_LOCALBLURPOWER = 1

staticprivate

Definition at line 5 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_PHASEPOSX

const int PARAM_PHASEPOSX = 16

staticprivate

Definition at line 20 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_PHASEPOSY

const int PARAM_PHASEPOSY = 17

staticprivate

Definition at line 21 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_PHASERANDX

const int PARAM_PHASERANDX = 14

staticprivate

Definition at line 18 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_PHASERANDY

const int PARAM_PHASERANDY = 15

staticprivate

Definition at line 19 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVEAMPX1

const int PARAM_WAVEAMPX1 = 10

staticprivate

Definition at line 14 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVEAMPX2

const int PARAM_WAVEAMPX2 = 11

staticprivate

Definition at line 15 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVEAMPY1

const int PARAM_WAVEAMPY1 = 12

staticprivate

Definition at line 16 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVEAMPY2

const int PARAM_WAVEAMPY2 = 13

staticprivate

Definition at line 17 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVSPDX1

const int PARAM_WAVSPDX1 = 6

staticprivate

Definition at line 10 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVSPDX2

const int PARAM_WAVSPDX2 = 7

staticprivate

Definition at line 11 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVSPDY1

const int PARAM_WAVSPDY1 = 8

staticprivate

Definition at line 12 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

PARAM_WAVSPDY2

const int PARAM_WAVSPDY2 = 9

staticprivate

Definition at line 13 of file ppewetdistort.c.

Referenced by RegisterMaterialParameters().

---

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

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