C4PlayerControlAssignmentSet Class Reference

#include <C4PlayerControl.h>

Public Types
enum	MergeMode { MM_Normal , MM_LowPrio , MM_Inherit , MM_ConfigOverload }

Public Member Functions
	C4PlayerControlAssignmentSet ()=default
	~C4PlayerControlAssignmentSet ()=default
void	InitEmptyFromTemplate (const C4PlayerControlAssignmentSet &template_set)
void	CompileFunc (StdCompiler *pComp)
bool	ResolveRefs (C4PlayerControlDefs *pControlDefs)
void	SortAssignments ()
void	MergeFrom (const C4PlayerControlAssignmentSet &Src, MergeMode merge_mode)
C4PlayerControlAssignment *	CreateAssignmentForControl (const char *control_name)
void	RemoveAssignmentByControlName (const char *control_name)
const char *	GetName () const
const char *	GetGUIName () const
bool	IsWildcardName () const
C4PlayerControlAssignment *	GetAssignmentByIndex (int32_t index)
C4PlayerControlAssignment *	GetAssignmentByControlName (const char *szControlName)
C4PlayerControlAssignment *	GetAssignmentByControl (int32_t control)
void	GetAssignmentsByKey (const C4PlayerControlDefs &rDefs, const C4KeyCodeEx &key, bool fHoldKeysOnly, C4PlayerControlAssignmentPVec *pOutVec, const C4PlayerControlRecentKeyList &DownKeys, const C4PlayerControlRecentKeyList &RecentKeys) const
void	GetTriggerKeys (const C4PlayerControlDefs &rDefs, C4KeyCodeExVec *pRegularKeys, C4KeyCodeExVec *pHoldKeys) const
bool	operator== (const C4PlayerControlAssignmentSet &cmp) const
C4Facet	GetPicture () const
bool	HasKeyboard () const
bool	HasMouse () const
bool	HasGamepad () const
int32_t	GetLayoutOrder () const
bool	IsMouseControlAssigned (int32_t mouseevent) const

Detailed Description

Definition at line 231 of file C4PlayerControl.h.

Member Enumeration Documentation

MergeMode

enum C4PlayerControlAssignmentSet::MergeMode

Enumerator
MM_Normal
MM_LowPrio
MM_Inherit
MM_ConfigOverload

Definition at line 250 of file C4PlayerControl.h.

{ MM_Normal, MM_LowPrio, MM_Inherit, MM_ConfigOverload };

Constructor & Destructor Documentation

C4PlayerControlAssignmentSet()

C4PlayerControlAssignmentSet::C4PlayerControlAssignmentSet ( )

default

~C4PlayerControlAssignmentSet()

C4PlayerControlAssignmentSet::~C4PlayerControlAssignmentSet ( )

default

Member Function Documentation

CompileFunc()

void C4PlayerControlAssignmentSet::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 490 of file C4PlayerControl.cpp.

{
    if (!pComp->Name("ControlSet")) { pComp->NameEnd(); pComp->excNotFound("ControlSet"); }
    pComp->Value(mkNamingAdapt(mkParAdapt(sName, StdCompiler::RCT_All), "Name", "None")); // can't do RCT_Idtf because of wildcards
    pComp->Value(mkNamingAdapt(mkParAdapt(sGUIName, StdCompiler::RCT_All), "GUIName", "undefined"));
    pComp->Value(mkNamingAdapt(mkParAdapt(sParentSetName, StdCompiler::RCT_Idtf), "Parent", ""));
    pComp->Value(mkNamingAdapt(has_keyboard, "Keyboard", true));
    pComp->Value(mkNamingAdapt(has_mouse, "Mouse", true));
    pComp->Value(mkNamingAdapt(has_gamepad, "Gamepad", false));
    pComp->Value(mkSTLContainerAdapt(Assignments, StdCompiler::SEP_NONE));
    pComp->NameEnd();
}

References StdCompiler::excNotFound(), mkNamingAdapt(), mkParAdapt(), mkSTLContainerAdapt(), StdCompiler::Name(), StdCompiler::NameEnd(), StdCompiler::RCT_All, StdCompiler::RCT_Idtf, StdCompiler::SEP_NONE, and StdCompiler::Value().

Here is the call graph for this function:

CreateAssignmentForControl()

C4PlayerControlAssignment * C4PlayerControlAssignmentSet::CreateAssignmentForControl

(

const char *

control_name

)

Definition at line 565 of file C4PlayerControl.cpp.

{
    Assignments.emplace_back();
    Assignments.back().SetControlName(control_name);
    return &Assignments.back();
}

GetAssignmentByControl()

C4PlayerControlAssignment * C4PlayerControlAssignmentSet::GetAssignmentByControl

(

int32_t

control

)

