135 lines
3.6 KiB
Ucode
135 lines
3.6 KiB
Ucode
|
/**
|
||
|
|
* This class handles various waveform activities. It manages the waveform data
|
||
|
|
* that is being played on any given gamepad at any given time. It is called by
|
||
|
|
* the player controller to start/stop/pause a waveform for a given gamepad. It
|
||
|
|
* is queried by the Viewport to get the current rumble state information
|
||
|
|
* to apply that to the gamepad. It does this by evaluating the function
|
||
|
|
* defined in the waveform sample data.
|
||
|
|
*
|
||
|
|
* Copyright 1998-2013 Epic Games, Inc. All Rights Reserved.
|
||
|
|
*/
|
||
|
|
|
||
|
|
class ForceFeedbackManager extends Object within PlayerController
|
||
|
|
native
|
||
|
|
abstract
|
||
|
|
transient;
|
||
|
|
|
||
|
|
/** Whether the player has disabled gamepad rumble or not (TCR C5-3) */
|
||
|
|
var bool bAllowsForceFeedback;
|
||
|
|
|
||
|
|
/** The currently playing waveform */
|
||
|
|
var ForceFeedbackWaveform FFWaveform;
|
||
|
|
|
||
|
|
/** Whether it was paused by the player controller or not */
|
||
|
|
var bool bIsPaused;
|
||
|
|
|
||
|
|
/** The current waveform sample being played */
|
||
|
|
var int CurrentSample;
|
||
|
|
|
||
|
|
/** The amount of time elapsed since the start of this waveform */
|
||
|
|
var float ElapsedTime;
|
||
|
|
|
||
|
|
//@HSL_BEGIN_XBOX
|
||
|
|
/** The next waveform sample being played */
|
||
|
|
var int NextSample;
|
||
|
|
|
||
|
|
/** The amount of time elapsed since the start of this waveform, for the next frame */
|
||
|
|
var float NextElapsedTime;
|
||
|
|
//@HSL_END_XBOX
|
||
|
|
|
||
|
|
/** The amount to scale all waveforms by (user settable) (TCR C5-3) */
|
||
|
|
var float ScaleAllWaveformsBy;
|
||
|
|
|
||
|
|
/** Used with max waveform distance on the waveform to determine waveform attenuation */
|
||
|
|
var Actor WaveformInstigator;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the waveform to play for the gamepad
|
||
|
|
*
|
||
|
|
* @param ForceFeedbackWaveform The waveform data to play
|
||
|
|
* @param Instigator the actor causing the rumble
|
||
|
|
*/
|
||
|
|
simulated function PlayForceFeedbackWaveform(ForceFeedbackWaveform Waveform,Actor WaveInstigator)
|
||
|
|
{
|
||
|
|
`if(`__TW_)
|
||
|
|
if (Waveform == None || Waveform.Samples.Length == 0 || !bAllowsForceFeedback)
|
||
|
|
{
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
`endif // __TW_
|
||
|
|
|
||
|
|
// Zero out the current sample and duration and unpause if paused
|
||
|
|
CurrentSample = 0;
|
||
|
|
ElapsedTime = 0.0;
|
||
|
|
//@HSL_BEGIN_XBOX
|
||
|
|
NextSample = 0;
|
||
|
|
NextElapsedTime = 0.0;
|
||
|
|
//@HSL_END_XBOX
|
||
|
|
bIsPaused = false;
|
||
|
|
FFWaveform = None;
|
||
|
|
WaveformInstigator = None;
|
||
|
|
// Make sure the waveform is valid
|
||
|
|
if (Waveform != None &&
|
||
|
|
Waveform.Samples.Length > 0 &&
|
||
|
|
bAllowsForceFeedback == true)
|
||
|
|
{
|
||
|
|
// Set the wave form to play
|
||
|
|
FFWaveform = Waveform;
|
||
|
|
WaveformInstigator = WaveInstigator;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stops the waveform by nulling out the waveform
|
||
|
|
*/
|
||
|
|
simulated function StopForceFeedbackWaveform(optional ForceFeedbackWaveform Waveform)
|
||
|
|
{
|
||
|
|
if (Waveform == None || Waveform == FFWaveform)
|
||
|
|
{
|
||
|
|
// Remove the current waveform
|
||
|
|
FFWaveform = None;
|
||
|
|
WaveformInstigator = None;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pauses/unpauses the playback of the waveform for the gamepad
|
||
|
|
*
|
||
|
|
* @param bPause True to pause, False to resume
|
||
|
|
*/
|
||
|
|
simulated function PauseWaveform(optional bool bPause)
|
||
|
|
{
|
||
|
|
// Set the paused state for the gamepad
|
||
|
|
bIsPaused = bPause;
|
||
|
|
}
|
||
|
|
|
||
|
|
cpptext
|
||
|
|
{
|
||
|
|
protected:
|
||
|
|
/**
|
||
|
|
* Update the currently playing waveform sample
|
||
|
|
*
|
||
|
|
* @param DeltaTime The amount of elapsed time since the last update
|
||
|
|
*/
|
||
|
|
virtual void UpdateWaveformData(FLOAT DeltaTime);
|
||
|
|
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Applies the current waveform data to the gamepad/mouse/etc
|
||
|
|
* This function is platform specific
|
||
|
|
*
|
||
|
|
* @param DeviceID The device that needs updating
|
||
|
|
* @param DeltaTime The amount of elapsed time since the last update
|
||
|
|
*/
|
||
|
|
virtual void ApplyForceFeedback(INT DeviceID,FLOAT DeltaTime) {}
|
||
|
|
|
||
|
|
/** Clear any vibration going on this device right away. */
|
||
|
|
virtual void ForceClearWaveformData(INT DeviceID) {}
|
||
|
|
}
|
||
|
|
|
||
|
|
defaultproperties
|
||
|
|
{
|
||
|
|
bAllowsForceFeedback=true
|
||
|
|
ScaleAllWaveformsBy=1.0
|
||
|
|
}
|