Distort - PostProcessEffectType.Distort. More...

Inheritance diagram for PPEDistort:

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	L_0_HMP = 100
	Distortion applied to imagine. 1 = all, 0 = none, applied only to ChromAbber.
static const int	L_1_HMP = 100
static const int	L_2_HMP = 100
static const int	L_3_HMP = 100
static const int	L_4_HMP = 100
static const int	L_5_HMP = 100
static const int	L_6_HMP = 100
static const int	L_7_HMP = 100
static const int	PARAM_CENTERX = 1
	Lens distortion magnitude, x > 0 = barrel distortion, x < 0 = pincushion distortion.
static const int	PARAM_CENTERY = 2
	Lens center X direction (-1 = left, 0 = center, 1 = right).
static const int	PARAM_CHROM_ABB = 3
	Lens center Y direction (-1 = top, 0 = center, 1 = bottom).
static const int	PARAM_CHROM_ABB_SHIFTB = 6
	Chromatic abberation green channel shift magnitude. 0 = none, 1 = default.
static const int	PARAM_CHROM_ABB_SHIFTG = 5
	Chromatic abberation red channel shift magnitude. 0 = none.
static const int	PARAM_CHROM_ABB_SHIFTR = 4
	Maximum value of chromatic abberation, 0 = disable - note that chrom. aberr depends on amount of distortion.
static const int	PARAM_CHROM_COLOR_MOD = 7
	Chromatic abberation blue channel shift magnitude. 0 = none, 2 = default.
static const int	PARAM_DISTORT = 0
static const int	PARAM_DISTORT_WEIGHT = 8
	Color modulation effect. (red, green, blue, scale) (0,0,0,0) = default.

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

Distort - PostProcessEffectType.Distort.

Definition at line 2 of file ppedistort.c.

Member Function Documentation

◆ GetDefaultMaterialPath()

override string GetDefaultMaterialPath ( )

inlineprivate

Definition at line 29 of file ppedistort.c.

◆ GetPostProcessEffectID()

override int GetPostProcessEffectID ( )

inlineprivate

Definition at line 24 of file ppedistort.c.

◆ RegisterMaterialParameters()

override void RegisterMaterialParameters ( )

inlineprivate

Definition at line 34 of file ppedistort.c.

References PARAM_CENTERX, PARAM_CENTERY, PARAM_CHROM_ABB, PARAM_CHROM_ABB_SHIFTB, PARAM_CHROM_ABB_SHIFTG, PARAM_CHROM_ABB_SHIFTR, PARAM_CHROM_COLOR_MOD, PARAM_DISTORT, PARAM_DISTORT_WEIGHT, PPEClassBase::RegisterParameterColor(), and PPEClassBase::RegisterParameterScalarFloat().

Field Documentation

◆ L_0_HMP

const int L_0_HMP = 100

staticprivate

Distortion applied to imagine. 1 = all, 0 = none, applied only to ChromAbber.

Definition at line 15 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_1_HMP

const int L_1_HMP = 100

staticprivate

Definition at line 16 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_2_HMP

const int L_2_HMP = 100

staticprivate

Definition at line 17 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_3_HMP

const int L_3_HMP = 100

staticprivate

Definition at line 18 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_4_HMP

const int L_4_HMP = 100

staticprivate

Definition at line 19 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_5_HMP

const int L_5_HMP = 100

staticprivate

Definition at line 20 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_6_HMP

const int L_6_HMP = 100

staticprivate

Definition at line 21 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ L_7_HMP

const int L_7_HMP = 100

staticprivate

Definition at line 22 of file ppedistort.c.

Referenced by PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CENTERX

const int PARAM_CENTERX = 1

staticprivate

Lens distortion magnitude, x > 0 = barrel distortion, x < 0 = pincushion distortion.

Definition at line 5 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CENTERY

const int PARAM_CENTERY = 2

staticprivate

Lens center X direction (-1 = left, 0 = center, 1 = right).

Definition at line 6 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CHROM_ABB

const int PARAM_CHROM_ABB = 3

staticprivate

Lens center Y direction (-1 = top, 0 = center, 1 = bottom).

Definition at line 7 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CHROM_ABB_SHIFTB

const int PARAM_CHROM_ABB_SHIFTB = 6

staticprivate

Chromatic abberation green channel shift magnitude. 0 = none, 1 = default.

Definition at line 10 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CHROM_ABB_SHIFTG

const int PARAM_CHROM_ABB_SHIFTG = 5

staticprivate

Chromatic abberation red channel shift magnitude. 0 = none.

Definition at line 9 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CHROM_ABB_SHIFTR

const int PARAM_CHROM_ABB_SHIFTR = 4

staticprivate

Maximum value of chromatic abberation, 0 = disable - note that chrom. aberr depends on amount of distortion.

Definition at line 8 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_CHROM_COLOR_MOD

const int PARAM_CHROM_COLOR_MOD = 7

staticprivate

Chromatic abberation blue channel shift magnitude. 0 = none, 2 = default.

Definition at line 11 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_DISTORT

const int PARAM_DISTORT = 0

staticprivate

Definition at line 4 of file ppedistort.c.

Referenced by RegisterMaterialParameters(), and PPERequester_GameplayBase::SetEffectProgress().

◆ PARAM_DISTORT_WEIGHT

const int PARAM_DISTORT_WEIGHT = 8

staticprivate

Color modulation effect. (red, green, blue, scale) (0,0,0,0) = default.

Definition at line 12 of file ppedistort.c.

Referenced by RegisterMaterialParameters().

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

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

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetDefaultMaterialPath()

◆ GetPostProcessEffectID()

◆ RegisterMaterialParameters()

Field Documentation

◆ L_0_HMP

◆ L_1_HMP

◆ L_2_HMP

◆ L_3_HMP

◆ L_4_HMP

◆ L_5_HMP

◆ L_6_HMP

◆ L_7_HMP

◆ PARAM_CENTERX

◆ PARAM_CENTERY

◆ PARAM_CHROM_ABB

◆ PARAM_CHROM_ABB_SHIFTB

◆ PARAM_CHROM_ABB_SHIFTG

◆ PARAM_CHROM_ABB_SHIFTR

◆ PARAM_CHROM_COLOR_MOD

◆ PARAM_DISTORT

◆ PARAM_DISTORT_WEIGHT