disguise developers

Designer Plugins

Plugins for Disguise Designer software.

ScreenPositionAxis

Base class: Resource

Properties

acceleration : float

delta : float

destValid : bool (Read-Only)

devicePredictionEnabled : bool (Read-Only)

filterOverrideEnabled : int

When switched on, filter parameters override the parent device’s parameters.

Options: {0: ‘Off’, 1: ‘On’}
Category: Output
UserName: Filter Override Enabled

frequency : float

frequencyMax : float

frequencyMin : float

graph : int

Create a monitor in the monitoring manager for incoming packet and filter data

Options: {0: ‘No’, 1: ‘Yes’}
Category: Output
UserName: Graph Data

id : str

Set this to match an ID provided by an active Screen Position Driver

Category: Configuration
UserName: ID

input : float

max_input : float

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

Category: Range
UserName: Maximum input

max_output : float

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

Category: Range
UserName: Maximum output

min_input : float

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

Category: Range
UserName: Minimum input

min_output : float

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

Category: Range
UserName: Minimum output

movementThreshold : float

Minimum change needed before updating output value. Helps when data has unwanted movement when intended to be static. 0 means no threshold (disabled)

Category: Output
UserName: Movement threshold

object : Object

Set this to the object that will receive the value (position or angle)

Category: Configuration
UserName: Object

offset : float

Offset the final output value.

Category: Range
UserName: Offset

output : float

The output value (specified units).

Category: Output
UserName: Output value

outputRaw : float

outputScaled : float

positionSamples : int

Number of position samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

Category: Output
UserName: Number of Position Samples

prediction : float

Compensate for time latency between received data and projector output. Use 0 to disable.

Category: Output
UserName: Bias/ Prediction (ms)

predictionEnabled : int

When switched on, prediction uses the ‘bias’ property to predict tracked positions at a future time

Options: {0: ‘Off’, 1: ‘On’}
Category: Output
UserName: Prediction Override Enabled

property_ : str

Category: Configuration
UserName: Property

smoothingFactor : float

Smoothing Factor (%). Higher values will smooth the data more but will increase latency and therefore the need for prediction. Conversely, for lower values.

Category: Output
UserName: Smoothing Factor

status : int

Options: {0: ‘Disengaged’, 1: ‘Engaged’}
Category: Output
UserName: Status

timeSamples : int

Number of time samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

Category: Output
UserName: Number of Time Samples

velocity : float

velocityCalcMode : int

If set to Calculate the system will attempt to calculate velocity data otherwise this will use velocity values from incoming packets.

Options: {0: ‘Calculate’, 1: ‘From Packet’, 2: ‘Disabled’}
Category: Velocity
UserName: Velocity Mode

wrapInput : int

Input values wrap, jumping from Minimum input to Maximum input or vice versa

Options: {0: ‘No’, 1: ‘Yes’}
Category: Range
UserName: Wrap input

Variables

axisDirectionToString : Callable