Ship::AxisDirectionMappingFactory Class Reference

Factory for creating ControllerAxisDirectionMapping instances. More...

#include <AxisDirectionMappingFactory.h>

Static Public Member Functions
static std::shared_ptr< ControllerAxisDirectionMapping >	CreateAxisDirectionMappingFromConfig (uint8_t portIndex, StickIndex stickIndex, std::string id, std::shared_ptr< ConsoleVariable > consoleVariable, std::shared_ptr< ControlDeck > controlDeck, std::shared_ptr< Window > window)
	Deserializes an axis-direction mapping from the configuration string.
static std::vector< std::shared_ptr< ControllerAxisDirectionMapping > >	CreateDefaultKeyboardAxisDirectionMappings (uint8_t portIndex, StickIndex stickIndex, std::shared_ptr< ConsoleVariable > consoleVariable, std::shared_ptr< ControlDeck > controlDeck, std::shared_ptr< Window > window)
	Creates default keyboard mappings for the given stick and direction.
static std::vector< std::shared_ptr< ControllerAxisDirectionMapping > >	CreateDefaultSDLAxisDirectionMappings (uint8_t portIndex, StickIndex stickIndex, std::shared_ptr< ConsoleVariable > consoleVariable, std::shared_ptr< ControlDeck > controlDeck)
	Creates default SDL mappings for the given stick.
static std::shared_ptr< ControllerAxisDirectionMapping >	CreateAxisDirectionMappingFromSDLInput (uint8_t portIndex, StickIndex stickIndex, Direction direction, std::shared_ptr< ConsoleVariable > consoleVariable, std::shared_ptr< ControlDeck > controlDeck)
	Creates an axis-direction mapping from live SDL input for interactive binding.
static std::shared_ptr< ControllerAxisDirectionMapping >	CreateAxisDirectionMappingFromMouseWheelInput (uint8_t portIndex, StickIndex stickIndex, Direction direction, std::shared_ptr< ConsoleVariable > consoleVariable, std::shared_ptr< ControlDeck > controlDeck)
	Creates an axis-direction mapping from mouse wheel input for interactive binding.

Detailed Description

Factory for creating ControllerAxisDirectionMapping instances.

AxisDirectionMappingFactory provides static helpers to create ControllerAxisDirectionMapping instances from various input sources. It supports deserializing axis mappings from persisted configuration, generating default keyboard and SDL mappings, and creating mappings from live SDL input events during interactive binding.

All factory methods require a ConsoleVariable and ControlDeck to track state and configuration. Keyboard and mouse methods also require a Window for key-capture state.

Typical usage (within ControlDeck or ConfigUI):

auto mapping = AxisDirectionMappingFactory::CreateAxisDirectionMappingFromConfig(
    portIndex, stickIndex, mappingId, consoleVariable, controlDeck, window);

Member Function Documentation

CreateAxisDirectionMappingFromConfig()

static std::shared_ptr< ControllerAxisDirectionMapping > Ship::AxisDirectionMappingFactory::CreateAxisDirectionMappingFromConfig ( uint8_t  portIndex, StickIndex  stickIndex, std::string  id, std::shared_ptr< ConsoleVariable >  consoleVariable, std::shared_ptr< ControlDeck >  controlDeck, std::shared_ptr< Window >  window  )

static

Deserializes an axis-direction mapping from the configuration string.

Parameters

portIndex	The controller port index (0-based).
stickIndex	Which stick (C-Stick or Main Stick).
id	Configuration string encoding the input source and direction.
consoleVariable	ConsoleVariable for persisting the mapping.
controlDeck	ControlDeck for physical device access.
window	Window for keyboard input state tracking.

Returns

The deserialized mapping, or nullptr if the configuration string is invalid.

CreateAxisDirectionMappingFromMouseWheelInput()

static std::shared_ptr< ControllerAxisDirectionMapping > Ship::AxisDirectionMappingFactory::CreateAxisDirectionMappingFromMouseWheelInput ( uint8_t  portIndex, StickIndex  stickIndex, Direction  direction, std::shared_ptr< ConsoleVariable >  consoleVariable, std::shared_ptr< ControlDeck >  controlDeck  )

static

Creates an axis-direction mapping from mouse wheel input for interactive binding.

Parameters

portIndex	The controller port index (0-based).
stickIndex	Which stick (C-Stick or Main Stick).
direction	Direction being mapped (Up, Down, Left, Right).
consoleVariable	ConsoleVariable for persisting the mapping.
controlDeck	ControlDeck for physical device access.

Returns

The newly created mapping, or nullptr if input detection failed.

CreateAxisDirectionMappingFromSDLInput()

static std::shared_ptr< ControllerAxisDirectionMapping > Ship::AxisDirectionMappingFactory::CreateAxisDirectionMappingFromSDLInput ( uint8_t  portIndex, StickIndex  stickIndex, Direction  direction, std::shared_ptr< ConsoleVariable >  consoleVariable, std::shared_ptr< ControlDeck >  controlDeck  )

static

Creates an axis-direction mapping from live SDL input for interactive binding.

Parameters

portIndex	The controller port index (0-based).
stickIndex	Which stick (C-Stick or Main Stick).
direction	Direction being mapped (Up, Down, Left, Right).
consoleVariable	ConsoleVariable for persisting the mapping.
controlDeck	ControlDeck for physical device access.

Returns

The newly created mapping, or nullptr if input detection failed.

CreateDefaultKeyboardAxisDirectionMappings()

static std::vector< std::shared_ptr< ControllerAxisDirectionMapping > > Ship::AxisDirectionMappingFactory::CreateDefaultKeyboardAxisDirectionMappings ( uint8_t  portIndex, StickIndex  stickIndex, std::shared_ptr< ConsoleVariable >  consoleVariable, std::shared_ptr< ControlDeck >  controlDeck, std::shared_ptr< Window >  window  )

static

Creates default keyboard mappings for the given stick and direction.

Parameters

portIndex	The controller port index (0-based).
stickIndex	Which stick (C-Stick or Main Stick).
consoleVariable	ConsoleVariable for persisting mappings.
controlDeck	ControlDeck for physical device access.
window	Window for keyboard input state tracking.

Returns

Vector of keyboard mappings (typically 4, one per direction).

CreateDefaultSDLAxisDirectionMappings()

static std::vector< std::shared_ptr< ControllerAxisDirectionMapping > > Ship::AxisDirectionMappingFactory::CreateDefaultSDLAxisDirectionMappings ( uint8_t  portIndex, StickIndex  stickIndex, std::shared_ptr< ConsoleVariable >  consoleVariable, std::shared_ptr< ControlDeck >  controlDeck  )

static

Creates default SDL mappings for the given stick.

Parameters

portIndex	The controller port index (0-based).
stickIndex	Which stick (C-Stick or Main Stick).
consoleVariable	ConsoleVariable for persisting mappings.
controlDeck	ControlDeck for physical device access.

Returns

Vector of SDL axis mappings (typically 4, one per direction).

---

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

• include/ship/controller/controldevice/controller/mapping/factories/AxisDirectionMappingFactory.h