Class HueSaturationValue

The Hue, Saturation, and Value (HSV) model

Inheritance
object
BaseColorModel
HueSaturationValue
Namespace: Terminaux.Colors.Models
Assembly: Terminaux.dll
Syntax
public class HueSaturationValue : BaseColorModel

Properties

| Edit this page View Source

Hue

The position on the color wheel, known as the Hue [0.0 -> 1.0, 0.5 being 180 degrees]

Declaration
public double Hue { get; }
Property Value
Type Description
double
| Edit this page View Source

HueWhole

The position on the color wheel, known as the Hue [0 -> 360]

Declaration
public int HueWhole { get; }
Property Value
Type Description
int
| Edit this page View Source

ReverseHue

The reverse hue position on the color wheel, known as the Reverse Hue [0.0 -> 1.0, 0.5 being 180 degrees]

Declaration
public double ReverseHue { get; }
Property Value
Type Description
double
| Edit this page View Source

ReverseHueWhole

The reverse hue position on the color wheel, known as the Reverse Hue [0 -> 360]

Declaration
public double ReverseHueWhole { get; }
Property Value
Type Description
double
| Edit this page View Source

Saturation

The saturation of the color, indicating how intense the color is [0.0 -> 1.0]

Declaration
public double Saturation { get; }
Property Value
Type Description
double
| Edit this page View Source

SaturationWhole

The saturation of the color, indicating how intense the color is [0 -> 100]

Declaration
public int SaturationWhole { get; }
Property Value
Type Description
int
| Edit this page View Source

Value

The value of the color [0.0 -> 1.0]

Declaration
public double Value { get; }
Property Value
Type Description
double
| Edit this page View Source

ValueWhole

The value of the color [0 -> 100]

Declaration
public int ValueWhole { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
| Edit this page View Source

Equals(HueSaturationValue)

Declaration
public bool Equals(HueSaturationValue other)
Parameters
Type Name Description
HueSaturationValue other
Returns
Type Description
bool
| Edit this page View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
| Edit this page View Source

IsSpecifierAndValueValid(string)

Does the string specifier represent a valid HSV specifier?

Declaration
public static bool IsSpecifierAndValueValid(string specifier)
Parameters
Type Name Description
string specifier

Specifier that represents a valid HSV specifier
Returns
Type Description
bool

True if the specifier is valid; false otherwise.
| Edit this page View Source

IsSpecifierValid(string, bool)

Does the string specifier represent a valid HSV specifier?

Declaration
public static bool IsSpecifierValid(string specifier, bool checkParts = false)
Parameters
Type Name Description
string specifier

Specifier that represents a valid HSV specifier
bool checkParts

Whether to check the parts count or not
Returns
Type Description
bool

True if the specifier is valid; false otherwise.
| Edit this page View Source

ParseSpecifier(string)

Parses the specifier and returns an instance of HueSaturationValue

Declaration
public static HueSaturationValue ParseSpecifier(string specifier)
Parameters
Type Name Description
string specifier

Specifier of HSV
Returns
Type Description
HueSaturationValue

An instance of HueSaturationValue
Exceptions
Type Condition
TerminauxException
| Edit this page View Source

ParseSpecifierToRgb(string, ColorSettings?)

Parses the specifier and returns an instance of HueSaturationValue converted to RedGreenBlue

Declaration
public static RedGreenBlue ParseSpecifierToRgb(string specifier, ColorSettings? settings = null)
Parameters
Type Name Description
string specifier

Specifier of HSV
ColorSettings settings

Settings to use. Use null for global settings
Returns
Type Description
RedGreenBlue

An instance of RedGreenBlue
Exceptions
Type Condition
TerminauxException
| Edit this page View Source

ToString()

hsv:<H>;<S>;<V>

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

| Edit this page View Source

operator ==(HueSaturationValue, HueSaturationValue)

Declaration
public static bool operator ==(HueSaturationValue left, HueSaturationValue right)
Parameters
Type Name Description
HueSaturationValue left
HueSaturationValue right
Returns
Type Description
bool
| Edit this page View Source

operator !=(HueSaturationValue, HueSaturationValue)

Declaration
public static bool operator !=(HueSaturationValue left, HueSaturationValue right)
Parameters
Type Name Description
HueSaturationValue left
HueSaturationValue right
Returns
Type Description
bool