Класс PPERequesterBase

Защищенные члены
void	PPERequesterBase (int requester_IDX)
void	SetRequesterUpdating (bool state)
	Has to be set for the requester to be handled.
void	Start (Param par=null)
void	Stop (Param par=null)
bool	IsRequesterRunning ()
void	SetRequesterIDX (int idx)
	automatically assigned by PPERequesterBank
int	GetRequesterIDX ()
	Returns requester index.
int	GetCategoryMask ()
	mask for mass-handling methods like 'StopAllEffects'
void	SetTargetValueBool (int mat_id, int param_idx, bool val, int priority_layer, int operator=PPOperators.SET)
void	SetTargetValueBoolDefault (int mat_id, int param_idx)
void	SetTargetValueInt (int mat_id, int param_idx, bool relative, int val, int priority_layer, int operator=PPOperators.SET)
void	SetTargetValueIntDefault (int mat_id, int param_idx)
void	SetTargetValueFloat (int mat_id, int param_idx, bool relative, float val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
void	SetTargetValueFloatDefault (int mat_id, int param_idx)
void	SetTargetValueColor (int mat_id, int param_idx, ref array< float > val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
void	SetTargetValueColorDefault (int mat_id, int param_idx)
void	QueueValuesSend ()
	Sets this requester to update in the manager.
PPERequestParamDataBase	GetRequestData (int mat_id, int param_idx, int type)
	returns request data for specific parameter, or creates one if one does not exist in this request yet (singletons)
PPERequestParamDataBase	PrepareData (int mat_id, int param_idx, int type)
map< int, ref map< int, ref PPERequestParamDataBase > >	GetActiveRequestStructure ()
void	ClearRequesterData ()
void	SendCurrentValueData (PPERequestParamDataBase data)
void	OnUpdate (float delta)
void	OnStart (Param par=null)
void	OnStop (Param par=null)
	automatically resets all material parameters of this requester to defaults
float	RelativizeValue (float value, int var_type, int mat_id, int param_id, bool relative)
	converts all values used to relative values (if not relative already)
void	SetDefaultValuesAll ()
	Sets all requested values to default, ignoring them in further calculations.
void	DbgPrnt (string text)

Защищенные данные
bool	m_IsRunning
bool	m_ValuesSent
int	m_IDX
bool	m_Valid = false
ref map< int, ref map< int, ref PPERequestParamDataBase > >	m_RequestDataStructure

Закрытые члены
override int	GetCategoryMask ()

Подробное описание

Конструктор(ы)

PPERequesterBase()

void PPERequesterBase ( int requester_IDX )

inlineprotected

    {
        m_Valid = PPERequesterBank.VerifyRequester(this);
        
        m_IDX = requester_IDX;
        m_ValuesSent = true;
        m_IsRunning = false;
        m_RequestDataStructure = new map<int,ref map<int,ref PPERequestParamDataBase>>;
    }

Перекрестные ссылки m_IDX, m_IsRunning, m_RequestDataStructure, m_Valid и m_ValuesSent.

Методы

ClearRequesterData()

void ClearRequesterData ( )

inlineprotected

    {
        m_RequestDataStructure.Clear();
    }

Перекрестные ссылки m_RequestDataStructure.

DbgPrnt()

void DbgPrnt ( string text )

inlineprotected

    {
        //Debug.Log(""+text);
    }

GetActiveRequestStructure()

map< int, ref map< int, ref PPERequestParamDataBase > > GetActiveRequestStructure ( )

inlineprotected

    {
        return m_RequestDataStructure;
    }

Перекрестные ссылки m_RequestDataStructure.

GetCategoryMask() [1/2]

int GetCategoryMask ( )

inlineprotected

mask for mass-handling methods like 'StopAllEffects'

    {
        return PPERequesterCategory.NONE;
    }

GetCategoryMask() [2/2]

override int GetCategoryMask ( )

inlineprivate

    {
        return PPERequesterCategory.MENU_EFFECTS;
    }

GetRequestData()

PPERequestParamDataBase GetRequestData ( int mat_id, int param_idx, int type )

inlineprotected

returns request data for specific parameter, or creates one if one does not exist in this request yet (singletons)

    {
        PPERequestParamDataBase data;
        if ( m_RequestDataStructure.Get(mat_id) )
        {
            if (m_RequestDataStructure.Get(mat_id).Get(param_idx))
            {
                data = m_RequestDataStructure.Get(mat_id).Get(param_idx);
            }
            else
            {
                data = PrepareData(mat_id,param_idx,type);
                m_RequestDataStructure.Get(mat_id).Set(param_idx,data);
            }
        }
        else
        {
            data = PrepareData(mat_id,param_idx,type);
            map<int,ref PPERequestParamDataBase> temp_map = new map<int,ref PPERequestParamDataBase>;
            temp_map.Set(param_idx,data);
            m_RequestDataStructure.Set(mat_id, temp_map);
        }
        
        if (!data)
        {
            Error("GetRequestData | no data found in the structure");
        }
        
        data.m_Requester = this;
        
        return data;
    }

Перекрестные ссылки Error(), m_RequestDataStructure и PrepareData().

Используется в SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt() и SetTargetValueIntDefault().

GetRequesterIDX()

int GetRequesterIDX ( )

inlineprotected

Returns requester index.

    {
        return m_IDX;
    }

Перекрестные ссылки m_IDX.

IsRequesterRunning()

bool IsRequesterRunning ( )

inlineprotected

    {
        return m_IsRunning;
    }

Перекрестные ссылки m_IsRunning.

OnStart()

void OnStart ( Param par = null )

inlineprotected

    {
        SetRequesterUpdating(true);
    }

Перекрестные ссылки SetRequesterUpdating().

Используется в Start().

OnStop()

void OnStop ( Param par = null )

inlineprotected

automatically resets all material parameters of this requester to defaults

    {
        //DbgPrnt("PPEDebug | " + this + " | OnStop");
        SetRequesterUpdating(true);
        SetDefaultValuesAll();
    }

Перекрестные ссылки SetDefaultValuesAll() и SetRequesterUpdating().

Используется в Stop().

OnUpdate()

void OnUpdate ( float delta )

inlineprotected

    {
        //DbgPrnt("PPEDebug | PPERequesterBase | OnUpdate");
        
        if ( !m_ValuesSent )
        {
            for (int i = 0; i < m_RequestDataStructure.Count(); i++)
            {
                for (int j = 0; j < m_RequestDataStructure.GetElement(i).Count(); j++)
                {
                    SendCurrentValueData(m_RequestDataStructure.GetElement(i).GetElement(j)); //map<int,ref map<int,PPERequestParamDataBase>> //<material<param,data>>
                }
            }
            m_ValuesSent = true;
        }
        SetRequesterUpdating(false);
    }

Перекрестные ссылки Count, m_RequestDataStructure, m_ValuesSent, SendCurrentValueData() и SetRequesterUpdating().

PrepareData()

PPERequestParamDataBase PrepareData ( int mat_id, int param_idx, int type )

inlineprotected

    {
        PPERequestParamDataBase data;
        switch (type)
        {
            case PPEConstants.VAR_TYPE_BOOL:
                data = new PPERequestParamDataBool(m_IDX, mat_id, param_idx);
            break;
            
            case PPEConstants.VAR_TYPE_INT:
                data = new PPERequestParamDataInt(m_IDX, mat_id, param_idx);
            break;
            
            case PPEConstants.VAR_TYPE_FLOAT:
                data = new PPERequestParamDataFloat(m_IDX, mat_id, param_idx);
            break;
            
            case PPEConstants.VAR_TYPE_COLOR:
                data = new PPERequestParamDataColor(m_IDX, mat_id, param_idx);
            break;
        }
        return data;
    }

Перекрестные ссылки m_IDX, PPERequestParamDataBool() и PPERequestParamDataFloat().

Используется в GetRequestData().

QueueValuesSend()

void QueueValuesSend ( )

inlineprotected

Sets this requester to update in the manager.

    {
        m_ValuesSent = false;
        //m_IsRunning = true;
        SetRequesterUpdating(true);
    }

Перекрестные ссылки m_ValuesSent и SetRequesterUpdating().

Используется в SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt() и SetTargetValueIntDefault().

RelativizeValue()

float RelativizeValue ( float value, int var_type, int mat_id, int param_id, bool relative )

inlineprotected

converts all values used to relative values (if not relative already)

    {
        float ret = value;
        if (!relative) //if not already relative...
        {
            switch (var_type)
            {
                case PPEConstants.VAR_TYPE_FLOAT:
                    PPETemplateDefFloat p_float = PPETemplateDefFloat.Cast(PPEManagerStatic.GetPPEManager().GetPostProcessDefaultValues(mat_id,param_id));
                    ret = Math.InverseLerp(p_float.param3, p_float.param4, ret);
                    ret = Math.Clamp(ret,0.0,1.0);
                break;
            }
        }
        //Print("RelativizeValue: " + ret);
        
        return ret;
    }

Перекрестные ссылки Math::Clamp(), PPEManagerStatic::GetPPEManager() и Math::InverseLerp().

Используется в SetTargetValueFloat().

SendCurrentValueData()

void SendCurrentValueData ( PPERequestParamDataBase data )

inlineprotected

    {
        PPEManagerStatic.GetPPEManager().SendMaterialValueData(data);
    }

Перекрестные ссылки PPEManagerStatic::GetPPEManager().

Используется в OnUpdate().

SetDefaultValuesAll()

void SetDefaultValuesAll ( )

inlineprotected

Sets all requested values to default, ignoring them in further calculations.

    {
        //<material<param_id,data>>
        PPERequestParamDataBase req_data;
        
        for (int i = 0; i < m_RequestDataStructure.Count(); i++)
        {
            for (int j = 0; j < m_RequestDataStructure.GetElement(i).Count(); j++)
            {
                req_data = m_RequestDataStructure.GetElement(i).GetElement(j);
                
                if (!req_data.IsDataActive())
                    continue;
                
                switch (req_data.GetVarType())
                {
                    case PPEConstants.VAR_TYPE_BOOL:
                        SetTargetValueBoolDefault(req_data.GetMaterialID(),req_data.GetParameterID());
                    break;
                    
                    case PPEConstants.VAR_TYPE_INT:
                        SetTargetValueIntDefault(req_data.GetMaterialID(),req_data.GetParameterID());
                    break;
                    
                    case PPEConstants.VAR_TYPE_FLOAT:
                        SetTargetValueFloatDefault(req_data.GetMaterialID(),req_data.GetParameterID());
                    break;
                    
                    case PPEConstants.VAR_TYPE_COLOR:
                        SetTargetValueColorDefault(req_data.GetMaterialID(),req_data.GetParameterID());
                    break;
                }
            }
        }
    }

Перекрестные ссылки Count, m_RequestDataStructure, SetTargetValueBoolDefault(), SetTargetValueColorDefault(), SetTargetValueFloatDefault() и SetTargetValueIntDefault().

Используется в OnStop().

SetRequesterIDX()

void SetRequesterIDX ( int idx )

inlineprotected

automatically assigned by PPERequesterBank

    {
        m_IDX = idx;
    }

Перекрестные ссылки m_IDX.

SetRequesterUpdating()

void SetRequesterUpdating ( bool state )

inlineprotected

Has to be set for the requester to be handled.

    {
        if (!m_Valid)
        {
            Debug.Log("" + this + " not valid!");
            return;
        }
        
        PPEManagerStatic.GetPPEManager().SetRequestUpdating(this,state);
        
        //TODO - separate into its own function?
        if (state)
            PPEManagerStatic.GetPPEManager().SetRequestActive(this,true);
    }

Перекрестные ссылки PPEManagerStatic::GetPPEManager(), Debug::Log() и m_Valid.

Используется в OnStart(), OnStop(), OnUpdate() и QueueValuesSend().

SetTargetValueBool()

void SetTargetValueBool ( int mat_id, int param_idx, bool val, int priority_layer, int operator = PPOperators.SET )

inlineprotected

    {
        if ( !m_RequestDataStructure )
            return;
        
        PPERequestParamDataBool data = PPERequestParamDataBool.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_BOOL));
        data.SetPriorityLayer(priority_layer);
        data.SetInteractionMask(operator);
        
        data.m_BoolTarget = val;
        data.m_BoolLast = data.m_BoolCurrent;
        
        if (data.m_BoolTarget != data.m_BoolCurrent || data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(false);
            data.SetDataActive(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueBool | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure, PPERequestParamDataBool() и QueueValuesSend().

SetTargetValueBoolDefault()

void SetTargetValueBoolDefault ( int mat_id, int param_idx )

inlineprotected

    {
        //TODO - running check and cleanup rework (elsewhere!)
        if ( !m_RequestDataStructure || !m_RequestDataStructure.Get(mat_id) || !m_RequestDataStructure.Get(mat_id).Get(param_idx))
            return;
        
        PPERequestParamDataBool data = PPERequestParamDataBool.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_BOOL));
        data.m_BoolLast = data.m_BoolCurrent;
        if (!data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueBoolDefault | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure, PPERequestParamDataBool() и QueueValuesSend().

Используется в SetDefaultValuesAll().

SetTargetValueColor()

void SetTargetValueColor ( int mat_id, int param_idx, ref array< float > val, int priority_layer, int operator = PPOperators.ADD_RELATIVE )

inlineprotected

    {
        if ( !m_RequestDataStructure )
            return;
        
        PPERequestParamDataColor data = PPERequestParamDataColor.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_COLOR));
        data.SetPriorityLayer(priority_layer);
        data.SetInteractionMask(operator);
        data.m_ColorFormerTarget = data.m_ColorTarget;
        
        data.m_ColorTarget.Copy(val);
        
        data.m_ColorLast = data.m_ColorCurrent;
        data.m_ColorStart = data.m_ColorCurrent;
        //if (data.m_ColorTarget != data.m_ColorCurrent)
        {
            data.SetSettingDefaultValues(false);
            data.SetDataActive(true);
                    
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueColor | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure и QueueValuesSend().

SetTargetValueColorDefault()

void SetTargetValueColorDefault ( int mat_id, int param_idx )

inlineprotected

    {
        //TODO - running check and cleanup rework (elsewhere!)
        if ( !m_RequestDataStructure || !m_RequestDataStructure.Get(mat_id) || !m_RequestDataStructure.Get(mat_id).Get(param_idx))
            return;
        
        PPERequestParamDataColor data = PPERequestParamDataColor.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_COLOR));
        data.m_ColorFormerTarget = data.m_ColorTarget;
        data.m_ColorLast = data.m_ColorCurrent;
        data.m_ColorStart = data.m_ColorCurrent;
        if (!data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueColorDefault | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure и QueueValuesSend().

Используется в SetDefaultValuesAll().

SetTargetValueFloat()

void SetTargetValueFloat ( int mat_id, int param_idx, bool relative, float val, int priority_layer, int operator = PPOperators.ADD_RELATIVE )

inlineprotected

    {
        if ( !m_RequestDataStructure )
            return;
        
        PPERequestParamDataFloat data = PPERequestParamDataFloat.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_FLOAT));
        data.SetPriorityLayer(priority_layer);
        data.SetInteractionMask(operator);
        
        data.m_FloatFormerTarget = data.m_FloatTarget;
        data.m_FloatTarget = RelativizeValue(val,PPEConstants.VAR_TYPE_FLOAT,mat_id,param_idx,relative);
        data.m_FloatLast = data.m_FloatCurrent;
        data.m_FloatStart = data.m_FloatCurrent;
        if (data.m_FloatTarget != data.m_FloatCurrent || data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(false);
            data.SetDataActive(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueFloat | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure, PPERequestParamDataFloat(), QueueValuesSend() и RelativizeValue().

SetTargetValueFloatDefault()

void SetTargetValueFloatDefault ( int mat_id, int param_idx )

inlineprotected

    {
        //TODO - running check and cleanup rework (elsewhere!)
        if ( !m_RequestDataStructure || !m_RequestDataStructure.Get(mat_id) || !m_RequestDataStructure.Get(mat_id).Get(param_idx))
            return;
        
        PPERequestParamDataFloat data = PPERequestParamDataFloat.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_FLOAT));
        data.m_FloatFormerTarget = data.m_FloatTarget;
        data.m_FloatLast = data.m_FloatCurrent;
        data.m_FloatStart = data.m_FloatCurrent;
        if (!data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueFloatDefault | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure, PPERequestParamDataFloat() и QueueValuesSend().

Используется в SetDefaultValuesAll().

SetTargetValueInt()

void SetTargetValueInt ( int mat_id, int param_idx, bool relative, int val, int priority_layer, int operator = PPOperators.SET )

inlineprotected

    {
        if ( !m_RequestDataStructure )
            return;
        
        PPERequestParamDataInt data = PPERequestParamDataInt.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_INT));
        data.SetPriorityLayer(priority_layer);
        data.SetInteractionMask(operator);
        
        data.m_IntTarget = val;
        data.m_IntLast = data.m_IntCurrent;
        if (data.m_IntTarget != data.m_IntCurrent || data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(false);
            data.SetDataActive(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueInt | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure и QueueValuesSend().

SetTargetValueIntDefault()

void SetTargetValueIntDefault ( int mat_id, int param_idx )

inlineprotected

    {
        //TODO - running check and cleanup rework (elsewhere!)
        if ( !m_RequestDataStructure || !m_RequestDataStructure.Get(mat_id) || !m_RequestDataStructure.Get(mat_id).Get(param_idx))
            return;
        
        PPERequestParamDataInt data = PPERequestParamDataInt.Cast(GetRequestData(mat_id,param_idx,PPEConstants.VAR_TYPE_INT));
        data.m_IntLast = data.m_IntCurrent;
        if (!data.IsSettingDefaultValues())
        {
            data.SetSettingDefaultValues(true);
            
            QueueValuesSend();
        }
        //DbgPrnt("PPEDebug | PPERequesterBase - SetTargetValueIntDefault | mat/par/req: " + mat_id + "/" + param_idx + "/" + m_IDX + " | data: " + data);
    }

Перекрестные ссылки GetRequestData(), m_RequestDataStructure и QueueValuesSend().

Используется в SetDefaultValuesAll().

Start()

void Start ( Param par = null )

inlineprotected

    {
        OnStart(par);
        m_IsRunning = true;
    }

Перекрестные ссылки m_IsRunning и OnStart().

Stop()

void Stop ( Param par = null )

inlineprotected

    {
        if (!m_RequestDataStructure || m_RequestDataStructure.Count() <= 0)
            return;
        
        OnStop(par);
        m_IsRunning = false;
    }

Перекрестные ссылки m_IsRunning, m_RequestDataStructure и OnStop().

Поля

m_IDX

int m_IDX

protected

Используется в GetRequesterIDX(), PPERequesterBase(), PrepareData() и SetRequesterIDX().

m_IsRunning

bool m_IsRunning

protected

Используется в IsRequesterRunning(), PPERequesterBase(), Start() и Stop().

m_RequestDataStructure

ref map<int,ref map<int,ref PPERequestParamDataBase> > m_RequestDataStructure

protected

Используется в ClearRequesterData(), GetActiveRequestStructure(), GetRequestData(), OnUpdate(), PPERequesterBase(), SetDefaultValuesAll(), SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt(), SetTargetValueIntDefault() и Stop().

m_Valid

bool m_Valid = false

protected

Используется в PPERequesterBase() и SetRequesterUpdating().

m_ValuesSent

bool m_ValuesSent

protected

Используется в OnUpdate(), PPERequesterBase() и QueueValuesSend().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/PPEManager/Requesters/PPERequestPlatformsBase.c