Created once, on manager init. Script-side representation of C++ material class, separate handling. More...

Inheritance diagram for PPEClassBase:

Protected Member Functions
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)

Protected Attributes
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

Created once, on manager init. Script-side representation of C++ material class, separate handling.

Definition at line 2 of file ppematclassesbase.c.

Constructor & Destructor Documentation

◆ PPEClassBase()

void PPEClassBase::PPEClassBase ( string mat_path_override = "" )

protected

Definition at line 14 of file ppematclassesbase.c.

Member Function Documentation

◆ ApplyValueChanges()

void PPEClassBase::ApplyValueChanges ( )

protected

Definition at line 269 of file ppematclassesbase.c.

◆ ChangeMaterialPathUsed()

void PPEClassBase::ChangeMaterialPathUsed ( string path )

protected

Definition at line 326 of file ppematclassesbase.c.

◆ CreateDataStructure()

void PPEClassBase::CreateDataStructure ( )

protected

Definition at line 47 of file ppematclassesbase.c.

◆ CreateMaterial()

void PPEClassBase::CreateMaterial ( )

protected

Definition at line 35 of file ppematclassesbase.c.

◆ DbgPrnt()

void PPEClassBase::DbgPrnt ( string text )

protected

Definition at line 380 of file ppematclassesbase.c.

◆ GetCurrentMaterialPath()

string PPEClassBase::GetCurrentMaterialPath ( )

protected

Definition at line 333 of file ppematclassesbase.c.

◆ GetDefaultMaterialPath()

string PPEClassBase::GetDefaultMaterialPath ( )

protected

override this if you want to use different path by default; '.emat' is appended automatically

◆ GetMaterial()

Material PPEClassBase::GetMaterial ( )

protected

Definition at line 41 of file ppematclassesbase.c.

◆ GetParameterCommandData()

PPEMatClassParameterCommandData PPEClassBase::GetParameterCommandData ( int parameter_idx )

protected

Some PP effects are handled as hard-coded exceptions, outside of material system. Default == PPEExceptions.NONE (systemic behaviour)

Definition at line 350 of file ppematclassesbase.c.

◆ GetPostProcessEffectID()

int PPEClassBase::GetPostProcessEffectID ( )

protected

Overriden in all material classes!

Definition at line 339 of file ppematclassesbase.c.

◆ Init()

void PPEClassBase::Init ( string mat_path_override = "" )

protected

Definition at line 22 of file ppematclassesbase.c.

◆ InsertParamValueData()

void PPEClassBase::InsertParamValueData ( PPERequestParamDataBase request_data )

protected

Distributes requester data to the material class structure and links them to appropriate parameter.

Definition at line 151 of file ppematclassesbase.c.

◆ InsertUpdatedParameter()

void PPEClassBase::InsertUpdatedParameter ( int mat_id )

protected

Definition at line 281 of file ppematclassesbase.c.

◆ OnUpdate()

void PPEClassBase::OnUpdate	(	float	timeslice,
		int	order )

protected

generic update method, take care when overriding!

Definition at line 201 of file ppematclassesbase.c.

◆ ParamUpdateQueueCleanup()

void PPEClassBase::ParamUpdateQueueCleanup ( int order )

protected

Definition at line 308 of file ppematclassesbase.c.

◆ ParamUpdateRemove()

void PPEClassBase::ParamUpdateRemove ( int parameter_idx )

protected

Queue selected parameter for removal from the update queue.

Definition at line 288 of file ppematclassesbase.c.

◆ RegisterMaterialParameters()

void PPEClassBase::RegisterMaterialParameters ( )

protected

inserted into associative array by parameter int value, parameter registration order does not matter (still ordered, though)

◆ RegisterParameterColor()

void PPEClassBase::RegisterParameterColor	(	int	idx,
		string	parameter_name,
		float	r,
		float	g,
		float	b,
		float	a )

protected

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...

Definition at line 102 of file ppematclassesbase.c.

◆ RegisterParameterColorEx()

void PPEClassBase::RegisterParameterColorEx	(	int	idx,
		string	parameter_name,
		float	r,
		float	g,
		float	b,
		float	a,
		typename type	)

protected

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...

Definition at line 111 of file ppematclassesbase.c.

◆ RegisterParameterResource()

void PPEClassBase::RegisterParameterResource	(	int	idx,
		string	parameter_name,
		string	default_path )

protected

Definition at line 141 of file ppematclassesbase.c.

◆ RegisterParameterScalarBool()

void PPEClassBase::RegisterParameterScalarBool	(	int	idx,
		string	parameter_name,
		bool	default_value )

protected

Definition at line 59 of file ppematclassesbase.c.

