TouchEffect Class Reference

Basic object to apply effects. More...

#include <WeArtEffect.h>

Inheritance diagram for TouchEffect:

Public Member Functions
	TouchEffect (WeArtTemperature temp, WeArtForce force, WeArtTexture texture)
bool	Set (WeArtTemperature temp, WeArtForce force, WeArtTexture texture)
	Set the effect parameters.
virtual WeArtTemperature	getTemperature () override
	Get temperature value.
virtual WeArtForce	getForce () override
	Get force value.
virtual WeArtTexture	getTexture () override
	Get texture value.
virtual WeArtTemperature	getTemperature ()=0
	Get temperature value.
virtual WeArtForce	getForce ()=0
	Get force value.
virtual WeArtTexture	getTexture ()=0
	Get texture value.

Detailed Description

Basic object to apply effects.

The TouchEffect object allows to apply simple effect to an haptic object. The temperature and force values are applied as set in the object, while the texture velocity is forced to its maximum value if active.

Constructor & Destructor Documentation

TouchEffect()

TouchEffect::TouchEffect ( WeArtTemperature  temp, WeArtForce  force, WeArtTexture  texture  )

inline

Member Function Documentation

getForce()

virtual WeArtForce TouchEffect::getForce ( )

inlineoverridevirtual

Get force value.

Returns

current effect forcevalue

Implements WeArtEffect.

getTemperature()

virtual WeArtTemperature TouchEffect::getTemperature ( )

inlineoverridevirtual

Get temperature value.

Returns

current effect temperature value

Implements WeArtEffect.

getTexture()

virtual WeArtTexture TouchEffect::getTexture ( )

inlineoverridevirtual

Get texture value.

Returns

current effect texture value

Implements WeArtEffect.

Set()

bool TouchEffect::Set	(	WeArtTemperature	temp,
		WeArtForce	force,
		WeArtTexture	texture
	)

Set the effect parameters.

Parameters

temp	Temperature to apply
force	Force to apply
texture	Texture to apply

Returns

true if one of the parameters changed, false otherwise

---

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

• WeArtEffect.h
• WeArtEffect.cpp