C4PlayerControlAssignmentSets Class Reference

#include <C4PlayerControl.h>

Public Member Functions
	C4PlayerControlAssignmentSets ()=default
	~C4PlayerControlAssignmentSets ()=default
void	Clear ()
void	CompileFunc (StdCompiler *pComp)
bool	operator== (const C4PlayerControlAssignmentSets &cmp) const
bool	ResolveRefs (C4PlayerControlDefs *pControlDefs)
void	SortAssignments ()
void	MergeFrom (const C4PlayerControlAssignmentSets &Src, C4PlayerControlAssignmentSet::MergeMode merge_mode)
C4PlayerControlAssignmentSet *	CreateEmptySetByTemplate (const C4PlayerControlAssignmentSet &template_set)
void	RemoveSetByName (const char *set_name)
C4PlayerControlAssignmentSet *	GetSetByName (const char *szName)
C4PlayerControlAssignmentSet *	GetDefaultSet ()
int32_t	GetSetIndex (const C4PlayerControlAssignmentSet *set) const
C4PlayerControlAssignmentSet *	GetSetByIndex (int32_t index)
size_t	GetSetCount () const

Detailed Description

Definition at line 278 of file C4PlayerControl.h.

Constructor & Destructor Documentation

C4PlayerControlAssignmentSets()

C4PlayerControlAssignmentSets::C4PlayerControlAssignmentSets ( )

default

~C4PlayerControlAssignmentSets()

C4PlayerControlAssignmentSets::~C4PlayerControlAssignmentSets ( )

default

Member Function Documentation

Clear()

void C4PlayerControlAssignmentSets::Clear

(

)

Definition at line 711 of file C4PlayerControl.cpp.

{
    Sets.clear();
}

Referenced by C4PlayerControlFile::Clear(), C4Game::Clear(), C4Game::InitPlayerControlSettings(), C4Game::InitPlayerControlUserSettings(), and C4ConfigControls::ResetKeys().

Here is the caller graph for this function:

CompileFunc()

void C4PlayerControlAssignmentSets::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 716 of file C4PlayerControl.cpp.

{
    if (pComp->isSerializer() && pComp->isRegistry())
    {
        pComp->Default("ControlSets"); // special registry compiler: Clean out everything before
    }
    pComp->Value(mkNamingAdapt(clear_previous, "ClearPrevious", false));
    pComp->Value(mkSTLContainerAdapt(Sets, StdCompiler::SEP_NONE));
}

References StdCompiler::Default(), StdCompiler::isRegistry(), StdCompiler::isSerializer(), mkNamingAdapt(), mkSTLContainerAdapt(), StdCompiler::SEP_NONE, and StdCompiler::Value().

Here is the call graph for this function:

CreateEmptySetByTemplate()

C4PlayerControlAssignmentSet * C4PlayerControlAssignmentSets::CreateEmptySetByTemplate

(

const C4PlayerControlAssignmentSet &

template_set

)

Definition at line 820 of file C4PlayerControl.cpp.

{
    Sets.emplace_back();
    Sets.back().InitEmptyFromTemplate(template_set);
    return &Sets.back();
}

Referenced by MergeFrom().

Here is the caller graph for this function:

GetDefaultSet()

C4PlayerControlAssignmentSet * C4PlayerControlAssignmentSets::GetDefaultSet

(

)

Definition at line 793 of file C4PlayerControl.cpp.

{
    // default set is first defined control set
    if (Sets.empty()) return nullptr; // nothing defined :(
    return &Sets.front();
}

Referenced by C4Player::InitControl().

Here is the caller graph for this function:

GetSetByIndex()

C4PlayerControlAssignmentSet * C4PlayerControlAssignmentSets::GetSetByIndex

(

int32_t

index

)

Definition at line 810 of file C4PlayerControl.cpp.

{
    // bounds check
    if (index < 0 || index >= (int32_t)Sets.size()) return nullptr;
    // return indexed set
    AssignmentSetList::iterator i = Sets.begin();
    while (index--) ++i;
    return &*i;
}

Referenced by C4StartupPlrPropertiesDlg::OnCtrlChangeLeft(), and C4StartupPlrPropertiesDlg::OnCtrlChangeRight().

Here is the caller graph for this function:

GetSetByName()

C4PlayerControlAssignmentSet * C4PlayerControlAssignmentSets::GetSetByName

(

const char *

szName

)

Definition at line 785 of file C4PlayerControl.cpp.

{
    for (auto & Set : Sets)
        if (WildcardMatch(szName, Set.GetName()))
            return &Set;
    return nullptr;
}

References WildcardMatch().

Referenced by C4Player::InitControl(), MergeFrom(), C4StartupPlrPropertiesDlg::OnCtrlChangeLeft(), C4StartupPlrPropertiesDlg::OnCtrlChangeRight(), and C4StartupPlrPropertiesDlg::UserClose().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSetCount()

