FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::Scenes Namespace Reference

Functions

FORMIT_CORE_EXPORT bool AreScenesInitialized ()
 Returns true, if the scene manager exists and the scene API's can be called. More...
 
FORMIT_CORE_EXPORT::pair< bool, 1::string > AddScene (const 1::string &afterSceneName="")
 AddScene adds a new scene and returns success and the name of the new Scene. More...
 
FORMIT_CORE_EXPORT::pair< bool, 1::string > AddNewSceneToAnimation (const 1::string &animationName="")
 Add a new scene to the end of the given animation, or to the default animation if animationName is "". More...
 
FORMIT_CORE_EXPORT bool AddScene (FormIt::Scene const &, const 1::string &afterSceneName="")
 AddScene() function. More...
 
FORMIT_CORE_EXPORT::pair< bool, FormIt::Scene const & > GetScene (const 1::string &sceneName)
 GetScene() function. More...
 
FORMIT_CORE_EXPORT::pair< bool, 1::string > DuplicateScene (1::string const &sceneName)
 DuplicateScene duplicates the scene with the given name and returns success and the name of the new Scene. More...
 
FORMIT_CORE_EXPORT bool RemoveScene (1::string const &name)
 RemoveScene removes the given scene and returns success. More...
 
FORMIT_CORE_EXPORT bool ActivateScene (1::string const &name)
 ActivateScene activates the given scene and returns success. More...
 
FORMIT_CORE_EXPORT::vector< 1::string > GetSceneNames (const 1::string &animationName="")
 GetSceneNames returns a list of scene names for the given animation. More...
 
FORMIT_CORE_EXPORT::vector< FormIt::Scene > const & GetScenes ()
 GetScenes returns a list of scenes. More...
 
FORMIT_CORE_EXPORT void GetScenesSortedByAnimations (1::vector< FormIt::Scene > &aSortedScenes)
 Get all the scene sorted by animations like what is done in the scene widget. More...
 
FORMIT_CORE_EXPORT void SetScenes (1::vector< FormIt::Scene > &)
 SetScenes sets the list of scenes. More...
 
FORMIT_CORE_EXPORT bool UpdateScene (1::string const &name)
 UpdateScene captures the current rendering state and applies it to the given scene. More...
 
FORMIT_CORE_EXPORT::pair< bool, SceneCaptureFlagsGetPropertiesToCapture (1::string const &name)
 GetPropertiesToCapture gets the Scene properties to capture. More...
 
FORMIT_CORE_EXPORT bool SetPropertiesToCapture (1::string const &name, SceneCaptureFlags)
 SetPropertiesToCapture sets the Scene properties to capture. More...
 
FORMIT_CORE_EXPORT bool SceneNameExists (1::string const &sceneName)
 SceneNameExists returns true if a Scene with the given name exists. More...
 
FORMIT_CORE_EXPORT bool SetSceneName (1::string const &sceneName, 1::string const &newSceneName)
 SetSceneName sets the given Scene's name. More...
 
FORMIT_CORE_EXPORT bool MoveSceneUp (1::string const &sceneName)
 MoveSceneUp moves the given Scene up in the list. More...
 
FORMIT_CORE_EXPORT bool MoveSceneDown (1::string const &sceneName)
 MoveSceneDown moves the given Scene down in the list. More...
 
FORMIT_CORE_EXPORT bool RearrangeScenes (size_t oldPos, size_t newPos)
 RearrangeScenes rearranges Scene at oldPos to be at newPos. More...
 
FORMIT_CORE_EXPORT size_t GetNumberOfScenes ()
 GetNumberOfScenes returns the number of scenes. More...
 
FORMIT_CORE_EXPORT size_t GetNumberOfScenesWithAnimation ()
 Returns the number of scenes that are included in the animation. More...
 
FORMIT_CORE_EXPORT void SetPresentationMode (bool b, const 1::string &fromScene)
 Start a continuous loop scene animation. More...
 
FORMIT_CORE_EXPORT void SetRecordMode (bool b, const 1::string &fromScene, int fps=30, bool motionBlur=false, bool blendFrames=false)
 Start/stop a continuous loop scene animation for movie recording. More...
 
FORMIT_CORE_EXPORT bool IsPresenting ()
 IsPresenting() function. More...
 
FORMIT_CORE_EXPORT double GetPauseTime (1::string const &sceneName)
 The time that the given Scene is paused during presentation mode. More...
 
FORMIT_CORE_EXPORT bool SetPauseTime (1::string const &sceneName, double pauseTime)
 Set the time that the given Scene is paused during presentation mode. More...
 
FORMIT_CORE_EXPORT bool IsValidSceneName (const 1::string &oldSceneName, const 1::string &newSceneName, 1::string &errorMsg)
 Check if the given name is valid for a scene. More...
 
FORMIT_CORE_EXPORT::pair< bool, double > IsValidScenePauseTime (const 1::string &pauseTimeString, 1::string &errorMsg)
 Check if the string containing the pause time is valid. More...
 
