WeArt.Components.WeArtHapticObject Class Reference

This component controls the haptic actuators of one or more hardware thimbles. The haptic control can be issued: 1) Manually from the Unity inspector 2) When a WeArtTouchableObject collides with this object 3) On custom haptic effects added or removed 4) On direct value set, through the public properties. More...

Public Member Functions
	WeArtHapticObject (WeArtClient client)
void	AddEffect (IWeArtEffect effect)
	Adds a haptic effect to this object. This effect will have an influence as long as it is not removed or the haptic properties are programmatically forced to have a specified value.
void	RemoveEffect (IWeArtEffect effect)
	Removes a haptic effect from the set of influencing effects.

Properties
HandSideFlags	HandSides [get, set]
	The hand sides to control with this component.
ActuationPointFlags	ActuationPoints [get, set]
	The thimbles to control with this component.
Temperature	Temperature [get, set]
	The current temperature of the specified thimbles.
Force	Force [get, set]
	The current pressing force of the specified thimbles.
Texture	Texture [get, set]
	The current texture feeling applied on the specified thimbles.
IWeArtEffect	ActiveEffect [get]
	The currently active effects on this object.

Events
Action	OnActiveEffectsUpdate
	Called when the resultant haptic effect changes because of the influence caused by the currently active effects.

Detailed Description

This component controls the haptic actuators of one or more hardware thimbles. The haptic control can be issued: 1) Manually from the Unity inspector 2) When a WeArtTouchableObject collides with this object 3) On custom haptic effects added or removed 4) On direct value set, through the public properties.

Constructor & Destructor Documentation

WeArtHapticObject()

WeArt.Components.WeArtHapticObject.WeArtHapticObject ( WeArtClient  client )

inline

Member Function Documentation

AddEffect()

void WeArt.Components.WeArtHapticObject.AddEffect ( IWeArtEffect  effect )

inline

Adds a haptic effect to this object. This effect will have an influence as long as it is not removed or the haptic properties are programmatically forced to have a specified value.

When called, this methods replaces the latest effect applied with the new one

Parameters

effect

The haptic effect to add to this object

RemoveEffect()

void WeArt.Components.WeArtHapticObject.RemoveEffect ( IWeArtEffect  effect )

inline

Removes a haptic effect from the set of influencing effects.

When called, this methods removes the (only) active effect, leaving the haptic object without applied effects

Parameters

effect

The haptic effect to remove

Property Documentation

ActiveEffect

IWeArtEffect WeArt.Components.WeArtHapticObject.ActiveEffect

get

The currently active effects on this object.

ActuationPoints

ActuationPointFlags WeArt.Components.WeArtHapticObject.ActuationPoints

getset

The thimbles to control with this component.

Force

Force WeArt.Components.WeArtHapticObject.Force

getset

The current pressing force of the specified thimbles.

HandSides

HandSideFlags WeArt.Components.WeArtHapticObject.HandSides

getset

The hand sides to control with this component.

Temperature

Temperature WeArt.Components.WeArtHapticObject.Temperature

getset

The current temperature of the specified thimbles.

Texture

Texture WeArt.Components.WeArtHapticObject.Texture

getset

The current texture feeling applied on the specified thimbles.

Event Documentation

OnActiveEffectsUpdate

Action WeArt.Components.WeArtHapticObject.OnActiveEffectsUpdate

Called when the resultant haptic effect changes because of the influence caused by the currently active effects.

---

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

• WeArtHapticObject.cs