Definition at line 618 of file C4PlayerControl.cpp.

{
    // TODO: Might want to stuff this into a vector indexed by control for faster lookup
    for (auto & Assignment : Assignments)
        if (Assignment.GetControl() == control)
            // We don't like release keys... (2do)
            if (!(Assignment.GetTriggerMode() & C4PlayerControlAssignment::CTM_Release))
                return &Assignment;
    return nullptr;
}

References C4PlayerControlAssignment::CTM_Release.

GetAssignmentByControlName()

C4PlayerControlAssignment * C4PlayerControlAssignmentSet::GetAssignmentByControlName

(

const char *

szControlName

)

Definition at line 608 of file C4PlayerControl.cpp.

{
    for (auto & Assignment : Assignments)
        if (SEqual(Assignment.GetControlName(), szControlName))
            // We don't like release keys... (2do)
            if (!(Assignment.GetTriggerMode() & C4PlayerControlAssignment::CTM_Release))
                return &Assignment;
    return nullptr;
}

References C4PlayerControlAssignment::CTM_Release, and SEqual().

Referenced by C4PlayerControlAssignment::ResolveRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAssignmentByIndex()

C4PlayerControlAssignment * C4PlayerControlAssignmentSet::GetAssignmentByIndex

(

int32_t

index

)

Definition at line 602 of file C4PlayerControl.cpp.

{
    if (index<0 || index>=int32_t(Assignments.size())) return nullptr;
    return &Assignments[index];
}

GetAssignmentsByKey()

void C4PlayerControlAssignmentSet::GetAssignmentsByKey	(	const C4PlayerControlDefs &	rDefs,
		const C4KeyCodeEx &	key,
		bool	fHoldKeysOnly,
		C4PlayerControlAssignmentPVec *	pOutVec,
		const C4PlayerControlRecentKeyList &	DownKeys,
		const C4PlayerControlRecentKeyList &	RecentKeys
	)		const

Definition at line 635 of file C4PlayerControl.cpp.

{
    assert(pOutVec);
    // primary match by TriggerKey (todo: Might use a hash map here if matching speed becomes an issue due to large control sets)
    for (const auto & rAssignment : Assignments)
    {
        const C4KeyCodeEx &rAssignmentTriggerKey = rAssignment.GetTriggerKey();
        if (!(rAssignmentTriggerKey.Key == key.Key)) continue;
        // special: hold-keys-only ignore shift, because shift state might have been release during hold
        if (!fHoldKeysOnly) if (rAssignmentTriggerKey.dwShift != key.dwShift) continue;
        // check linked control def
        const C4PlayerControlDef *pCtrl = rDefs.GetControlByIndex(rAssignment.GetControl());
        if (!pCtrl) continue;
        // only want hold keys?
        if (fHoldKeysOnly)
        {
            // a hold/release-trigger key is not a real hold key, even if the underlying control is
            if (!pCtrl->IsHoldKey() || (rAssignment.GetTriggerMode() & (C4PlayerControlAssignment::CTM_Hold | C4PlayerControlAssignment::CTM_Release))) continue;
        }
        else if (rAssignment.HasCombo())
        {
            // hold-only events match the trigger key only (i.e., Release-events are generated as soon as the trigger key goes up)
            // other events must match either the sequence or the down-key-combination
            if (!rAssignment.IsComboMatched(DownKeys, RecentKeys)) continue;
        }
        // we got  match! Store it
        pOutVec->push_back(&rAssignment);
    }
}

References C4PlayerControlAssignment::CTM_Hold, C4PlayerControlAssignment::CTM_Release, C4KeyCodeEx::dwShift, C4PlayerControlDefs::GetControlByIndex(), C4PlayerControlDef::IsHoldKey(), and C4KeyCodeEx::Key.

Here is the call graph for this function:

GetGUIName()

const char* C4PlayerControlAssignmentSet::GetGUIName ( ) const

inline

Definition at line 257 of file C4PlayerControl.h.

