Studio
Python API functions
Read time 1 minuteLast updated a month ago
askString
Invite the user to enter a string.
studio.askString(msg, defaultValue="") -> core.String
Parameters
Returns
Type | Name | Description |
|---|---|---|
| String | text | The string entered by the user. |
askYesNo
Ask a question which need a Yes/No answer.
studio.askYesNo(question, defaultValue=False) -> core.Boolean
Parameters
Type | Name | Description |
|---|---|---|
| String | question | Question to display. |
| Boolean | defaultValue | Default value (if interfactive mode is disabled). |
Returns
Type | Name | Description |
|---|---|---|
| Boolean | answer | True if the user say Yes, else False. |
choose
Invite the user to choose one value between multiple choice.
studio.choose(message, values, defaultValue=0) -> core.Int
Parameters
Type | Name | Description |
|---|---|---|
| String | message | Message to display. |
| StringList | values | Possible values to choose. |
| Int | defaultValue | Default value index. |
Returns
Type | Name | Description |
|---|---|---|
| Int | choice | Index of the chosen value in the values list. |
findSelectionInTree
Expand tree to the selected occurrence.
studio.findSelectionInTree()
getVersion
Print the current pixyz Studio version.
studio.getVersion() -> core.String
Returns
Type | Name | Description |
|---|---|---|
| String | version |
setViewerProperty
Set a viewer property for the Pixyz Studio main viewer (you can list the available properties with pxz.view.listViewerProperties()).
studio.setViewerProperty(propertyName, propertyValue)
Parameters
showMessage
Create a message box displaying the given text.
studio.showMessage(Text)
Parameters
Type | Name | Description |
|---|---|---|
| String | Text | Text to display. |