Base class for all controller mappings. More...

#include <ControllerMapping.h>

Inheritance diagram for Ship::ControllerMapping:

Public Member Functions
	ControllerMapping (PhysicalDeviceType physicalDeviceType)
	Constructs a ControllerMapping for the given physical device type.

	~ControllerMapping ()

virtual std::string	GetPhysicalDeviceName ()
	Returns a human-readable name for the physical device associated with this mapping.

PhysicalDeviceType	GetPhysicalDeviceType ()
	Returns the physical device type for this mapping.

Protected Attributes
PhysicalDeviceType	mPhysicalDeviceType

Detailed Description

Base class for all controller mappings.

ControllerMapping associates a mapping with a physical device type and provides a common interface for querying the device name and type. All specialized mapping classes (button, axis, gyro, rumble, LED) derive from this class.

Constructor & Destructor Documentation

◆ ControllerMapping()

Ship::ControllerMapping::ControllerMapping ( PhysicalDeviceType physicalDeviceType )

Constructs a ControllerMapping for the given physical device type.

Parameters

physicalDeviceType The type of physical device this mapping targets.

◆ ~ControllerMapping()

Ship::ControllerMapping::~ControllerMapping ( )

Member Function Documentation

◆ GetPhysicalDeviceName()

virtual std::string Ship::ControllerMapping::GetPhysicalDeviceName ( )

virtual

Returns a human-readable name for the physical device associated with this mapping.

Returns: The physical device name string.

Reimplemented in Ship::KeyboardKeyToAnyMapping, Ship::KeyboardKeyToAxisDirectionMapping, Ship::KeyboardKeyToButtonMapping, Ship::MouseButtonToAnyMapping, Ship::MouseButtonToAxisDirectionMapping, Ship::MouseButtonToButtonMapping, Ship::MouseWheelToAnyMapping, Ship::MouseWheelToAxisDirectionMapping, Ship::MouseWheelToButtonMapping, Ship::SDLAxisDirectionToAnyMapping, Ship::SDLAxisDirectionToAxisDirectionMapping, Ship::SDLAxisDirectionToButtonMapping, Ship::SDLButtonToAnyMapping, Ship::SDLButtonToAxisDirectionMapping, Ship::SDLButtonToButtonMapping, Ship::SDLGyroMapping, Ship::SDLLEDMapping, and Ship::SDLRumbleMapping.

◆ GetPhysicalDeviceType()

PhysicalDeviceType Ship::ControllerMapping::GetPhysicalDeviceType ( )

Returns the physical device type for this mapping.

Returns: The PhysicalDeviceType enum value.

Member Data Documentation

◆ mPhysicalDeviceType

PhysicalDeviceType Ship::ControllerMapping::mPhysicalDeviceType

protected

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

include/ship/controller/controldevice/controller/mapping/ControllerMapping.h

Public Member Functions

Protected Attributes