DepthOfField - PostProcessEffectType.DepthOfField. More...

Inheritance diagram for PPEDepthOfField:

Collaboration diagram for PPEDepthOfField:

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_DOFLQ = 0

static const int	PARAM_FOCALDISTANCE = 1

static const int	PARAM_HYPERFOCAL = 2

static const int	PARAM_FOCALOFFSET = 3

static const int	PARAM_BLURFACTOR = 4

static const int	PARAM_SIMPLEDOF = 5

static const int	PARAM_SIMPLEHFNEAR = 6

static const int	PARAM_SIMPLEDOFSIZE = 7

static const int	PARAM_SIMPLEDOFGAUSS = 8

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

DepthOfField - PostProcessEffectType.DepthOfField.

Definition at line 3 of file PPEDepthOfField.c.

Member Function Documentation

◆ GetDefaultMaterialPath()

override string PPEDepthOfField::GetDefaultMaterialPath ( )

inlineprivate

Definition at line 20 of file PPEDepthOfField.c.

  {
    string ret = "Graphics/Materials/postprocess/depthoffieldTest2";
    /*
      GameOptions m_Options = new GameOptions();
      ListOptionsAccess loa = ListOptionsAccess.Cast( m_Options.GetOptionByType( AT_POSTPROCESS_EFFECTS ) );
 
      switch (loa.GetIndex())
      {
      case POSTPROCESS_OPTION_VALUE_LOW:
        ret = "Graphics/Materials/postprocess/hbao_low";
      break;
 
      case POSTPROCESS_OPTION_VALUE_MEDIUM:
        ret = "Graphics/Materials/postprocess/hbao_medium";
      break;
 
      case POSTPROCESS_OPTION_VALUE_HIGH:
        ret = "Graphics/Materials/postprocess/hbao_high";
      break;
 
      case POSTPROCESS_OPTION_VALUE_HIGHEST:
        ret = "Graphics/Materials/postprocess/hbao_highest";
      break;
      }
    */
    return ret;
  }

◆ GetPostProcessEffectID()

override int PPEDepthOfField::GetPostProcessEffectID ( )

inlineprivate

Definition at line 15 of file PPEDepthOfField.c.

  {
    return PostProcessEffectType.DepthOfField;
  }

◆ RegisterMaterialParameters()

override void PPEDepthOfField::RegisterMaterialParameters ( )

inlineprivate

Definition at line 49 of file PPEDepthOfField.c.

  {
    RegisterParameterScalarBool(PARAM_DOFLQ, "DOFLowQuality", false);
    RegisterParameterScalarFloat(PARAM_FOCALDISTANCE, "FocalDistance", 0.1, 0.0, 1.0);
    RegisterParameterScalarFloat(PARAM_HYPERFOCAL, "HyperFocal", 0.85, 0.1, 100.0);
    RegisterParameterScalarFloat(PARAM_FOCALOFFSET, "FocalOffset", 0.0, 0.0, 1.0);
    RegisterParameterScalarFloat(PARAM_BLURFACTOR, "BlurFactor", 4.0, 0.0, 10.0);
    RegisterParameterScalarBool(PARAM_SIMPLEDOF, "SimpleDOF", false);
    RegisterParameterScalarFloat(PARAM_SIMPLEHFNEAR, "SimpleHyperFocalNear", 0.7, 0.1, 100.0);
    RegisterParameterScalarInt(PARAM_SIMPLEDOFSIZE, "SimpleDOFSize", 2.0, 1.0, 4.0);
    RegisterParameterScalarInt(PARAM_SIMPLEDOFGAUSS, "SimpleDOFGauss", 1.0, 0.0, 4.0);
  }

References PARAM_BLURFACTOR, PARAM_DOFLQ, PARAM_FOCALDISTANCE, PARAM_FOCALOFFSET, PARAM_HYPERFOCAL, PARAM_SIMPLEDOF, PARAM_SIMPLEDOFGAUSS, PARAM_SIMPLEDOFSIZE, PARAM_SIMPLEHFNEAR, PPEClassBase::RegisterParameterScalarBool(), PPEClassBase::RegisterParameterScalarFloat(), and PPEClassBase::RegisterParameterScalarInt().

Member Data Documentation

◆ PARAM_BLURFACTOR

const int PPEDepthOfField::PARAM_BLURFACTOR = 4

staticprivate

Definition at line 9 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_DOFLQ

const int PPEDepthOfField::PARAM_DOFLQ = 0

staticprivate

Definition at line 5 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_FOCALDISTANCE

const int PPEDepthOfField::PARAM_FOCALDISTANCE = 1

staticprivate

Definition at line 6 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_FOCALOFFSET

const int PPEDepthOfField::PARAM_FOCALOFFSET = 3

staticprivate

Definition at line 8 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_HYPERFOCAL

const int PPEDepthOfField::PARAM_HYPERFOCAL = 2

staticprivate

Definition at line 7 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_SIMPLEDOF

const int PPEDepthOfField::PARAM_SIMPLEDOF = 5

staticprivate

Definition at line 10 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_SIMPLEDOFGAUSS

const int PPEDepthOfField::PARAM_SIMPLEDOFGAUSS = 8

staticprivate

Definition at line 13 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_SIMPLEDOFSIZE

const int PPEDepthOfField::PARAM_SIMPLEDOFSIZE = 7

staticprivate

Definition at line 12 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

◆ PARAM_SIMPLEHFNEAR

const int PPEDepthOfField::PARAM_SIMPLEHFNEAR = 6

staticprivate

Definition at line 11 of file PPEDepthOfField.c.

Referenced by RegisterMaterialParameters().

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

scripts/3_Game/PPEManager/Materials/MatClasses/PPEDepthOfField.c

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetDefaultMaterialPath()

◆ GetPostProcessEffectID()

◆ RegisterMaterialParameters()

Member Data Documentation

◆ PARAM_BLURFACTOR

◆ PARAM_DOFLQ

◆ PARAM_FOCALDISTANCE

◆ PARAM_FOCALOFFSET

◆ PARAM_HYPERFOCAL

◆ PARAM_SIMPLEDOF

◆ PARAM_SIMPLEDOFGAUSS

◆ PARAM_SIMPLEDOFSIZE

◆ PARAM_SIMPLEHFNEAR