◆ RegisterParameterScalarFloat()

void PPEClassBase::RegisterParameterScalarFloat	(	int	idx,
		string	parameter_name,
		float	default_value,
		float	min,
		float	max )

protected

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...

Definition at line 77 of file ppematclassesbase.c.

◆ RegisterParameterScalarFloatEx()

void PPEClassBase::RegisterParameterScalarFloatEx	(	int	idx,
		string	parameter_name,
		float	default_value,
		float	min,
		float	max,
		typename type	)

protected

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...

Definition at line 87 of file ppematclassesbase.c.

◆ RegisterParameterScalarInt()

void PPEClassBase::RegisterParameterScalarInt	(	int	idx,
		string	parameter_name,
		int	default_value,
		int	min,
		int	max )

protected

Definition at line 67 of file ppematclassesbase.c.

◆ RegisterParameterTexture()

void PPEClassBase::RegisterParameterTexture	(	int	idx,
		string	parameter_name,
		string	default_path )

protected

Definition at line 133 of file ppematclassesbase.c.

◆ RegisterParameterVector()

void PPEClassBase::RegisterParameterVector	(	int	idx,
		string	parameter_name,
		array< float >	default_values )

protected

Definition at line 124 of file ppematclassesbase.c.

◆ RemoveRequest()

void PPEClassBase::RemoveRequest ( int req_idx )

protected

unused, see 'RemoveActiveRequestFromMaterials' for more info

Definition at line 170 of file ppematclassesbase.c.

◆ SetFinalParameterValue()

void PPEClassBase::SetFinalParameterValue ( int parameter_idx )

protected

Clamps the values being set to defaults, if there is no request setting non-zero values on the parameter.

Definition at line 228 of file ppematclassesbase.c.

◆ SetParameterUpdating()

void PPEClassBase::SetParameterUpdating	(	int	order,
		int	parameter_id )

protected

Queue specific parameter of this material to update.

Definition at line 295 of file ppematclassesbase.c.

Member Data Documentation

◆ m_Manager

PPEManager PPEClassBase::m_Manager

protected

Definition at line 4 of file ppematclassesbase.c.

◆ m_Material

Material PPEClassBase::m_Material

protected

Definition at line 6 of file ppematclassesbase.c.

◆ m_MaterialParamMapStructure

ref map<int,ref PPEMatClassParameterCommandData> PPEClassBase::m_MaterialParamMapStructure

protected

Definition at line 12 of file ppematclassesbase.c.

◆ m_MaterialPath

string PPEClassBase::m_MaterialPath = ""

protected

Definition at line 5 of file ppematclassesbase.c.

◆ m_ParameterRemovalQueue

ref array<int> PPEClassBase::m_ParameterRemovalQueue

protected

Definition at line 9 of file ppematclassesbase.c.

◆ m_ParameterUpdateQueueMap

ref map<int, ref array<int> > PPEClassBase::m_ParameterUpdateQueueMap

protected

Definition at line 8 of file ppematclassesbase.c.

◆ m_UpdatedParameters

ref array<int> PPEClassBase::m_UpdatedParameters

protected

Definition at line 10 of file ppematclassesbase.c.

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

Daten/3_game/ppemanager/materials/ppematclassesbase.c

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PPEClassBase()

Member Function Documentation

◆ ApplyValueChanges()

◆ ChangeMaterialPathUsed()

◆ CreateDataStructure()

◆ CreateMaterial()

◆ DbgPrnt()

◆ GetCurrentMaterialPath()

◆ GetDefaultMaterialPath()

◆ GetMaterial()

◆ GetParameterCommandData()

◆ GetPostProcessEffectID()

◆ Init()

◆ InsertParamValueData()

◆ InsertUpdatedParameter()

◆ OnUpdate()

◆ ParamUpdateQueueCleanup()

◆ ParamUpdateRemove()

◆ RegisterMaterialParameters()

◆ RegisterParameterColor()

◆ RegisterParameterColorEx()

◆ RegisterParameterResource()

◆ RegisterParameterScalarBool()

◆ RegisterParameterScalarFloat()

◆ RegisterParameterScalarFloatEx()

◆ RegisterParameterScalarInt()

◆ RegisterParameterTexture()

◆ RegisterParameterVector()

◆ RemoveRequest()

◆ SetFinalParameterValue()

◆ SetParameterUpdating()

Member Data Documentation

◆ m_Manager

◆ m_Material

◆ m_MaterialParamMapStructure

◆ m_MaterialPath

◆ m_ParameterRemovalQueue

◆ m_ParameterUpdateQueueMap

◆ m_UpdatedParameters