PPESnowfall Class Reference

Snowfall - PostProcessEffectType.Snowfall. More...

Inheritance diagram for PPESnowfall:

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_BCKGRNDCOLORMULT = 6
static const int	PARAM_DISTANTSPEED = 14
static const int	PARAM_DROPDISTANCE = 0
static const int	PARAM_DROPSIZEX = 1
static const int	PARAM_DROPSIZEY = 2
static const int	PARAM_FOGCOLORMULT = 5
static const int	PARAM_GODRAYINTFAR = 10
static const int	PARAM_GODRAYINTNEAR = 9
static const int	PARAM_MAXDIVERGENCE = 17
static const int	PARAM_MINDIVERGENCE = 16
static const int	PARAM_RAINDENSITY = 4
static const int	PARAM_RAINFOGGINESS = 3
static const int	PARAM_REFRACTIONSCALE = 7
static const int	PARAM_RIPPLESBLEND = 11
static const int	PARAM_RIPPLESDIST = 12
static const int	PARAM_SPEED = 13
static const int	PARAM_SUNVISIBLE = 8
static const int	PARAM_WINDAFFECTSPEED = 15
static const int	PARAM_WINDSPEEDFORMAXDIV = 18

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

Snowfall - PostProcessEffectType.Snowfall.

Definition at line 2 of file ppesnowfall.c.

Member Function Documentation

GetDefaultMaterialPath()

override string GetDefaultMaterialPath ( )

inlineprivate

Definition at line 38 of file ppesnowfall.c.

GetPostProcessEffectID()

override int GetPostProcessEffectID ( )

inlineprivate

Definition at line 33 of file ppesnowfall.c.

RegisterMaterialParameters()

override void RegisterMaterialParameters ( )

inlineprivate

Definition at line 43 of file ppesnowfall.c.

References PARAM_BCKGRNDCOLORMULT, PARAM_DISTANTSPEED, PARAM_DROPDISTANCE, PARAM_DROPSIZEX, PARAM_DROPSIZEY, PARAM_FOGCOLORMULT, PARAM_GODRAYINTFAR, PARAM_GODRAYINTNEAR, PARAM_MAXDIVERGENCE, PARAM_MINDIVERGENCE, PARAM_RAINDENSITY, PARAM_RAINFOGGINESS, PARAM_REFRACTIONSCALE, PARAM_RIPPLESBLEND, PARAM_RIPPLESDIST, PARAM_SPEED, PARAM_SUNVISIBLE, PARAM_WINDAFFECTSPEED, PARAM_WINDSPEEDFORMAXDIV, and PPEClassBase::RegisterParameterScalarFloat().

Field Documentation

PARAM_BCKGRNDCOLORMULT

const int PARAM_BCKGRNDCOLORMULT = 6

staticprivate

Definition at line 10 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_DISTANTSPEED

const int PARAM_DISTANTSPEED = 14

staticprivate

Definition at line 18 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_DROPDISTANCE

const int PARAM_DROPDISTANCE = 0

staticprivate

Definition at line 4 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_DROPSIZEX

const int PARAM_DROPSIZEX = 1

staticprivate

Definition at line 5 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_DROPSIZEY

const int PARAM_DROPSIZEY = 2

staticprivate

Definition at line 6 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_FOGCOLORMULT

const int PARAM_FOGCOLORMULT = 5

staticprivate

Definition at line 9 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_GODRAYINTFAR

const int PARAM_GODRAYINTFAR = 10

staticprivate

Definition at line 14 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_GODRAYINTNEAR

const int PARAM_GODRAYINTNEAR = 9

staticprivate

Definition at line 13 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_MAXDIVERGENCE

const int PARAM_MAXDIVERGENCE = 17

staticprivate

Definition at line 21 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_MINDIVERGENCE

const int PARAM_MINDIVERGENCE = 16

staticprivate

Definition at line 20 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_RAINDENSITY

const int PARAM_RAINDENSITY = 4

staticprivate

Definition at line 8 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_RAINFOGGINESS

const int PARAM_RAINFOGGINESS = 3

staticprivate

Definition at line 7 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_REFRACTIONSCALE

const int PARAM_REFRACTIONSCALE = 7

staticprivate

Definition at line 11 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_RIPPLESBLEND

const int PARAM_RIPPLESBLEND = 11

staticprivate

Definition at line 15 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_RIPPLESDIST

const int PARAM_RIPPLESDIST = 12

staticprivate

Definition at line 16 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_SPEED

const int PARAM_SPEED = 13

staticprivate

Definition at line 17 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_SUNVISIBLE

const int PARAM_SUNVISIBLE = 8

staticprivate

Definition at line 12 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_WINDAFFECTSPEED

const int PARAM_WINDAFFECTSPEED = 15

staticprivate

Definition at line 19 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

PARAM_WINDSPEEDFORMAXDIV

const int PARAM_WINDSPEEDFORMAXDIV = 18

staticprivate

Definition at line 22 of file ppesnowfall.c.

Referenced by RegisterMaterialParameters().

---

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

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