ColorControlTrait.MoveColorCommand.Request

class ColorControlTrait.MoveColorCommand.Request

The request payload for the MoveColor command.

Summary

Public constructors
Request(
    rateX: Short,
    rateY: Short,
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the MoveColor command.

Public properties
ColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.
ColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.
Short

The rate of movement in steps per second.
Short

The rate of movement in steps per second.

Public constructors

Request

Request(
    rateX: Short = 0,
    rateY: Short = 0,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the MoveColor command.

Public properties

optionsMask

val optionsMask: ColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.

optionsOverride

val optionsOverride: ColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

rateX

val rateX: Short

The rate of movement in steps per second. A step is a change of one unit to the currentX attribute.

rateY

val rateY: Short

The rate of movement in steps per second. A step is a change of one unit to the currentY attribute.