Harmony
Scripting Interface Documentation
fileMapper Class Reference

The fileMapper JavaScript global object. 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...
 
String fileURLToPath (String &url)
 

Detailed Description

The fileMapper JavaScript global object. Map paths from one format to another.

Member Function Documentation

◆ fileURLToPath

String fileMapper::fileURLToPath ( String &  url)
slot

◆ 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 '\'.

By example, /usadata000 is mapped to a network drive through a shortcut pointing to /server/path/usadata000.

var remapped = fileMapper.toNativePath("/usadata000/file.txt");

The path will be remapped to \\server\path\usadata000\file.txt.

Parameters
path: The Path on Windows
Returns
The native path.

◆ 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: The 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.