Vicon Shogun banner

Description

Gets the current scene name.

The scene name appears in the title bar of Shogun Post and it determines the default filename if the scene is saved. For a blank scene, the value of the scene name is an empty string. If a file is imported into the scene, the scene name is usually derived from that file name, excluding the file extension. Retrieving the scene name can be useful in custom scripts for saving scene files or exporting files.

Tip
To get the full path of the currently loaded file, use getSavePath to get the location that the file was opened from, followed by getSceneName to get the name.

Functional area

System

Command syntax

Syntax

getSceneName

Arguments

None

Flags

None

Return value

String

Examples

//script to automatically set the scene name with an appendage
//for saving to a file
//get the current scene name
string $SceneName = `getSceneName`;

//create a string to append to the name
string $Append = "_copy";

//amend the scene name variable
$SceneName = $SceneName + $Append;

//check the scene name in the log
print $SceneName;

//set the scene name
setSceneName $SceneName;

//open the file save dialog with the new scene name for the file
saveFile;

Additional information

Related commands