FormIt.Scenes API

Description

Functions
json	FormIt.Scenes.SceneNameExists (sceneName)
	SceneNameExists returns true if a scene with the given name exists.
json	FormIt.Scenes.IsValidSceneName (oldSceneName, newSceneName)
	IsValidSceneName checks whether the name is valid for a scene.
json	FormIt.Scenes.SetSceneName (oldSceneName, newSceneName)
	SetSceneName renames the given Scene.
json	FormIt.Scenes.AddNewScene (afterSceneName)
	AddNewScene adds a new scene with an automatically generated scene name optionally after a given scene name.
json	FormIt.Scenes.AddNewSceneToAnimation (animationName)
	AddNewSceneToAnimation adds a new scene with an automatically generated scene name to a given animation.
json	FormIt.Scenes.GetScene (sceneName)
	GetScene gets the given Scene as JSON given a Scene name.
json	FormIt.Scenes.GetScenes ()
	GetScenes gets all the Scenes as JSON objects.
json	FormIt.Scenes.GetScenesSortedByAnimations ()
	GetScenes gets all the Scenes as JSON objects sorted by animations matching the scene widget.
json	FormIt.Scenes.SetScenes (scenes)
	SetScenes sets all the Scenes.
json	FormIt.Scenes.AddScene (scene, afterSceneName)
	AddScene adds a new scene given a Scene JSON object.
json	FormIt.Scenes.RemoveScene (sceneName)
	RemoveScene removes the scene with the given name.
json	FormIt.Scenes.DuplicateScene (sceneName)
	DuplicateScene duplicates the scene with the given name.
json	FormIt.Scenes.GetSceneNames ()
	GetSceneNames gets all the Scene names.
json	FormIt.Scenes.ScenesAreEqual (sceneName, scene)
	ScenesAreEqual returns true if Parameters: In: sceneName The name of an existing Scene.
json	FormIt.Scenes.SetPresentationMode (start, sceneName)
	SetPresentationMode starts/stops presentation mode.
json	FormIt.Scenes.IsPresenting ()
	IsPresenting returns true if in presentation mode.
json	FormIt.Scenes.UpdateScene (sceneName)
	UpdateScene captures the Scene's properties that are enabled with the given name.
json	FormIt.Scenes.GetPropertiesToCapture (sceneName)
	GetPropertiesToCapture returns the property flags used for determining what is captured.
json	FormIt.Scenes.SetPropertiesToCapture (sceneName, properties)
	SetPropertiesToCapture sets the Scene property flags used for determining what is captured.
json	FormIt.Scenes.ActivateScene (sceneName)
	ActivateScene activates the Scene with the given name.
json	FormIt.Scenes.MoveSceneUp (sceneName)
	MoveSceneUp moves the given Scene up in the Scene list.
json	FormIt.Scenes.MoveSceneDown (sceneName)
	MoveSceneDown moves the given Scene down in the Scene list.
json	FormIt.Scenes.RearrangeScenes (oldPos, newPos)
	RearrangeScenes moves the given Scene at oldPos to newPos in the Scene list.
json	FormIt.Scenes.GetNumberOfScenes ()
	GetNumberOfScenes returns the number of Scenes.
json	FormIt.Scenes.GetNumberOfScenesWithAnimation (animationName)
json	FormIt.Scenes.GetPauseTime (sceneName)
	GetPauseTime returns the time that the given Scene is paused during presentation mode.
json	FormIt.Scenes.SetPauseTime (sceneName, pauseTime)
	SetPauseTime sets the time that the given Scene is paused during presentation mode.
json	FormIt.Scenes.IsValidScenePauseTime (pauseTimeString)
	IsValidScenePauseTime checks whether string contains a valid pause time.
json	FormIt.Scenes.IsValidSceneTransitionTime (transitionTimeString)
	IsValidSceneTransitionTime checks whether string contains a valid pause time.
json	FormIt.Scenes.IsValidSceneCameraSpeed (speedString)
	IsValidSceneCameraSpeed checks whether string contains a valid pause time.
json	FormIt.Scenes.GetTransitionTime (sceneName)
	GetTransitionTime returns the time that the given Scene takes to transition during presentation mode.
json	FormIt.Scenes.SetTransitionTime (sceneName, transitionTime)
	SetTransitionTime sets the time that the given Scene takes to transition during presentation mode.
json	FormIt.Scenes.GetCameraSpeed (sceneName)
	GetCameraSpeed returns the speed (mph) at which the camera moves during the transition to the next scene.
json	FormIt.Scenes.SetCameraSpeed (sceneName, cameraSpeed)
	SetCameraSpeed sets the speed (mph) at which the camera moves during the transition to the next scene.
