Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 820

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfeedbackeffect.cpp -->
  <title>Qt Mobility 1.2: QFeedbackHapticsEffect Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtfeedback.html">QtFeedback</a></li>
<li>QFeedbackHapticsEffect</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QFeedbackHapticsEffect Class Reference</h1>
<!-- $$$QFeedbackHapticsEffect-brief -->
<p>The QFeedbackHapticsEffect class allows you to play a haptics effect. <a href="#details">More...</a></p>
<!-- @@@QFeedbackHapticsEffect -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QFeedbackHapticsEffect&gt;</span></pre><p><b>Inherits: </b><a href="qfeedbackeffect.html">QFeedbackEffect</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qfeedbackhapticseffect-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#actuator-prop">actuator</a></b> : QFeedbackActuator *</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#attackIntensity-prop">attackIntensity</a></b> : qreal</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a></b> : int</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#duration-prop">duration</a></b> : int</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#fadeIntensity-prop">fadeIntensity</a></b> : qreal</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a></b> : int</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a></b> : qreal</li>
<li class="fn"><b><a href="qfeedbackhapticseffect.html#period-prop">period</a></b> : int</li>
</ul>
</td></tr>
</table>
<ul>
<li class="fn">2 properties inherited from <a href="qfeedbackeffect.html#properties">QFeedbackEffect</a></li>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#QFeedbackHapticsEffect">QFeedbackHapticsEffect</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#dtor.QFeedbackHapticsEffect">~QFeedbackHapticsEffect</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QFeedbackActuator * </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#actuator-prop">actuator</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#attackIntensity-prop">attackIntensity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#fadeIntensity-prop">fadeIntensity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#period-prop">period</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#actuator-prop">setActuator</a></b> ( QFeedbackActuator * <i>actuator</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#attackIntensity-prop">setAttackIntensity</a></b> ( qreal <i>intensity</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#attackTime-prop">setAttackTime</a></b> ( int <i>msecs</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#duration-prop">setDuration</a></b> ( int <i>msecs</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#fadeIntensity-prop">setFadeIntensity</a></b> ( qreal <i>intensity</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#fadeTime-prop">setFadeTime</a></b> ( int <i>msecs</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#intensity-prop">setIntensity</a></b> ( qreal <i>intensity</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#period-prop">setPeriod</a></b> ( int <i>msecs</i> )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticseffect.html#duration-prop">duration</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">2 public functions inherited from <a href="qfeedbackeffect.html#public-functions">QFeedbackEffect</a></li>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 public slots inherited from <a href="qfeedbackeffect.html#public-slots">QFeedbackEffect</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="qfeedbackeffect.html#signals">QFeedbackEffect</a></li>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">2 static public members inherited from <a href="qfeedbackeffect.html#static-public-members">QFeedbackEffect</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qfeedbackeffect.html#protected-functions">QFeedbackEffect</a></li>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFeedbackHapticsEffect-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QFeedbackHapticsEffect class allows you to play a haptics effect.</p>
<p>A haptics effect is an effect that takes advantage of the sense of touch. Most mobile devices today supports one such effect, vibration, which will then be the default when you create a QFeedbackHapticsEffect.</p>
<p>A haptics effect has a few parameters that must be set up before it can be played:</p>
<ul>
<li><a href="qfeedbackhapticseffect.html#duration-prop">duration</a>(): The total duration of the effect in milliseconds.</li>
<li><a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>(): The intensity, e.g&#x2e;, how hard the device will vibrate.</li>
</ul>
<p>An effect can, for example, be set up as follows:</p>
<pre class="cpp"> <span class="type">QFeedbackHapticsEffect</span> rumble;
 rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#intensity-prop">setIntensity</a>(<span class="number">1.0</span>);
 rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#duration-prop">setDuration</a>(<span class="number">100</span>);</pre>
<p>You can now <a href="qfeedbackeffect.html#start">start</a>() the effect.</p>
<pre class="cpp"> rumble<span class="operator">.</span><a href="qfeedbackeffect.html#start">start</a>();</pre>
<p>At any given time, the effect is in one of four states: <a href="qfeedbackeffect.html#State-enum">Stopped</a>, <a href="qfeedbackeffect.html#State-enum">Paused</a>, <a href="qfeedbackeffect.html#State-enum">Running</a>, or <a href="qfeedbackeffect.html#State-enum">Loading</a>. You can request a state change by calling <a href="qfeedbackeffect.html#start">start</a>(), <a href="qfeedbackeffect.html#pause">pause</a>(), or <a href="qfeedbackeffect.html#stop">stop</a>(). The state is queried with <a href="qfeedbackeffect.html#state-prop">state</a>().</p>
<p>The haptics effect also supports a fade-in of the effect. For vibration, this means that the vibration will grow (or sink) in intensity from when the effect starts until <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() is reached. You can set that up as follows:</p>
<pre class="cpp"> rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#attackIntensity-prop">setAttackIntensity</a>(<span class="number">0.0</span>);
 rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#attackTime-prop">setAttackTime</a>(<span class="number">250</span>);</pre>
