com.mixer.interactive.resources.control

Class JoystickControl

java.lang.Object

com.mixer.interactive.resources.InteractiveResource<T>

com.mixer.interactive.resources.control.InteractiveControl<JoystickControl>

com.mixer.interactive.resources.control.JoystickControl

All Implemented Interfaces:

IInteractiveCreatable, IInteractiveDeletable, IInteractiveUpdatable, Comparable<InteractiveControl>

public class JoystickControl
extends InteractiveControl<JoystickControl>

A InteractiveControl represents a joystick control on the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

Field Summary

Fields inherited from class com.mixer.interactive.resources.InteractiveResource

meta

Constructor Summary

Constructors

Constructor and Description
JoystickControl(String controlID) Initializes a new JoystickControl.
JoystickControl(String controlID, String sceneID, InteractiveControlPosition... position) Initializes a new JoystickControl.

Method Summary

Modifier and Type	Method and Description
Number	getAngle() Returns the location of the "halo" effect on screen.
Number	getIntensity() Returns the opacity of the "halo" effect.
Integer	getSampleRate() Returns the sample rate for this JoystickControl.
protected JoystickControl	getThis() Returns this as an instance of the specified generic.
JoystickControl	setAngle(Number angle) Sets the location of the "halo" effect on screen.
JoystickControl	setIntensity(Number intensity) Sets the opacity of the "halo" effect.
JoystickControl	setSampleRate(Integer sampleRate) Sets the sample rate for this JoystickControl.
boolean	syncIfEqual(Collection<?> objects) Iterates through a Collection of Objects.

Methods inherited from class com.mixer.interactive.resources.control.InteractiveControl

addPosition, compareTo, create, delete, equals, getControlID, getKind, getPositionFor, getPositionFor, getPositions, getSceneID, hashCode, hasPositionFor, hasPositionFor, isDisabled, removeAllPositions, removePosition, removePosition, setDisabled, setPositions, setPositions, update

Methods inherited from class com.mixer.interactive.resources.InteractiveResource

addMetaProperty, getMeta, setMeta

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JoystickControl

public JoystickControl(String controlID)

Initializes a new JoystickControl.

Parameters:

controlID - Unique identifier for the JoystickControl

Since:

1.0.0

JoystickControl

public JoystickControl(String controlID,
                       String sceneID,
                       InteractiveControlPosition... position)

Initializes a new JoystickControl.

Parameters:

controlID - Unique identifier for the JoystickControl

sceneID - Unique identifier for the InteractiveScene that contains this control

position - An array of initial InteractiveControlPosition for this control

Since:

1.0.0

Method Detail

getSampleRate

public Integer getSampleRate()

Returns the sample rate for this JoystickControl.

Returns:

The sample rate for this JoystickControl

Since:

1.0.0

setSampleRate

public JoystickControl setSampleRate(Integer sampleRate)

Sets the sample rate for this JoystickControl.

Parameters:

sampleRate - The sample rate for this JoystickControl

Returns:

this for method chaining

Since:

1.0.0

getAngle

public Number getAngle()

Returns the location of the "halo" effect on screen.

Returns:

The location of the "halo" effect on screen

Since:

1.0.0

setAngle

public JoystickControl setAngle(Number angle)

Sets the location of the "halo" effect on screen. Should be given in the range [0, 2).

Parameters:

angle - The location of the "halo" effect on screen

Returns:

this for method chaining

Since:

1.0.0

getIntensity

public Number getIntensity()

Returns the opacity of the "halo" effect.

Returns:

The opacity of the "halo" effect

Since:

1.0.0

setIntensity

public JoystickControl setIntensity(Number intensity)

Sets the opacity of the "halo" effect.

Parameters:

intensity - The opacity of the "halo" effect

Returns:

this for method chaining

Since:

1.0.0

getThis

protected JoystickControl getThis()

Returns this as an instance of the specified generic. Utilizes the getThis programming idiom.

Specified by:

getThis in class InteractiveResource<JoystickControl>

Returns:

this as an object of type T

Since:

1.0.0

See Also:

InteractiveResource.getThis()

syncIfEqual

public boolean syncIfEqual(Collection<?> objects)

Iterates through a Collection of Objects. If this is found to be in the Collection then this has it's values updated.

Specified by:

syncIfEqual in class InteractiveResource<JoystickControl>

Parameters:

objects - A Collection of Objects

Returns:

A CompletableFuture that when complete returns true if the provided Collection contains this

Since:

2.0.0

See Also:

InteractiveResource.syncIfEqual(Collection)