IInputInterface Class Reference

#include <IInputInterface.h>

Inheritance diagram for IInputInterface:

Public Member Functions
virtual	~IInputInterface ()
virtual void	SetForceFeedbackChannelValue (int32 ControllerId, FForceFeedbackChannelType ChannelType, float Value)=0
virtual void	SetForceFeedbackChannelValues (int32 ControllerId, const FForceFeedbackValues &Values)=0
virtual void	SetHapticFeedbackValues (int32 ControllerId, int32 Hand, const FHapticFeedbackValues &Values)
virtual void	SetDeviceProperty (int32 ControllerId, const FInputDeviceProperty *Property)
virtual void	SetLightColor (int32 ControllerId, FColor Color)=0
virtual void	ResetLightColor (int32 ControllerId)=0

Detailed Description

Interface for the input interface.

Constructor & Destructor Documentation

~IInputInterface()

virtual IInputInterface::~IInputInterface ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

ResetLightColor()

virtual void IInputInterface::ResetLightColor ( int32  ControllerId )

pure virtual

Implemented in FAppleControllerInterface, FAndroidInputInterface, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

SetDeviceProperty()

virtual void IInputInterface::SetDeviceProperty ( int32  ControllerId, const FInputDeviceProperty *  Property  )

inlinevirtual

Sets a property for a given controller id. Will be ignored for devices which don't support the property.

Parameters

ControllerId	the id of the controller whose property is to be applied
Property	Base class pointer to property that will be applied

Reimplemented in FWindowsApplication.

SetForceFeedbackChannelValue()

virtual void IInputInterface::SetForceFeedbackChannelValue ( int32  ControllerId, FForceFeedbackChannelType  ChannelType, float  Value  )

pure virtual

Sets the strength/speed of the given channel for the given controller id. NOTE: If the channel is not supported, the call will silently fail

Parameters

ControllerId	the id of the controller whose value is to be set
ChannelType	the type of channel whose value should be set
Value	strength or speed of feedback, 0.0f to 1.0f. 0.0f will disable

Implemented in FAppleControllerInterface, FAndroidInputInterface, FIOSInputInterface, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

SetForceFeedbackChannelValues()

virtual void IInputInterface::SetForceFeedbackChannelValues ( int32  ControllerId, const FForceFeedbackValues &  Values  )

pure virtual

Sets the strength/speed of all the channels for the given controller id. NOTE: Unsupported channels are silently ignored

Parameters

ControllerId	the id of the controller whose value is to be set
FForceFeedbackChannelValues	strength or speed of feedback for all channels

Implemented in FAppleControllerInterface, FAndroidInputInterface, FIOSInputInterface, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

SetHapticFeedbackValues()

virtual void IInputInterface::SetHapticFeedbackValues ( int32  ControllerId, int32  Hand, const FHapticFeedbackValues &  Values  )

inlinevirtual

Sets the frequency and amplitude of haptic feedback channels for a given controller id. Some devices / platforms may support just haptics, or just force feedback.

Parameters

ControllerId	ID of the controller to issue haptic feedback for
HandId	Which hand id (e.g. left or right) to issue the feedback for. These usually correspond to EControllerHands
Values	Frequency and amplitude to haptics at

Reimplemented in FAndroidInputInterface, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

SetLightColor()

virtual void IInputInterface::SetLightColor ( int32  ControllerId, FColor  Color  )

pure virtual

Implemented in FAppleControllerInterface, FAndroidInputInterface, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

---

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

• Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/IInputInterface.h