Low-Level C++ SDK  v1.3.0
Loading...
Searching...
No Matches
WeArtHapticObject Class Reference

A haptic object class, representing one or multiple thimbles and hand with which the user interacts. More...

#include <WeArtHapticObject.h>

Public Member Functions

 WeArtHapticObject (WeArtClient *client)
 
void AddEffect (WeArtEffect *effect)
 
void RemoveEffect (WeArtEffect *effect)
 
bool ContainsEffect (WeArtEffect *effect)
 
void UpdateEffects (void)
 
void SendMessage (WeArtMessage *msg)
 

Public Attributes

int32 handSideFlag
 
int32 actuationPointFlag
 
WeArtTemperature weArtTemperature
 
WeArtForce weArtForce
 
WeArtTexture weArtTexture
 
std::vector< WeArtEffect * > activeEffects
 

Detailed Description

A haptic object class, representing one or multiple thimbles and hand with which the user interacts.

The interaction is represented by the use of effects (WeArtEffect).

The communication with the lower layers is triggered by adding and removing effects (see WeArtHapticObject::AddEffect() and WeArtHapticObject::RemoveEffect()), which subsequently triggers an WeArtHapticObject::UpdateEffects() event.

Such event then sends foward messages representing the processed events.

Constructor & Destructor Documentation

◆ WeArtHapticObject()

WeArtHapticObject::WeArtHapticObject ( WeArtClient client)

WEART - HapticObject component https://www.weart.it/

Member Function Documentation

◆ AddEffect()

void WeArtHapticObject::AddEffect ( WeArtEffect effect)

◆ ContainsEffect()

bool WeArtHapticObject::ContainsEffect ( WeArtEffect effect)

◆ RemoveEffect()

void WeArtHapticObject::RemoveEffect ( WeArtEffect effect)

◆ SendMessage()

void WeArtHapticObject::SendMessage ( WeArtMessage *  msg)

◆ UpdateEffects()

void WeArtHapticObject::UpdateEffects ( void  )

Member Data Documentation

◆ activeEffects

std::vector<WeArtEffect*> WeArtHapticObject::activeEffects

◆ actuationPointFlag

int32 WeArtHapticObject::actuationPointFlag

◆ handSideFlag

int32 WeArtHapticObject::handSideFlag

◆ weArtForce

WeArtForce WeArtHapticObject::weArtForce

◆ weArtTemperature

WeArtTemperature WeArtHapticObject::weArtTemperature

◆ weArtTexture

WeArtTexture WeArtHapticObject::weArtTexture

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