PPEGodRays Class Reference

GodRays - PostProcessEffectType.GodRays. More...

Inheritance diagram for PPEGodRays:

Collaboration diagram for PPEGodRays:

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

Static Private Attributes
static const int	PARAM_INTENSITY = 0
static const int	PARAM_SUNVISIBLE = 1
static const int	PARAM_OVERBURNINTENSITY = 2
static const int	PARAM_OVERBURNSTART = 3
static const int	PARAM_OVERBURNEND = 4
static const int	L_0_GLASSES = 100

Additional Inherited Members
Private Attributes inherited from PPEClassBase
PPEManager	m_Manager
string	m_MaterialPath = ""
Material	m_Material
ref map< int, ref array< int > >	m_ParameterUpdateQueueMap
ref array< int >	m_ParameterRemovalQueue
ref array< int >	m_UpdatedParameters
ref map< int, ref PPEMatClassParameterCommandData >	m_MaterialParamMapStructure

Detailed Description

GodRays - PostProcessEffectType.GodRays.

Definition at line 2 of file PPEGodRays.c.

Member Function Documentation

GetDefaultMaterialPath()

override string PPEGodRays::GetDefaultMaterialPath ( )

inlineprivate

Definition at line 18 of file PPEGodRays.c.

  {
    return "Graphics/Materials/postprocess/godrayssun";
  }

GetPostProcessEffectID()

override int PPEGodRays::GetPostProcessEffectID ( )

inlineprivate

Definition at line 13 of file PPEGodRays.c.

  {
    return PostProcessEffectType.GodRays;
  }

RegisterMaterialParameters()

override void PPEGodRays::RegisterMaterialParameters ( )

inlineprivate

Definition at line 23 of file PPEGodRays.c.

  {
    RegisterParameterScalarFloat(PARAM_INTENSITY, "Intensity", 0.8, 0, 1);
    RegisterParameterScalarFloat(PARAM_SUNVISIBLE, "SunVisible", 1.0, 0, 1);
    RegisterParameterScalarFloat(PARAM_OVERBURNINTENSITY, "OverBurnIntensity", 0.25, 0, 1);
    RegisterParameterScalarFloat(PARAM_OVERBURNSTART, "OverBurnStart", 0.025, 0, 1);
    RegisterParameterScalarFloat(PARAM_OVERBURNEND, "OverBurnEnd", 0.175, 0, 1);
 
    //TODO
    //SunMaskMat - DECLARE_RESOURCE_NAME
  }

References PARAM_INTENSITY, PARAM_OVERBURNEND, PARAM_OVERBURNINTENSITY, PARAM_OVERBURNSTART, PARAM_SUNVISIBLE, and PPEClassBase::RegisterParameterScalarFloat().

Member Data Documentation

L_0_GLASSES

const int PPEGodRays::L_0_GLASSES = 100

staticprivate

Definition at line 11 of file PPEGodRays.c.

Referenced by PPERequester_GameplayBase::OnStart(), and PPERequester_GameplayBase::OnUpdate().

PARAM_INTENSITY

const int PPEGodRays::PARAM_INTENSITY = 0

staticprivate

Definition at line 4 of file PPEGodRays.c.

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

PARAM_OVERBURNEND

const int PPEGodRays::PARAM_OVERBURNEND = 4

staticprivate

Definition at line 8 of file PPEGodRays.c.

Referenced by RegisterMaterialParameters().

PARAM_OVERBURNINTENSITY

const int PPEGodRays::PARAM_OVERBURNINTENSITY = 2

staticprivate

Definition at line 6 of file PPEGodRays.c.

Referenced by RegisterMaterialParameters().

PARAM_OVERBURNSTART

const int PPEGodRays::PARAM_OVERBURNSTART = 3

staticprivate

Definition at line 7 of file PPEGodRays.c.

Referenced by RegisterMaterialParameters().

PARAM_SUNVISIBLE

const int PPEGodRays::PARAM_SUNVISIBLE = 1

staticprivate

Definition at line 5 of file PPEGodRays.c.

Referenced by RegisterMaterialParameters().

---

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

• scripts/3_Game/PPEManager/Materials/MatClasses/PPEGodRays.c