Class Studio

Inheritance

Studio

Namespace:

Syntax

Methods

askString

Invite the user to enter a string

Declaration

studio.askString(msg, defaultValue) -> core.String

Parameters

Type	Name	Description
String	msg	Message to display
String	defaultValue	Message to display

Returns

Type	Description
String	The string entered by the user

askYesNo

Ask a question which need a Yes/No answer

Declaration

studio.askYesNo(question, defaultValue) -> core.Boolean

Parameters

Type	Name	Description
String	question	Question to display
Boolean	defaultValue	Default value (if interfactive mode is disabled)

Returns

Type	Description
Boolean	True if the user say Yes, else False

choose

Invite the user to choose one value between multiple choice

Declaration

studio.choose(message, values, defaultValue) -> core.Int

Parameters

Type	Name	Description
String	message	Message to display
StringList	values	Possible values to choose
Int	defaultValue	Default value index

Returns

Type	Description
Int	Index of the chosen value in the values list

findSelectionInTree

Expand tree to the selected occurrence

Declaration

studio.findSelectionInTree()

getVersion

Print the current pixyz Studio version.

Declaration

studio.getVersion() -> core.String

Returns

Type	Description
String

installPlugin

Install a Pixyz Plugin

Declaration

studio.installPlugin(pluginFile, installForAllUsers=True)

Parameters

Type	Name	Description
FilePath	pluginFile	Path to the plugin file
Boolean	installForAllUsers	Install plugin for all users.

setViewerProperty

Set a viewer property for the Pixyz Studio main viewer (you can list the available properties with pxz.view.listViewerProperties())

Declaration

studio.setViewerProperty(propertyName, propertyValue)

Parameters

Type	Name	Description
String	propertyName
String	propertyValue

showMessage

Create a message box displaying the given text.

Declaration

studio.showMessage(Text)

Parameters

Type	Name	Description
String	Text	Text to display