Base class for mappings that bind a mouse scroll-wheel direction to any controller input. More...

#include <MouseWheelToAnyMapping.h>

Inheritance diagram for Ship::MouseWheelToAnyMapping:

Collaboration diagram for Ship::MouseWheelToAnyMapping:

Public Member Functions
	MouseWheelToAnyMapping (WheelDirection wheelDirection)
	Constructs a mouse-wheel mapping for the given scroll direction.

virtual	~MouseWheelToAnyMapping ()
	Destructor.

std::string	GetPhysicalInputName () override
	Returns the human-readable name of the bound wheel direction.

std::string	GetPhysicalDeviceName () override
	Returns the human-readable name of the mouse device.

Public Member Functions inherited from Ship::ControllerInputMapping
	ControllerInputMapping (PhysicalDeviceType physicalDeviceType)
	Constructs a ControllerInputMapping for the given physical device type.

	~ControllerInputMapping ()

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

	~ControllerMapping ()

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

Protected Attributes
WheelDirection	mWheelDirection

Protected Attributes inherited from Ship::ControllerMapping
PhysicalDeviceType	mPhysicalDeviceType

Detailed Description

Base class for mappings that bind a mouse scroll-wheel direction to any controller input.

Provides shared wheel-direction storage and physical device/input name reporting. Concrete subclasses add the target input semantics (button or axis direction).

Constructor & Destructor Documentation

◆ MouseWheelToAnyMapping()

Ship::MouseWheelToAnyMapping::MouseWheelToAnyMapping ( WheelDirection wheelDirection )

Constructs a mouse-wheel mapping for the given scroll direction.

Parameters

wheelDirection The scroll-wheel direction to bind.

◆ ~MouseWheelToAnyMapping()

virtual Ship::MouseWheelToAnyMapping::~MouseWheelToAnyMapping ( )

virtual

Destructor.

Member Function Documentation

◆ GetPhysicalDeviceName()

std::string Ship::MouseWheelToAnyMapping::GetPhysicalDeviceName ( )

overridevirtual

Returns the human-readable name of the mouse device.

Reimplemented from Ship::ControllerMapping.

Reimplemented in Ship::MouseWheelToAxisDirectionMapping, and Ship::MouseWheelToButtonMapping.

◆ GetPhysicalInputName()

std::string Ship::MouseWheelToAnyMapping::GetPhysicalInputName ( )

overridevirtual

Returns the human-readable name of the bound wheel direction.

Reimplemented from Ship::ControllerInputMapping.

Reimplemented in Ship::MouseWheelToAxisDirectionMapping, and Ship::MouseWheelToButtonMapping.

Member Data Documentation

◆ mWheelDirection

WheelDirection Ship::MouseWheelToAnyMapping::mWheelDirection

protected

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

include/ship/controller/controldevice/controller/mapping/mouse/MouseWheelToAnyMapping.h

Public Member Functions

Protected Attributes