Class: SDL2::Haptic::Condition

Inherits:
Struct
  • Object
show all
Defined in:
lib/sdl2/haptic.rb

Overview

brief A structure containing a template for a Condition effect.

The struct handles the following effects:
 - SDL2::Haptic::SPRING: Effect based on axes position.
 - SDL2::Haptic::DAMPER: Effect based on axes velocity.
 - SDL2::Haptic::INERTIA: Effect based on axes acceleration.
 - SDL2::Haptic::FRICTION: Effect based on axes movement.

Direction is handled by condition internals instead of a direction member.
The condition effect specific members have three parameters.  The first
refers to the X axis, the second refers to the Y axis and the third
refers to the Z axis.  The right terms refer to the positive side of the
axis and the left terms refer to the negative side of the axis.  Please
refer to the ::SDL2::Haptic::Direction diagram for which side is positive and
which is negative.

\sa SDL2::Haptic::Direction
\sa SDL_HAPTIC_SPRING
\sa SDL_HAPTIC_DAMPER
\sa SDL_HAPTIC_INERTIA
\sa SDL_HAPTIC_FRICTION
\sa SDL_HapticEffect

Method Summary

Methods inherited from Struct

#==, cast, #initialize, release

Methods included from StructHelper

#member_readers, #member_writers

Constructor Details

This class inherits a constructor from SDL2::Struct