json	FormIt.Scenes.GetIncludeInAnimation (sceneName)
	GetIncludeInAnimation returns whether the given scene is part of the animation.
json	FormIt.Scenes.SetIncludeInAnimation (sceneName, bIncludeInAnimation)
	SetIncludeInAnimation sets whether the given scene is part of the animation.
json	FormIt.Scenes.GetUseCameraSpeed (sceneName)
	GetUseCameraSpeed returns whether the given scene is using the transition time or camera speed during animation.
json	FormIt.Scenes.SetUseCameraSpeed (sceneName, bUseCameraSpeed)
	SetUseCameraSpeed sets whether the given scene is part of the animation.
json	FormIt.Scenes.GetTransitionTimeUsed (sceneName)
	GetTransitionTimeUsed returns the transition time for the scene that is actually used.
json	FormIt.Scenes.SetEditCameras (bEditCameras, animationName, sceneName)
	SetEditCameras enters the camera editing mode.
json	FormIt.Scenes.GetEditCameras ()
	GetEditCameras enters the camera editing mode.
json	FormIt.Scenes.AddSceneAnimation ()
	Add a new scene animation.
json	FormIt.Scenes.RemoveAnimation (animationName)
	Removes a scene animation.
json	FormIt.Scenes.GetSceneAnimations ()
	Get all scene animations
json	FormIt.Scenes.GetSceneAnimation (animationName)
	Get the animation for the given name
json	FormIt.Scenes.GetSceneNamesFromAnimation (animationName)
	Get the scene names for the given animation
json	FormIt.Scenes.AddScenesToAnimation (animationName, sceneNames, sceneBeforeOrAfterName, insertAfter)
	Adds existing scenes to an animation.
json	FormIt.Scenes.RearrangeAnimations (animationNames, animationBeforeOrAfterName, insertAfter)
	Rearrange the animations to be put before or after the given other animation.
json	FormIt.Scenes.IsValidAnimationName (oldName, newName)
	IsValidAnimationName checks whether the name is valid for an animation Used to check if the oldName can be renamed to newName.
json	FormIt.Scenes.SetAnimationName (oldName, newName)
	SetSceneName renames the given Scene.
json	FormIt.Scenes.GetAnimationLoop (animationName)
	Get the loop option of an animation
json	FormIt.Scenes.SetAnimationLoop (animationName, loop)
	Set the loop option of an animation
json	FormIt.Scenes.GetAnimationCollapsed (animationName)
	Get the collpased status of an animation UI item
json	FormIt.Scenes.SetAnimationCollapsed (animationName, collapsed)
	Set the collpased status of an animation UI item
json	FormIt.Scenes.StartStopAnimation (start, animationName, fromScene)
	Start/stop a continuous loop scene animation.
json	FormIt.Scenes.GetAnimationForScene (sceneName)
	Returns the parent animation for a scene.

Function Documentation

ActivateScene()

json FormIt.Scenes.ActivateScene

(

sceneName

)

ActivateScene activates the Scene with the given name.

Parameters

[in]

sceneName

String

Returns

Success

AddNewScene()

json FormIt.Scenes.AddNewScene

(

afterSceneName

)

AddNewScene adds a new scene with an automatically generated scene name optionally after a given scene name.

Parameters

[in]

afterSceneName

String (OPTIONAL)

Returns

{ Result, Name } Result key is a bool success flag and Name is the newly generated scene name.

AddNewSceneToAnimation()

json FormIt.Scenes.AddNewSceneToAnimation

(

animationName

)

AddNewSceneToAnimation adds a new scene with an automatically generated scene name to a given animation.

If animation is not given or "", it is added to the default animation

Parameters

[in]

animationName

String (OPTIONAL)

Returns

{ Result, Name } Result key is a bool success flag and Name is the newly generated scene name.

AddScene()

json FormIt.Scenes.AddScene	(	scene	,
		afterSceneName
	)

AddScene adds a new scene given a Scene JSON object.

Parameters

[in]	scene	Scene JSON object (see GetScene)
[in]	afterSceneName	String (OPTIONAL)

Returns

Success

AddSceneAnimation()

json FormIt.Scenes.AddSceneAnimation

(

)

Add a new scene animation.

Returns the new name of the animation

Returns

{ Result, Name } Result key is a bool success flag and Name is the newly generated animation name.

AddScenesToAnimation()

json FormIt.Scenes.AddScenesToAnimation	(	animationName	,
		sceneNames	,
		sceneBeforeOrAfterName	,
		insertAfter
	)

