The force applied as haptic pressure on the actuation point. The minimum value indicates no pressure, the maximum indicates maximum pressure. More...

Inheritance diagram for WeArt.Core.Force:

[legend]

Public Member Functions
override bool	Equals (object obj)
	True if the object is a Force instance with the same activation status and values.

override int	GetHashCode ()
	Basic GetHashCode implementation.

object	Clone ()
	Clones this object.

Static Public Member Functions
static Force	Mean (IEnumerable< Force > forces)
	Calculates the mean of multiple forces.

Static Public Attributes
static Force	Default
	The default force is zero.

Properties
float	Value `[get, set]`
	The horizontal component of the 3D force values, normalized between 0 (min force) and 1 (max force)

bool	Active `[get, set]`
	Indicates whether the force feeling is applied or not.

Detailed Description

The force applied as haptic pressure on the actuation point. The minimum value indicates no pressure, the maximum indicates maximum pressure.

Member Function Documentation

◆ Clone()

object WeArt.Core.Force.Clone ( )

inline

Clones this object.

Returns: A clone of this object

◆ Equals()

override bool WeArt.Core.Force.Equals ( object obj )

inline

True if the object is a Force instance with the same activation status and values.

Parameters

obj	The object to check equality with

Returns: The equality check result

◆ GetHashCode()

override int WeArt.Core.Force.GetHashCode ( )

Basic GetHashCode implementation.

Returns: The hashcode of this object

◆ Mean()

static Force WeArt.Core.Force.Mean ( IEnumerable< Force > forces )

inlinestatic

Calculates the mean of multiple forces.

Parameters

forces A collection or set of forces

Returns: The mean force

Member Data Documentation

◆ Default

Force WeArt.Core.Force.Default

static

Initial value:

= new Force
        {
            Value = WeArtConstants.defaultForce,
            Active = false
        }

The default force is zero.

Property Documentation

◆ Active

bool WeArt.Core.Force.Active

getset

Indicates whether the force feeling is applied or not.

◆ Value

float WeArt.Core.Force.Value

getset

The horizontal component of the 3D force values, normalized between 0 (min force) and 1 (max force)

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

WeArtForce.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties