LightEffectsTrait.SpectrumHsv

class LightEffectsTrait.SpectrumHsv : ClusterStruct


Represents a color using the HSV model.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

SpectrumHsv(saturation: Double, hue: Double, value: Double)

Creates the SpectrumHSV class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

Double

The specific tone of color, measured in a circle from 0 to 360 degrees.

Double

The amount of black, measured from 0 to 100 percent.

Double

The brightness of a color, measured from 0 to 100 percent, with 0 considered to be black.

Public constructors

SpectrumHsv

SpectrumHsv(saturation: Double = 0.0, hue: Double = 0.0, value: Double = 0.0)

Creates the SpectrumHSV class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

hue

val hueDouble

The specific tone of color, measured in a circle from 0 to 360 degrees.

saturation

val saturationDouble

The amount of black, measured from 0 to 100 percent.

value

val valueDouble

The brightness of a color, measured from 0 to 100 percent, with 0 considered to be black.