Storyboard Pro
Scripting Interface Documentation
fileMapper Class Reference

Map paths from one format to another. More...

Public Slots

String toNativePath (String &path)
 returns the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to '\'. More...
 
String toScenePath (String &path)
 converts a path of the form /USA_DB/jobs/<job>/scene-<scene>/<remainder...> to eg. /usadata000/<job>/scene-<scene>/<remainder...> More...
 

Detailed Description

Map paths from one format to another.

You can use it in Script Editor only.

Member Function Documentation

◆ toNativePath

String fileMapper::toNativePath ( String &  path)
slot

returns the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to '\'.

Parameters
path: path on Windows
Your /usadata000 is mapped to a network drive through a shortcut
pointing to /server/path/usadata000
var remapped = fileMapper.toNativePath("/usadata000/file.txt");
remapped will be
\\server\path\usadata000\file.txt

◆ toScenePath

String fileMapper::toScenePath ( String &  path)
slot

converts a path of the form /USA_DB/jobs/<job>/scene-<scene>/<remainder...> to eg. /usadata000/<job>/scene-<scene>/<remainder...>

Parameters
path: path to convert

If working offline (no database) this function will return the input path.
In database mode if the path is not of the form /USA_DB/jobs/<job>/scene-<scene>/<remainder...> this function will return the input path.
In database mode if the scene cannot be located in the database this function will return the input path.