Adds existing scenes to an animation.

Returns true if scenes and animation exist. The scenes are also removed from their previous animation, if they were part of one

Parameters

[in]	animationName	String
[in]	sceneNames	vector of scene names
[in]	sceneBeforeOrAfterName	name of an existing scene in the given animation before or after which to insert the given scenes
[in]	insertAfter	true if inserting after sceneBeforeOrAfterName, false if inserting before

Returns

success

DuplicateScene()

json FormIt.Scenes.DuplicateScene

(

sceneName

)

DuplicateScene duplicates the scene with the given name.

Parameters

[in]

sceneName

String

Returns

{ Result, Name } Result key is a bool success flag and Name is the newly generated scene name.

GetAnimationCollapsed()

json FormIt.Scenes.GetAnimationCollapsed

(

animationName

)

Get the collpased status of an animation UI item

Parameters

[in]

animationName

String

Returns

bool true/false

GetAnimationForScene()

json FormIt.Scenes.GetAnimationForScene

(

sceneName

)

Returns the parent animation for a scene.

Returns "" if not found

Parameters

[in]

sceneName

String

Returns

string animation name

GetAnimationLoop()

json FormIt.Scenes.GetAnimationLoop

(

animationName

)

Get the loop option of an animation

Parameters

[in]

animationName

String

Returns

bool true/false

GetCameraSpeed()

json FormIt.Scenes.GetCameraSpeed

(

sceneName

)

GetCameraSpeed returns the speed (mph) at which the camera moves during the transition to the next scene.

Parameters

[in]

sceneName

String

Returns

Returns the camera speed

GetEditCameras()

json FormIt.Scenes.GetEditCameras

(

)

GetEditCameras enters the camera editing mode.

Returns

Returns true if in camera editing mode

GetIncludeInAnimation()

json FormIt.Scenes.GetIncludeInAnimation

(

sceneName

)

GetIncludeInAnimation returns whether the given scene is part of the animation.

Parameters

[in]

sceneName

String

Returns

bool Included in animation

GetNumberOfScenes()

json FormIt.Scenes.GetNumberOfScenes

(

)

GetNumberOfScenes returns the number of Scenes.

Returns

The number of Scenes

GetNumberOfScenesWithAnimation()

json FormIt.Scenes.GetNumberOfScenesWithAnimation

(

animationName

)

GetPauseTime()

json FormIt.Scenes.GetPauseTime

(

sceneName

)

GetPauseTime returns the time that the given Scene is paused during presentation mode.

Parameters

[in]

sceneName

String

Returns

pause time

GetPropertiesToCapture()

json FormIt.Scenes.GetPropertiesToCapture

(

sceneName

)

GetPropertiesToCapture returns the property flags used for determining what is captured.

Parameters

[in]

sceneName

String

Returns

{ Result: bool, Properties: Properties Object } Result- Success Properties- List of properties with true/false flags.

GetScene()

json FormIt.Scenes.GetScene

(

sceneName

)

GetScene gets the given Scene as JSON given a Scene name.

Parameters

[in]

sceneName

String

Returns

{ Result, Scene } Result key is a bool success flag and Scene is the Scene JSON object.

GetSceneAnimation()

json FormIt.Scenes.GetSceneAnimation

(

animationName

)

Get the animation for the given name

Parameters

[in]

animationName

String

Returns

{ Result, Animation } Result key is a bool success flag and Animation is the Animation JSON object.

GetSceneAnimations()

json FormIt.Scenes.GetSceneAnimations

(

)

Get all scene animations

Returns

Array of SceneAnimation JSON objects

GetSceneNames()

json FormIt.Scenes.GetSceneNames

(

)

GetSceneNames gets all the Scene names.

Returns

Array of Scene names

GetSceneNamesFromAnimation()

json FormIt.Scenes.GetSceneNamesFromAnimation

(

animationName

)

Get the scene names for the given animation

Parameters

[in]

animationName

String

Returns

vector of scene names

GetScenes()

json FormIt.Scenes.GetScenes

(

)

GetScenes gets all the Scenes as JSON objects.

Returns

Array of Scene JSON objects

GetScenesSortedByAnimations()

json FormIt.Scenes.GetScenesSortedByAnimations

(

)

GetScenes gets all the Scenes as JSON objects sorted by animations matching the scene widget.

Returns

Array of Scene JSON objects

GetTransitionTime()

json FormIt.Scenes.GetTransitionTime

(

sceneName

)

GetTransitionTime returns the time that the given Scene takes to transition during presentation mode.

Parameters

[in]

sceneName

String

Returns

Transition time

GetTransitionTimeUsed()