FORMIT_CORE_EXPORT::pair< bool, double > IsValidSceneTransitionTime (const 1::string &transitionTimeString, 1::string &errorMsg)
 Check if the string containing the transition time is valid. More...
 
FORMIT_CORE_EXPORT::pair< bool, double > IsValidSceneCameraSpeed (const 1::string &speedString, 1::string &errorMsg)
 Check if the string containing the camera speed is valid. More...
 
FORMIT_CORE_EXPORT double GetTransitionTime (1::string const &sceneName)
 The time that the given Scene is animated to transition to the next scene. More...
 
FORMIT_CORE_EXPORT bool SetTransitionTime (1::string const &sceneName, double transitionTime)
 Set the time that the given Scene is animated to transition to the next scene. More...
 
FORMIT_CORE_EXPORT double GetCameraSpeed (1::string const &sceneName)
 The speed (mph) at which the camera moves during the transition to the next scene. More...
 
FORMIT_CORE_EXPORT bool SetCameraSpeed (1::string const &sceneName, double cameraSpeed)
 Set the speed (mph) at which the camera moves during the transition to the next scene. More...
 
FORMIT_CORE_EXPORT bool GetIncludeInAnimation (1::string const &sceneName)
 Whether the given scene is part of the animation. More...
 
FORMIT_CORE_EXPORT bool SetIncludeInAnimation (1::string const &sceneName, bool bIncludeInAnimation)
 Set whether the given scene is part of the animation. More...
 
FORMIT_CORE_EXPORT bool GetUseCameraSpeed (1::string const &sceneName)
 Whether the given scene is using the transition time or camera speed during animation. More...
 
FORMIT_CORE_EXPORT bool SetUseCameraSpeed (1::string const &sceneName, bool bUseCameraSpeed)
 Set whether the given scene is using the transition time or camera speed during animation. More...
 
FORMIT_CORE_EXPORT double GetTransitionTimeUsed (1::string const &sceneName)
 Get the transition time for the scene that is actually used. More...
 
FORMIT_CORE_EXPORT void SetEditCameras (bool bEditCameras, const 1::string &animationName, const 1::string &sceneName)
 Set the camera editing mode. More...
 
FORMIT_CORE_EXPORT bool GetEditCameras ()
 Get the camera editing mode. More...
 
FORMIT_CORE_EXPORT::pair< bool, 1::string > AddSceneAnimation ()
 Add a new scene animation. Returns the new name of the animation. More...
 
FORMIT_CORE_EXPORT bool RemoveAnimation (1::string const &name)
 Removes the animation. More...
 
FORMIT_CORE_EXPORT::vector< FormIt::SceneAnimation > const & GetSceneAnimations ()
 Get all scene animations. More...
 
FORMIT_CORE_EXPORT::pair< bool, FormIt::SceneAnimation const & > GetSceneAnimation (const 1::string &animationName)
 Get the animation for the given name. More...
 
FORMIT_CORE_EXPORT::vector< 1::string > GetSceneNamesFromAnimation (const 1::string &animationName)
 Get a list of scenes that belong to the given animation. More...
 
FORMIT_CORE_EXPORT bool AddScenesToAnimation (const 1::string &animationName, const 1::vector< 1::string > &sceneNames, const 1::string &sceneBeforeOrAfterName, bool insertAfter)
 Adds existing scenes to an animation. More...
 
FORMIT_CORE_EXPORT void RearrangeAnimations (const 1::vector< 1::string > &animationNames, const 1::string &animationBeforeOrAfterName, bool insertAfter)
 Rearrange the animations to be put before or after the given other animation. More...
 
FORMIT_CORE_EXPORT bool IsValidAnimationName (const 1::string &oldName, const 1::string &newName, 1::string &errorMsg)
 Check if the given name is valid for an animation. More...
 
FORMIT_CORE_EXPORT bool SetAnimationName (1::string const &name, 1::string const &newName)
 Sets the given Animation's name. More...
 
FORMIT_CORE_EXPORT void StartStopAnimation (bool bStart, const 1::string &animation, const 1::string &fromScene, bool record=false, int fps=30, bool motionBlur=false, bool blendFrames=false)
 the animation starts at that scene. More...
 
FORMIT_CORE_EXPORT bool GetAnimationLoop (1::string const &name)
 Get the loop option of an animation. More...
 
FORMIT_CORE_EXPORT void SetAnimationLoop (1::string const &name, bool bEnabled)
 Set the loop option of an animation. More...
 
FORMIT_CORE_EXPORT bool GetAnimationCollapsed (1::string const &name)
 Get the collpased status of an animation UI item. More...
 
FORMIT_CORE_EXPORT void SetAnimationCollapsed (1::string const &name, bool bCollapsed)
 Set the collpased status of an animation UI item. More...
 
FORMIT_CORE_EXPORT::string GetAnimationForScene (const 1::string &sceneName)
 Get the name of the animation to which a scene belongs. More...
 
FORMIT_CORE_EXPORT size_t GetNumberOfScenesWithAnimation (1::string const &animationName)
 Returns the number of scenes in an animation, that are animated. More...