Low-Level C# SDK  v1.2.0
Loading...
Searching...
No Matches
WeArt.Core.Temperature Struct Reference

The temperature applied to the thermal actuator on the actuation point. The minimum value indicates the coldest temperature, the maximum indicates the hottest. More...

Inheritance diagram for WeArt.Core.Temperature:
[legend]

Public Member Functions

override bool Equals (object obj)
 True if the object is a Temperature instance with the same activation status and value.
 
override int GetHashCode ()
 Basic GetHashCode implementation.
 
object Clone ()
 Clones this object.
 

Static Public Member Functions

static Temperature Mean (IEnumerable< Temperature > temperatures)
 Calculates the mean of multiple temperatures.
 

Static Public Attributes

static Temperature Default
 The default temperature is the ambient one, with the actuator off.
 

Properties

float Value [get, set]
 The temperature value, normalized between 0 (cold) and 1 (hot)
 
bool Active [get, set]
 Indicates whether the temperature feeling is applied or not.
 

Detailed Description

The temperature applied to the thermal actuator on the actuation point. The minimum value indicates the coldest temperature, the maximum indicates the hottest.

Member Function Documentation

◆ Clone()

object WeArt.Core.Temperature.Clone ( )

Clones this object.

Returns
A clone of this object

◆ Equals()

override bool WeArt.Core.Temperature.Equals ( object  obj)
inline

True if the object is a Temperature instance with the same activation status and value.

Parameters
objThe object to check equality with
Returns
The equality check result

◆ GetHashCode()

override int WeArt.Core.Temperature.GetHashCode ( )

Basic GetHashCode implementation.

Returns
The hashcode of this object

◆ Mean()

static Temperature WeArt.Core.Temperature.Mean ( IEnumerable< Temperature temperatures)
inlinestatic

Calculates the mean of multiple temperatures.

Parameters
temperaturesA collection or set of temperatures
Returns
The mean temperature

Member Data Documentation

◆ Default

Temperature WeArt.Core.Temperature.Default
static
Initial value:
= new Temperature
{
Value = WeArtConstants.defaultTemperature,
Active = false
}
bool Active
Indicates whether the temperature feeling is applied or not.
Definition: WeArtTemperature.cs:47
float Value
The temperature value, normalized between 0 (cold) and 1 (hot)
Definition: WeArtTemperature.cs:38

The default temperature is the ambient one, with the actuator off.

Property Documentation

◆ Active

bool WeArt.Core.Temperature.Active
getset

Indicates whether the temperature feeling is applied or not.

◆ Value

float WeArt.Core.Temperature.Value
getset

The temperature value, normalized between 0 (cold) and 1 (hot)


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