json FormIt.Scenes.GetTransitionTimeUsed

(

sceneName

)

GetTransitionTimeUsed returns the transition time for the scene that is actually used.

If the scene uses the "Use Camera Speed" option, the time is computed from the distance and the mph parameter. Otherwise the basic transition time is returned.

Parameters

[in]

sceneName

String

Returns

Transition time used

GetUseCameraSpeed()

json FormIt.Scenes.GetUseCameraSpeed

(

sceneName

)

GetUseCameraSpeed returns whether the given scene is using the transition time or camera speed during animation.

Parameters

[in]

sceneName

String

Returns

bool Use camera speed

IsPresenting()

json FormIt.Scenes.IsPresenting

(

)

IsPresenting returns true if in presentation mode.

Returns

Returns true if presenting.

IsValidAnimationName()

json FormIt.Scenes.IsValidAnimationName	(	oldName	,
		newName
	)

IsValidAnimationName checks whether the name is valid for an animation Used to check if the oldName can be renamed to newName.

Parameters

[in]	oldName	String
[in]	newName	String

Returns

{ Result, Error } Result is true if it's a valid animation name and false if not valid along with an Error message.

IsValidSceneCameraSpeed()

json FormIt.Scenes.IsValidSceneCameraSpeed

(

speedString

)

IsValidSceneCameraSpeed checks whether string contains a valid pause time.

Parameters

[in]	transitionTimeString	Speed Time String
[in]	speedString	String

Returns

{ Result (bool), Value (double), Error (I18nString) }

IsValidSceneName()

json FormIt.Scenes.IsValidSceneName	(	oldSceneName	,
		newSceneName
	)

IsValidSceneName checks whether the name is valid for a scene.

Used to check if the oldSceneName can be renamed to newSceneName.

Parameters

[in]	oldSceneName	String
[in]	newSceneName	String

Returns

{ Result, Error } Result is true if it's a valid Scene name and false if not valid along with an Error message.

IsValidScenePauseTime()

json FormIt.Scenes.IsValidScenePauseTime

(

pauseTimeString

)

IsValidScenePauseTime checks whether string contains a valid pause time.

Parameters

[in]	pauseTime	Pause Time String
[in]	pauseTimeString	String

Returns

{ Result (bool), Value (double), Error (I18nString) }

IsValidSceneTransitionTime()

json FormIt.Scenes.IsValidSceneTransitionTime

(

transitionTimeString

)

IsValidSceneTransitionTime checks whether string contains a valid pause time.

Parameters

[in]

transitionTimeString

Transition Time String

Returns

{ Result (bool), Value (double), Error (I18nString) }

MoveSceneDown()

json FormIt.Scenes.MoveSceneDown

(

sceneName

)

MoveSceneDown moves the given Scene down in the Scene list.

Parameters

[in]

sceneName

String

Returns

Success

MoveSceneUp()

json FormIt.Scenes.MoveSceneUp

(

sceneName

)

MoveSceneUp moves the given Scene up in the Scene list.

Parameters

[in]

sceneName

String

Returns

Success

RearrangeAnimations()

json FormIt.Scenes.RearrangeAnimations	(	animationNames	,
		animationBeforeOrAfterName	,
		insertAfter
	)

Rearrange the animations to be put before or after the given other animation.

If the other animation is "", the animations are placed at the end

Parameters

[in]	animationNames	vector of animation names
[in]	animationBeforeOrAfterName	name of an existing animation before or after which to insert the given animations
[in]	insertAfter	true if inserting after animationBeforeOrAfterName, false if inserting before

Returns

JSON_UNDEFINED

RearrangeScenes()

json FormIt.Scenes.RearrangeScenes	(	oldPos	,
		newPos
	)

RearrangeScenes moves the given Scene at oldPos to newPos in the Scene list.

Parameters

[in]	oldPos	int
[in]	newPos	int

Returns

Success

RemoveAnimation()

json FormIt.Scenes.RemoveAnimation

(

animationName

)

Removes a scene animation.

Parameters

[in]

animationName

String

Returns

bool Success

RemoveScene()

json FormIt.Scenes.RemoveScene

(

sceneName

)

RemoveScene removes the scene with the given name.

Parameters

[in]

sceneName

String

Returns

bool Success

SceneNameExists()

json FormIt.Scenes.SceneNameExists

(

sceneName

)

SceneNameExists returns true if a scene with the given name exists.

Parameters

[in]

sceneName

String

Returns

bool Returns true if the given name already exists

ScenesAreEqual()

json FormIt.Scenes.ScenesAreEqual	(	sceneName	,
		scene
	)

