disguise developers

Designer Plugins

Plugins for Disguise Designer software.

WebModule

A Module allowing the user to render webpages with Chromium. Grabs the texture stream from its
underlying WebBrowser object that does the actual interfacing with Chromium.

Also allows for the sending of JavaScript commands and float/string parameters to the web page via its layer.

Base class: Module

Properties

Command : WebCommand

The currently selected command to send to the web browser.

Name_1 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 1

Category: Custom Parameters
UserName: Name 1

Name_2 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 2

Category: Custom Parameters
UserName: Name 2

Name_3 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 3

Category: Custom Parameters
UserName: Name 3

Name_4 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 4

Category: Custom Parameters
UserName: Name 4

Name_5 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 5

Category: Custom Parameters
UserName: Name 5

Name_6 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 6

Category: Custom Parameters
UserName: Name 6

Name_7 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 7

Category: Custom Parameters
UserName: Name 7

Name_8 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.Name 8

Category: Custom Parameters
UserName: Name 8

String_1 : str

A string value passed into the function String Name 1 each frame

Category: Custom Parameters
UserName: String 1

String_2 : str

A string value passed into the function String Name 2 each frame

Category: Custom Parameters
UserName: String 2

String_3 : str

A string value passed into the function String Name 3 each frame

Category: Custom Parameters
UserName: String 3

String_4 : str

A string value passed into the function String Name 4 each frame

Category: Custom Parameters
UserName: String 4

String_5 : str

A string value passed into the function String Name 5 each frame

Category: Custom Parameters
UserName: String 5

String_6 : str

A string value passed into the function String Name 6 each frame

Category: Custom Parameters
UserName: String 6

String_7 : str

A string value passed into the function String Name 7 each frame

Category: Custom Parameters
UserName: String 7

String_8 : str

A string value passed into the function String Name 8 each frame

Category: Custom Parameters
UserName: String 8

String_Name_1 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 1

Category: Custom Parameters
UserName: String Name 1

String_Name_2 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 2

Category: Custom Parameters
UserName: String Name 2

String_Name_3 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 3

Category: Custom Parameters
UserName: String Name 3

String_Name_4 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 4

Category: Custom Parameters
UserName: String Name 4

String_Name_5 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 5

Category: Custom Parameters
UserName: String Name 5

String_Name_6 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 6

Category: Custom Parameters
UserName: String Name 6

String_Name_7 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 7

Category: Custom Parameters
UserName: String Name 7

String_Name_8 : str

The name of a JavaScript function to call in the browser every frame.
The function name in JavaScript will be d3.String Name 8

Category: Custom Parameters
UserName: String Name 8

Universes : str

A comma separated list of DMX universes. Universes specified here will pass DMX data through to the browser.

Category: DMX Parameters
UserName: Universes (1-based)

Value_1 : float

A float value passed into the function Name 1 each frame

Category: Custom Parameters
UserName: Value 1

Value_2 : float

A float value passed into the function Name 2 each frame

Category: Custom Parameters
UserName: Value 2

Value_3 : float

A float value passed into the function Name 3 each frame

Category: Custom Parameters
UserName: Value 3

Value_4 : float

A float value passed into the function Name 4 each frame

Category: Custom Parameters
UserName: Value 4

Value_5 : float

A float value passed into the function Name 5 each frame

Category: Custom Parameters
UserName: Value 5

Value_6 : float

A float value passed into the function Name 6 each frame

Category: Custom Parameters
UserName: Value 6

Value_7 : float

A float value passed into the function Name 7 each frame

Category: Custom Parameters
UserName: Value 7

Value_8 : float

A float value passed into the function Name 8 each frame

Category: Custom Parameters
UserName: Value 8

bookmark : WebBookmark

The currently loaded web bookmark.

UserName: Bookmark

fade_up_time : float

The time it takes for the web module to fade up from a completely transparent state.

UserName: Fade up time

framerateFraction : int

The fraction of the framerate the web browser renders at. Can help performance with particularly large resolutions.
Does not help when in low latency output modes.

Options: {0: ‘1’, 1: ‘1/2’, 2: ‘1/3’, 3: ‘1/4’}
UserName: Framerate fraction

height : int

The height of the web view in pixels.

Category: Size
UserName: Height

size_mode : int

The sizing mode of the web view.

Options: {0: ‘Match Mapping’, 1: ‘Custom’}
Category: Size
UserName: Size mode

width : int

The width of the web view in pixels.

Category: Size
UserName: Width

Methods

clearCache(self)

Clears the cache of the WebModule.

greySizeFields(self) -> bool

Returns whether the browser size fields should be greyed out (size mode is set to canvas).

Returns True if the browser size mode is set to canvas, False otherwise.

reset(self)

Resets the WebModule to its initial state.

webBrowser(self) -> WebBrowser

Returns the underlying WebBrowser instance.

Returns A shared pointer to the WebBrowser object.