{ return sGUIName.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

GetLayoutOrder()

int32_t C4PlayerControlAssignmentSet::GetLayoutOrder ( ) const

inline

Definition at line 273 of file C4PlayerControl.h.

{ return 0; } // returns position on keyboard (increasing from left to right) for viewport sorting

Referenced by C4ViewportList::SortViewportsByPlayerControl().

Here is the caller graph for this function:

GetName()

const char* C4PlayerControlAssignmentSet::GetName ( ) const

inline

Definition at line 256 of file C4PlayerControl.h.

{ return sName.getData(); }

References StdStrBuf::getData().

Referenced by C4ControlPlayerAction::InitPlayerControl(), C4StartupPlrPropertiesDlg::OnCtrlChangeLeft(), C4StartupPlrPropertiesDlg::OnCtrlChangeRight(), and C4PlayerControlAssignment::ResolveRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPicture()

C4Facet C4PlayerControlAssignmentSet::GetPicture

(

)

const

Definition at line 692 of file C4PlayerControl.cpp.

{
    // get image to be drawn to represent this control set
    // picture per set not implemented yet. So just default to out standard images
    if (HasGamepad()) return ::GraphicsResource.fctGamepad.GetPhase(0);
//  if (HasMouse()) return ::GraphicsResource.fctMouse; // might be useful again with changing control sets
    if (HasKeyboard()) return ::GraphicsResource.fctKeyboard.GetPhase(Game.PlayerControlUserAssignmentSets.GetSetIndex(this));
    return C4Facet();
}

References C4GraphicsResource::fctGamepad, C4GraphicsResource::fctKeyboard, Game, C4Facet::GetPhase(), C4PlayerControlAssignmentSets::GetSetIndex(), GraphicsResource, HasGamepad(), HasKeyboard(), and C4Game::PlayerControlUserAssignmentSets.

Here is the call graph for this function:

GetTriggerKeys()

void C4PlayerControlAssignmentSet::GetTriggerKeys	(	const C4PlayerControlDefs &	rDefs,
		C4KeyCodeExVec *	pRegularKeys,
		C4KeyCodeExVec *	pHoldKeys
	)		const

Definition at line 665 of file C4PlayerControl.cpp.

{
    // put all trigger keys of keyset into output vectors
    // first all hold keys
    for (const auto & rAssignment : Assignments)
    {
        const C4PlayerControlDef *pDef = rDefs.GetControlByIndex(rAssignment.GetControl());
        if (pDef && pDef->IsHoldKey())
        {
            const C4KeyCodeEx &rKey = rAssignment.GetTriggerKey();
            if (std::find(pHoldKeys->begin(), pHoldKeys->end(), rKey) == pHoldKeys->end()) pHoldKeys->push_back(rKey);
        }
    }
    // then all regular keys that aren't in the hold keys list yet
    for (const auto & rAssignment : Assignments)
    {
        const C4PlayerControlDef *pDef = rDefs.GetControlByIndex(rAssignment.GetControl());
        if (pDef && !pDef->IsHoldKey())
        {
            const C4KeyCodeEx &rKey = rAssignment.GetTriggerKey();
            if (std::find(pHoldKeys->begin(), pHoldKeys->end(), rKey) == pHoldKeys->end())
                if (std::find(pRegularKeys->begin(), pRegularKeys->end(), rKey) == pRegularKeys->end())
                    pRegularKeys->push_back(rKey);
        }
    }
}

References C4PlayerControlDefs::GetControlByIndex(), and C4PlayerControlDef::IsHoldKey().

Referenced by C4PlayerControl::RegisterKeyset().

Here is the call graph for this function:

Here is the caller graph for this function:

HasGamepad()

bool C4PlayerControlAssignmentSet::HasGamepad ( ) const

inline

Definition at line 272 of file C4PlayerControl.h.

{ return has_gamepad; }

Referenced by C4Player::Execute(), GetPicture(), C4Player::InitControl(), C4ControlPlayerAction::InitPlayerControl(), and C4StartupPlrPropertiesDlg::UserClose().

Here is the caller graph for this function:

HasKeyboard()

bool C4PlayerControlAssignmentSet::HasKeyboard ( ) const

inline

Definition at line 270 of file C4PlayerControl.h.

{ return has_keyboard; }

Referenced by GetPicture(), and C4ControlPlayerAction::InitPlayerControl().

Here is the caller graph for this function:

HasMouse()

bool C4PlayerControlAssignmentSet::HasMouse ( ) const

inline

Definition at line 271 of file C4PlayerControl.h.

{ return has_mouse; }

Referenced by C4Player::InitControl(), and C4ControlPlayerAction::InitPlayerControl().

Here is the caller graph for this function:

InitEmptyFromTemplate()

void C4PlayerControlAssignmentSet::InitEmptyFromTemplate

(

const C4PlayerControlAssignmentSet &

template_set

)

Definition at line 479 of file C4PlayerControl.cpp.

{
    // copy all fields except assignments
    sName.Copy(template_set.sName);
    sGUIName.Copy(template_set.sGUIName);
    sParentSetName.Copy(template_set.sParentSetName);
    has_keyboard = template_set.has_keyboard;
    has_mouse = template_set.has_mouse;
    has_gamepad = template_set.has_gamepad;
}

References StdStrBuf::Copy().

Here is the call graph for this function:

IsMouseControlAssigned()

bool C4PlayerControlAssignmentSet::IsMouseControlAssigned

(

int32_t

mouseevent

)

const

Definition at line 702 of file C4PlayerControl.cpp.

{
    // TODO
    return true;
}

Referenced by C4MouseControl::DoMoveInput(), and C4MouseControl::Move().

Here is the caller graph for this function:

IsWildcardName()

bool C4PlayerControlAssignmentSet::IsWildcardName ( ) const

inline

Definition at line 258 of file C4PlayerControl.h.

{ return IsWildcardString(sName.getData()); }

References StdStrBuf::getData(), and IsWildcardString().

Here is the call graph for this function:

MergeFrom()

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

Definition at line 505 of file C4PlayerControl.cpp.

{
    // take over all assignments defined in Src
    for (const auto & SrcAssignment : Src.Assignments)
    {
        bool fIsReleaseKey = !!(SrcAssignment.GetTriggerMode() & C4PlayerControlAssignment::CTM_Release);
        // overwrite same def and release key state
        if (merge_mode != MM_LowPrio && SrcAssignment.IsOverrideAssignments())
        {
            // high priority override control clears all previous (very inefficient method...might as well recreate the whole list)
            bool any_remaining = true;
            while (any_remaining)
            {
                any_remaining = false;
                for (C4PlayerControlAssignmentVec::iterator j = Assignments.begin(); j != Assignments.end(); ++j)
                    if (SEqual((*j).GetControlName(), SrcAssignment.GetControlName()))
                    {
                        bool fSelfIsReleaseKey = !!((*j).GetTriggerMode() & C4PlayerControlAssignment::CTM_Release);
                        if (fSelfIsReleaseKey == fIsReleaseKey)
                        {
                            Assignments.erase(j);
                            any_remaining = true;
                            break;
                        }
                    }
            }
        }
        else if (merge_mode == MM_LowPrio || merge_mode == MM_ConfigOverload)
        {
            // if this is low priority, another override control kills this
            bool any_override = false;
            for (auto & Assignment : Assignments)
                if (SEqual(Assignment.GetControlName(), SrcAssignment.GetControlName()))
                {
                    bool fSelfIsReleaseKey = !!(Assignment.GetTriggerMode() & C4PlayerControlAssignment::CTM_Release);
                    if (fSelfIsReleaseKey == fIsReleaseKey)
                    {
                        any_override = true;
                        // config overloads just change the key of the inherited assignment
                        if (merge_mode == MM_ConfigOverload)
                        {
                            Assignment.CopyKeyFrom(SrcAssignment);
                            Assignment.SetInherited(false);
                        }
                        break;
                    }
                }
            if (any_override) continue;
        }
        // new def: Append a copy
        Assignments.push_back(SrcAssignment);
        // inherited marker
        if (merge_mode == MM_Inherit)
        {
            Assignments.back().SetInherited(true);
            Assignments.back().SetInheritedAssignment(&SrcAssignment);
        }
    }
}

References C4PlayerControlAssignment::CTM_Release, MM_ConfigOverload, MM_Inherit, MM_LowPrio, and SEqual().

Referenced by C4PlayerControlAssignmentSets::MergeFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

operator==()

bool C4PlayerControlAssignmentSet::operator==

(

const C4PlayerControlAssignmentSet &

cmp

)

const

Definition at line 629 of file C4PlayerControl.cpp.

{
    return Assignments == cmp.Assignments
           && sName == cmp.sName;
}

RemoveAssignmentByControlName()

void C4PlayerControlAssignmentSet::RemoveAssignmentByControlName

(

const char *

control_name

)

Definition at line 572 of file C4PlayerControl.cpp.

{
    for (C4PlayerControlAssignmentVec::iterator i = Assignments.begin(); i != Assignments.end(); ++i)
        if (SEqual((*i).GetControlName(), control_name))
        {
            Assignments.erase(i);
            return;
        }
}

References SEqual().

Here is the call graph for this function:

ResolveRefs()

bool C4PlayerControlAssignmentSet::ResolveRefs

(

C4PlayerControlDefs *

pControlDefs

)

Definition at line 582 of file C4PlayerControl.cpp.

{
    // reset all resolved flags to allow re-resolve after overloads
    for (auto & Assignment : Assignments)
        Assignment.ResetRefsResolved();
    // resolve in order; ignore already resolved because they might have been resolved by cross reference
    for (auto & Assignment : Assignments)
        if (!Assignment.IsRefsResolved())
            if (!Assignment.ResolveRefs(this, pDefs))
                return false;
    return true;
}

SortAssignments()

void C4PlayerControlAssignmentSet::SortAssignments

(

)

Definition at line 595 of file C4PlayerControl.cpp.

{
    // final init: sort assignments by priority
    // note this screws up sorting for config dialog
    std::sort(Assignments.begin(), Assignments.end());
}

---

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

• C4PlayerControl.h
• C4PlayerControl.cpp