ScenesAreEqual returns true if Parameters: In: sceneName The name of an existing Scene.

scene JSON Out: bool

Parameters

[in]	sceneName	String
[in]	scene	FormIt.Scene

Returns

false

SetAnimationCollapsed()

json FormIt.Scenes.SetAnimationCollapsed	(	animationName	,
		collapsed
	)

Set the collpased status of an animation UI item

Parameters

[in]	animationName	String
[in]	collapsed	bool

Returns

JSON_UNDEFINED

SetAnimationLoop()

json FormIt.Scenes.SetAnimationLoop	(	animationName	,
		loop
	)

Set the loop option of an animation

Parameters

[in]	animationName	String
[in]	loop	bool

Returns

JSON_UNDEFINED

SetAnimationName()

json FormIt.Scenes.SetAnimationName	(	oldName	,
		newName
	)

SetSceneName renames the given Scene.

Parameters

[in]	oldName	String
[in]	newName	String

Returns

bool Success

SetCameraSpeed()

json FormIt.Scenes.SetCameraSpeed	(	sceneName	,
		cameraSpeed
	)

SetCameraSpeed sets the speed (mph) at which the camera moves during the transition to the next scene.

Parameters

[in]	sceneName	String
[in]	cameraSpeed	double

Returns

Success

SetEditCameras()

json FormIt.Scenes.SetEditCameras	(	bEditCameras	,
		animationName	,
		sceneName
	)

SetEditCameras enters the camera editing mode.

Parameters

[in]	bEditCameras	bool
[in]	animationName	String
[in]	sceneName	String

Returns

JSON_UNDEFINED

SetIncludeInAnimation()

json FormIt.Scenes.SetIncludeInAnimation	(	sceneName	,
		bIncludeInAnimation
	)

SetIncludeInAnimation sets whether the given scene is part of the animation.

Parameters

[in]	sceneName	String
[in]	bIncludeInAnimation	bool

Returns

Success

SetPauseTime()

json FormIt.Scenes.SetPauseTime	(	sceneName	,
		pauseTime
	)

SetPauseTime sets the time that the given Scene is paused during presentation mode.

Parameters

[in]	sceneName	String
[in]	pauseTime	double

Returns

Success

SetPresentationMode()

json FormIt.Scenes.SetPresentationMode	(	start	,
		sceneName
	)

SetPresentationMode starts/stops presentation mode.

Parameters

[in]	start	start/stop (true/false) presentation mode
[in]	sceneName	The name of an existing Scene to start playing from

Returns

JSON_UNDEFINED

SetPropertiesToCapture()

json FormIt.Scenes.SetPropertiesToCapture	(	sceneName	,
		properties
	)

SetPropertiesToCapture sets the Scene property flags used for determining what is captured.

Parameters

[in]	sceneName	String
[in]	properties	FormIt.SceneCaptureFlags

Returns

Success

SetSceneName()

json FormIt.Scenes.SetSceneName	(	oldSceneName	,
		newSceneName
	)

SetSceneName renames the given Scene.

Parameters

[in]	oldSceneName	String
[in]	newSceneName	String

Returns

bool Success

SetScenes()

json FormIt.Scenes.SetScenes

(

scenes

)

SetScenes sets all the Scenes.

Parameters

[in]

scenes

Array of Scene JSON objects (see GetScenes)

Returns

JSON_UNDEFINED

SetTransitionTime()

json FormIt.Scenes.SetTransitionTime	(	sceneName	,
		transitionTime
	)

SetTransitionTime sets the time that the given Scene takes to transition during presentation mode.

Parameters

[in]	sceneName	String
[in]	transitionTime	double

Returns

Success

SetUseCameraSpeed()

json FormIt.Scenes.SetUseCameraSpeed	(	sceneName	,
		bUseCameraSpeed
	)

SetUseCameraSpeed sets whether the given scene is part of the animation.

Parameters

[in]	sceneName	String
[in]	bUseCameraSpeed	bool

Returns

Success

StartStopAnimation()

json FormIt.Scenes.StartStopAnimation	(	start	,
		animationName	,
		fromScene
	)

Start/stop a continuous loop scene animation.

If the fromScene name is valid, the animation starts at that scene.

Parameters

[in]	start	bool. True to start, false to stop the playback
[in]	animationName	String
[in]	fromScene	String

Returns

JSON_UNDEFINED

UpdateScene()

json FormIt.Scenes.UpdateScene

(

sceneName

)

UpdateScene captures the Scene's properties that are enabled with the given name.

See GetPropertiesToCapture.

Parameters

[in]

sceneName

String

Returns

Success