PrjMgtManager Class Reference

This interface is used to merge/extract another storyboard into the main storyboard. More...

#include <prjMgtManager.h>

Inheritance diagram for PrjMgtManager:

Collaboration diagram for PrjMgtManager:

Public Slots
Insert Options
void	setMergeSoundClips (bool flag)
	Set the flag to merge sound clips from the source project.
void	setRespectLockedSoundTracks (bool flag)
	Set the flag to respect locked sound tracks.
void	setKeepOriginalScenes (bool flag)
	Set the flag to keep the original scenes ( when overwriting ) and move them to the end of the project.
Source Project Introspection ( used for scene insertion )
bool	loadSourceProject (String &scenePath)
	Loads the specified storyboard project to be used as a source for insertion.
StringList	sourceProjectSceneIds ()
	Returns a list of sceneIds from the loaded storyboard project.
StringList	sourceProjectPanelIds (String &sceneId)
	Returns a list of panelIds from the specified scene of the loaded storyboard project.
StringList	sourceProjectCaptionNames ()
	Returns a list of captions from the loaded storyboard project.
void	setCaptionRemapByName (bool flag)
	Map source Captions by caption name, on insert. True by default.
String	sourceProjectSceneName (String &sceneId)
	Returns the scene Name for a given source project scene Id.
String	sourceProjectSequenceName (String &sceneId)
	Returns the sequence Name for a given source project scene Id.
Project Management Methods
String	insertScene (String &srcSceneId, String &dstSceneId, bool overwrite, bool before)
	Inserts the specified source scene Id into the project.
String	insertPanel (String &srcSceneId, String &dstSceneId, bool overwrite, bool before)
	Inserts the specified source panel Id into the project.
bool	extractRange (String &newProjectPath, String &newProjectName, String &fromShotId, String &toShotId, bool removeScenes)
	Extracts the specified range of scenes, and creates a new project with them.

Detailed Description

This interface is used to merge/extract another storyboard into the main storyboard.

The following examples are provided:

For scene insertion, the source scene must be loaded using loadSourceProject. Once loaded, the sceneIds of the source may be retrieved. Using this information, the insertScene command can be created.

var pM = new PrjMgtManager();
if (  pM.loadSourceProject("/pathToProject/something.sboard"))
{
  var scenes = pM.sourceProjectSceneIds();
  for ( var i =0; i < scenes.length; ++i )
  {
  System.println( scenes[i] + " : " + pM.sourceProjectSequenceName( scenes[i]) + ":" + pM.sourceProjectSceneName( scenes[i])   );
  }

  var  SM = new StoryboardManager();
  var dstId = SM.sceneInProject( 3 );

  // Insert the first scene from the source after the 3rd scene in the destination.
  var overwrite = false;
  var before = false;
  pM.insertScene( scenes[0], dstId, overwrite, before );

}

Member Function Documentation

bool PrjMgtManager::extractRange ( String &  newProjectPath, String &  newProjectName, String &  fromShotId, String &  toShotId, bool  removeScenes  )

slot

Extracts the specified range of scenes, and creates a new project with them.

Note, projects with modifications MUST be saved prior to the use of this function. ( use scene.saveAll() )

Parameters

newProjectPath	- path to the directory where the new project is to be saved.
newProjectName	- name of the new project
fromShotId	- used to determine the start of the extraction range ( first frame of the shot is used )
toShotId	- used to determine the end of the extraction range ( last frame of the shot is used )
removeScenes	- whether the extracted range is to be removed from the original project

String PrjMgtManager::insertPanel ( String &  srcSceneId, String &  dstSceneId, bool  overwrite, bool  before  )

slot

Inserts the specified source panel Id into the project.

Note: Adjacent transitions on the target panel will be deleted.

Parameters

srcSceneId	- uniqueId of the source panel
dstSceneId	- uniqueId of the destination panel
overwrite	- if true, overwrites the destination panel, if false, inserts next to it
before	- - used when inserting to specify before the target or after

String PrjMgtManager::insertScene ( String &  srcSceneId, String &  dstSceneId, bool  overwrite, bool  before  )

slot

Inserts the specified source scene Id into the project.

Note: Adjacent transitions on the target scene will be deleted.

Parameters

srcSceneId	- uniqueId of the source shot
dstSceneId	- uniqueId of the destination shot
overwrite	- if true, overwrites the destination shot, if false, inserts next to it
before	- - used when inserting to specify before the target or after

bool PrjMgtManager::loadSourceProject ( String &  scenePath )

slot

Loads the specified storyboard project to be used as a source for insertion.

Parameters

scenePath

- path to project

void PrjMgtManager::setCaptionRemapByName ( bool  flag )

slot

Map source Captions by caption name, on insert. True by default.

Parameters

flag

- boolean

void PrjMgtManager::setKeepOriginalScenes ( bool  flag )

slot

Set the flag to keep the original scenes ( when overwriting ) and move them to the end of the project.

Parameters

flag

- boolean

void PrjMgtManager::setMergeSoundClips ( bool  flag )

slot

Set the flag to merge sound clips from the source project.

Parameters

flag

- boolean

void PrjMgtManager::setRespectLockedSoundTracks ( bool  flag )

slot

Set the flag to respect locked sound tracks.

Parameters

flag

- boolean

StringList PrjMgtManager::sourceProjectCaptionNames ( )

slot

Returns a list of captions from the loaded storyboard project.

StringList PrjMgtManager::sourceProjectPanelIds ( String &  sceneId )

slot

Returns a list of panelIds from the specified scene of the loaded storyboard project.

Parameters

sceneId

- unique ID of the scene

StringList PrjMgtManager::sourceProjectSceneIds ( )

slot

Returns a list of sceneIds from the loaded storyboard project.

String PrjMgtManager::sourceProjectSceneName ( String &  sceneId )

slot

Returns the scene Name for a given source project scene Id.

Parameters

sceneId

String PrjMgtManager::sourceProjectSequenceName ( String &  sceneId )

slot

Returns the sequence Name for a given source project scene Id.

Parameters

sceneId

---

The documentation for this class was generated from the following file:

• dox_files/prjMgtManager.h