size_t C4PlayerControlAssignmentSets::GetSetCount ( ) const

inline

Definition at line 304 of file C4PlayerControl.h.

{ return Sets.size(); }

Referenced by C4StartupPlrPropertiesDlg::OnCtrlChangeLeft(), and C4StartupPlrPropertiesDlg::OnCtrlChangeRight().

Here is the caller graph for this function:

GetSetIndex()

int32_t C4PlayerControlAssignmentSets::GetSetIndex

(

const C4PlayerControlAssignmentSet *

set

)

const

Definition at line 800 of file C4PlayerControl.cpp.

{
    // find set in list; return index
    int32_t index = 0;
    for (AssignmentSetList::const_iterator i = Sets.begin(); i != Sets.end(); ++i,++index)
        if (&*i == set)
            return index;
    return -1; // not found
}

Referenced by C4PlayerControlAssignmentSet::GetPicture(), C4StartupPlrPropertiesDlg::OnCtrlChangeLeft(), and C4StartupPlrPropertiesDlg::OnCtrlChangeRight().

Here is the caller graph for this function:

MergeFrom()

void C4PlayerControlAssignmentSets::MergeFrom	(	const C4PlayerControlAssignmentSets &	Src,
		C4PlayerControlAssignmentSet::MergeMode	merge_mode
	)

Definition at line 731 of file C4PlayerControl.cpp.

{
    // if source set is flagged to clear previous, do this!
    if (Src.clear_previous) Sets.clear();
    // take over all assignments in known sets and new sets defined in Src
    for (const auto & SrcSet : Src.Sets)
    {
        // overwrite if def of same name existed if it's not low priority anyway
        bool fIsWildcardSet = SrcSet.IsWildcardName();
        if (!fIsWildcardSet)
        {
            C4PlayerControlAssignmentSet *pPrevSet = GetSetByName(SrcSet.GetName());
            if (!pPrevSet && merge_mode == C4PlayerControlAssignmentSet::MM_Inherit)
            {
                // inherited sets must go through merge procedure to set inherited links
                pPrevSet = CreateEmptySetByTemplate(SrcSet);
            }
            if (pPrevSet)
            {
                pPrevSet->MergeFrom(SrcSet, merge_mode);
            }
            else
            {
                // new def: Append a copy
                Sets.push_back(SrcSet);
            }
        }
        else
        {
            // source is a wildcard: Merge with all matching sets
            for (auto & DstSet : Sets)
            {
                if (WildcardMatch(SrcSet.GetName(), DstSet.GetName()))
                {
                    DstSet.MergeFrom(SrcSet, merge_mode);
                }
            }
        }
    }
}

References CreateEmptySetByTemplate(), GetSetByName(), C4PlayerControlAssignmentSet::MergeFrom(), C4PlayerControlAssignmentSet::MM_Inherit, and WildcardMatch().

Referenced by C4Game::InitPlayerControlSettings(), C4Game::InitPlayerControlUserSettings(), and C4Game::LoadAdditionalSystemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

operator==()

bool C4PlayerControlAssignmentSets::operator==

(

const C4PlayerControlAssignmentSets &

cmp

)

const

Definition at line 726 of file C4PlayerControl.cpp.

{
    return Sets == cmp.Sets && clear_previous == cmp.clear_previous;
}

RemoveSetByName()

void C4PlayerControlAssignmentSets::RemoveSetByName

(

const char *

set_name

)

Definition at line 827 of file C4PlayerControl.cpp.

{
    for (AssignmentSetList::iterator i = Sets.begin(); i != Sets.end(); ++i)
        if (SEqual(set_name, (*i).GetName()))
        {
            Sets.erase(i);
            return;
        }
}

References SEqual().

Here is the call graph for this function:

ResolveRefs()

bool C4PlayerControlAssignmentSets::ResolveRefs

(

C4PlayerControlDefs *

pControlDefs

)

Definition at line 772 of file C4PlayerControl.cpp.

{
    for (auto & Set : Sets)
        if (!Set.ResolveRefs(pDefs)) return false;
    return true;
}

Referenced by C4Game::InitPlayerControlSettings(), C4Game::InitPlayerControlUserSettings(), C4Game::LoadAdditionalSystemGroup(), and C4Game::OnKeyboardLayoutChanged().

Here is the caller graph for this function:

SortAssignments()

void C4PlayerControlAssignmentSets::SortAssignments

(

)

Definition at line 779 of file C4PlayerControl.cpp.

{
    for (auto & Set : Sets)
        Set.SortAssignments();
}

---

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

• C4PlayerControl.h
• C4PlayerControl.cpp