<p>Attack intensity is the start intensity and attack time is the duration of the fade-in. We have a similar fade-out:</p>
<pre class="cpp"> rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#fadeTime-prop">setFadeTime</a>(<span class="number">250</span>);
 rumble<span class="operator">.</span><a href="qfeedbackhapticseffect.html#fadeIntensity-prop">setFadeIntensity</a>(<span class="number">0.0</span>);</pre>
<p>When using fade-in and fade-out the total duration of the haptics effect will be: <a href="qfeedbackhapticseffect.html#duration-prop">duration</a>(); the main <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() will be played for (<a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() - (<a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>())) milliseconds.</p>
<p>A QFeedbackHapticsEffect is played on an <a href="qfeedbackhapticseffect.html#actuator-prop">actuator()</a>, which is the physical component that performs the effect. You can query if other actuators are available - see the <a href="qfeedbackactuator.html#actuators">QFeedbackActuator::actuators</a>() function documentation for details.</p>
<p>Errors occurring during playback are notified through the <a href="qfeedbackeffect.html#error">error</a>() signal.</p>
</div>
<p><b>See also </b><a href="qfeedbackactuator.html">QFeedbackActuator</a>.</p>
<!-- @@@QFeedbackHapticsEffect -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$actuator-prop$$$actuator$$$setActuatorQFeedbackActuator* -->
<h3 class="fn"><a name="actuator-prop"></a><span class="name">actuator</span> : <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> *</h3>
<p>This property holds the actuator on which the effect operates.</p>
<p>This property defines the actuator on which the effect operates. You can only change the actuator used when the effect is stopped. Setting a null actuator resets the effect to use the default actuator.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QFeedbackActuator * </td><td class="memItemRight bottomAlign"><span class="name"><b>actuator</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setActuator</b></span> ( QFeedbackActuator * <i>actuator</i> )</td></tr>
</table>
<!-- @@@actuator -->
<!-- $$$attackIntensity-prop$$$attackIntensity$$$setAttackIntensityqreal -->
<h3 class="fn"><a name="attackIntensity-prop"></a><span class="name">attackIntensity</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></h3>
<p>This property holds the initial intensity of the effect.</p>
<p>This property defines the initial intensity of the effect, before it fades in. It is usually lower than <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>. The effect will ramp up (or down) from attackIntensity() to <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() in <a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() milliseconds.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>attackIntensity</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAttackIntensity</b></span> ( qreal <i>intensity</i> )</td></tr>
</table>
<!-- @@@attackIntensity -->
<!-- $$$attackTime-prop$$$attackTime$$$setAttackTimeint -->
<h3 class="fn"><a name="attackTime-prop"></a><span class="name">attackTime</span> : <span class="type">int</span></h3>
<p>This property holds the duration of the fade-in effect.</p>
<p>This property defines the duration of the fade-in effect in milliseconds. The effect will ramp up (or down) from <a href="qfeedbackhapticseffect.html#attackIntensity-prop">attackIntensity</a>() to <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() in attackTime() milliseconds.</p>
<p>If the attack time is set to a value such that attackTime() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>() is greater than <a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() for non-periodic effects, or greater than <a href="qfeedbackhapticseffect.html#period-prop">period</a>() for periodic effects, the waveform which will result is backend-specific.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>attackTime</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAttackTime</b></span> ( int <i>msecs</i> )</td></tr>
</table>
<p><b>See also </b><a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() and <a href="qfeedbackhapticseffect.html#period-prop">period</a>().</p>
<!-- @@@attackTime -->
<!-- $$$duration-prop$$$duration$$$setDurationint -->
<h3 class="fn"><a name="duration-prop"></a><span class="name">duration</span> : <span class="type">int</span></h3>
<p>This property holds the expected duration of the effect.</p>
<p>This property defines the total duration of the feedback effect, in milliseconds. It includes the duration of any fade-in or fade-out parts, if any, in non-periodic effects, and includes all repetitions of the period in periodic-effects, if any.</p>
<p>If the duration is set to a value less than <a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>(), or less than the <a href="qfeedbackhapticseffect.html#period-prop">period</a>() of the effect, the waveform which will result is backend-specific.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> virtual int </td><td class="memItemRight bottomAlign"><span class="name"><b>duration</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDuration</b></span> ( int <i>msecs</i> )</td></tr>
</table>
<p><b>See also </b><a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>(), <a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>(), and <a href="qfeedbackhapticseffect.html#period-prop">period</a>().</p>
<!-- @@@duration -->
<!-- $$$fadeIntensity-prop$$$fadeIntensity$$$setFadeIntensityqreal -->
<h3 class="fn"><a name="fadeIntensity-prop"></a><span class="name">fadeIntensity</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></h3>
<p>This property holds the final intensity of the effect.</p>
<p>This property defines the final intensity of the effect, after it fades out. It is usually lower than <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>. The effect will ramp down (or up) from <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() to fadeIntensity() in <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>() milliseconds.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>fadeIntensity</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFadeIntensity</b></span> ( qreal <i>intensity</i> )</td></tr>
</table>
<!-- @@@fadeIntensity -->
<!-- $$$fadeTime-prop$$$fadeTime$$$setFadeTimeint -->
<h3 class="fn"><a name="fadeTime-prop"></a><span class="name">fadeTime</span> : <span class="type">int</span></h3>
<p>This property holds the duration of the fade-out effect.</p>
<p>This property defines the duration of the fade-out effect in milliseconds. The effect will ramp down (or up) from <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() to <a href="qfeedbackhapticseffect.html#fadeIntensity-prop">fadeIntensity</a>() in fadeTime() milliseconds.</p>
<p>If the fade time is set to a value such that <a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + fadeTime() is greater than <a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() for non-periodic effects, or greater than <a href="qfeedbackhapticseffect.html#period-prop">period</a>() for periodic effects, the waveform which will result is backend-specific.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>fadeTime</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFadeTime</b></span> ( int <i>msecs</i> )</td></tr>
</table>
<p><b>See also </b><a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() and <a href="qfeedbackhapticseffect.html#period-prop">period</a>().</p>
<!-- @@@fadeTime -->
<!-- $$$intensity-prop$$$intensity$$$setIntensityqreal -->
<h3 class="fn"><a name="intensity-prop"></a><span class="name">intensity</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></h3>
<p>This property holds the intensity of the effect.</p>
<p>This property defines the intensity of the feedback effect. The value can be between 0 and 1.</p>
<p>For non-periodic effects, the effect will be at this intensity for (<a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() - (<a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>())) milliseconds. For periodic effects, the effect will be at this intensity once per period for (<a href="qfeedbackhapticseffect.html#period-prop">period</a>() - (<a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>())) milliseconds.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>intensity</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setIntensity</b></span> ( qreal <i>intensity</i> )</td></tr>
</table>
<!-- @@@intensity -->
<!-- $$$period-prop$$$period$$$setPeriodint -->
<h3 class="fn"><a name="period-prop"></a><span class="name">period</span> : <span class="type">int</span></h3>
<p>This property holds set the period for the effect.</p>
<p>It has a default value of -1, which means that it is not a periodic effect. You can only change the period when the effect is stopped. The duration of the effect should be set to a value larger than the period of the effect if you wish the periodicity to be discernable. <b>Note:</b> Not all actuators support periodic effects</p>
<p>The period defines the total length of the periodic envelope, which will be repeated up until <a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() milliseconds has elapsed. For a periodic effect, the intensity will start at <a href="qfeedbackhapticseffect.html#attackIntensity-prop">attackIntensity</a>(), ramp to <a href="qfeedbackhapticseffect.html#intensity-prop">intensity</a>() (where it stays for (period() - (<a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>())) milliseconds), then ramp to <a href="qfeedbackhapticseffect.html#fadeIntensity-prop">fadeIntensity</a>(). This waveform will be repeated as many times as required until the <a href="qfeedbackhapticseffect.html#duration-prop">duration</a>() has elapsed.</p>
<p>If the period is set to a value which is less than <a href="qfeedbackhapticseffect.html#attackTime-prop">attackTime</a>() + <a href="qfeedbackhapticseffect.html#fadeTime-prop">fadeTime</a>(), the waveform which will result is backend-specific.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>period</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPeriod</b></span> ( int <i>msecs</i> )</td></tr>
</table>
<!-- @@@period -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QFeedbackHapticsEffect[overload1]$$$QFeedbackHapticsEffectQObject* -->
<h3 class="fn"><a name="QFeedbackHapticsEffect"></a>QFeedbackHapticsEffect::<span class="name">QFeedbackHapticsEffect</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs the <a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a> class, and passes <i>parent</i> to <a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>'s constructor. The default <a href="qfeedbackactuator.html">QFeedbackActuator</a> will be used.</p>
<p><b>See also </b><a href="qfeedbackactuator.html#actuators">QFeedbackActuator::actuators</a>().</p>
<!-- @@@QFeedbackHapticsEffect -->
<!-- $$$~QFeedbackHapticsEffect[overload1]$$$~QFeedbackHapticsEffect -->
<h3 class="fn"><a name="dtor.QFeedbackHapticsEffect"></a>QFeedbackHapticsEffect::<span class="name">~QFeedbackHapticsEffect</span> ()</h3>
<p>Destroys this effect and stops the feedback if it is running.</p>
<!-- @@@~QFeedbackHapticsEffect -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional