FormIt C++ API
v23.0.0 (2023.0.0)
|
Functions | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::AreScenesInitialized () |
Returns true, if the scene manager exists and the scene API's can be called. More... | |
FORMIT_CORE_EXPORT::pair< bool, 1::string > | FormIt::Scenes::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 > | FormIt::Scenes::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 | FormIt::Scenes::AddScene (FormIt::Scene const &, const 1::string &afterSceneName="") |
AddScene() function. More... | |
FORMIT_CORE_EXPORT::pair< bool, FormIt::Scene const & > | FormIt::Scenes::GetScene (const 1::string &sceneName) |
GetScene() function. More... | |
FORMIT_CORE_EXPORT::pair< bool, 1::string > | FormIt::Scenes::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 | FormIt::Scenes::RemoveScene (1::string const &name) |
RemoveScene removes the given scene and returns success. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::ActivateScene (1::string const &name) |
ActivateScene activates the given scene and returns success. More... | |
FORMIT_CORE_EXPORT::vector< 1::string > | FormIt::Scenes::GetSceneNames (const 1::string &animationName="") |
GetSceneNames returns a list of scene names for the given animation. More... | |
FORMIT_CORE_EXPORT::vector< FormIt::Scene > const & | FormIt::Scenes::GetScenes () |
GetScenes returns a list of scenes. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::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 | FormIt::Scenes::SetScenes (1::vector< FormIt::Scene > &) |
SetScenes sets the list of scenes. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::UpdateScene (1::string const &name) |
UpdateScene captures the current rendering state and applies it to the given scene. More... | |
FORMIT_CORE_EXPORT::pair< bool, SceneCaptureFlags > | FormIt::Scenes::GetPropertiesToCapture (1::string const &name) |
GetPropertiesToCapture gets the Scene properties to capture. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::SetPropertiesToCapture (1::string const &name, SceneCaptureFlags) |
SetPropertiesToCapture sets the Scene properties to capture. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::SceneNameExists (1::string const &sceneName) |
SceneNameExists returns true if a Scene with the given name exists. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::SetSceneName (1::string const &sceneName, 1::string const &newSceneName) |
SetSceneName sets the given Scene's name. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::MoveSceneUp (1::string const &sceneName) |
MoveSceneUp moves the given Scene up in the list. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::MoveSceneDown (1::string const &sceneName) |
MoveSceneDown moves the given Scene down in the list. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::RearrangeScenes (size_t oldPos, size_t newPos) |
RearrangeScenes rearranges Scene at oldPos to be at newPos. More... | |
FORMIT_CORE_EXPORT size_t | FormIt::Scenes::GetNumberOfScenes () |
GetNumberOfScenes returns the number of scenes. More... | |
FORMIT_CORE_EXPORT size_t | FormIt::Scenes::GetNumberOfScenesWithAnimation () |
Returns the number of scenes that are included in the animation. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::SetPresentationMode (bool b, const 1::string &fromScene) |
Start a continuous loop scene animation. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::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 | FormIt::Scenes::IsPresenting () |
IsPresenting() function. More... | |
FORMIT_CORE_EXPORT double | FormIt::Scenes::GetPauseTime (1::string const &sceneName) |
The time that the given Scene is paused during presentation mode. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::SetPauseTime (1::string const &sceneName, double pauseTime) |
Set the time that the given Scene is paused during presentation mode. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::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 > | FormIt::Scenes::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 > | FormIt::Scenes::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 > | FormIt::Scenes::IsValidSceneCameraSpeed (const 1::string &speedString, 1::string &errorMsg) |
Check if the string containing the camera speed is valid. More... | |
FORMIT_CORE_EXPORT double | FormIt::Scenes::GetTransitionTime (1::string const &sceneName) |
The time that the given Scene is animated to transition to the next scene. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::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 | FormIt::Scenes::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 | FormIt::Scenes::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 | FormIt::Scenes::GetIncludeInAnimation (1::string const &sceneName) |
Whether the given scene is part of the animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::SetIncludeInAnimation (1::string const &sceneName, bool bIncludeInAnimation) |
Set whether the given scene is part of the animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::GetUseCameraSpeed (1::string const &sceneName) |
Whether the given scene is using the transition time or camera speed during animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::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 | FormIt::Scenes::GetTransitionTimeUsed (1::string const &sceneName) |
Get the transition time for the scene that is actually used. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::SetEditCameras (bool bEditCameras, const 1::string &animationName, const 1::string &sceneName) |
Set the camera editing mode. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::GetEditCameras () |
Get the camera editing mode. More... | |
FORMIT_CORE_EXPORT::pair< bool, 1::string > | FormIt::Scenes::AddSceneAnimation () |
Add a new scene animation. Returns the new name of the animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::RemoveAnimation (1::string const &name) |
Removes the animation. More... | |
FORMIT_CORE_EXPORT::vector< FormIt::SceneAnimation > const & | FormIt::Scenes::GetSceneAnimations () |
Get all scene animations. More... | |
FORMIT_CORE_EXPORT::pair< bool, FormIt::SceneAnimation const & > | FormIt::Scenes::GetSceneAnimation (const 1::string &animationName) |
Get the animation for the given name. More... | |
FORMIT_CORE_EXPORT::vector< 1::string > | FormIt::Scenes::GetSceneNamesFromAnimation (const 1::string &animationName) |
Get a list of scenes that belong to the given animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::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 | FormIt::Scenes::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 | FormIt::Scenes::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 | FormIt::Scenes::SetAnimationName (1::string const &name, 1::string const &newName) |
Sets the given Animation's name. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::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 | FormIt::Scenes::GetAnimationLoop (1::string const &name) |
Get the loop option of an animation. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::SetAnimationLoop (1::string const &name, bool bEnabled) |
Set the loop option of an animation. More... | |
FORMIT_CORE_EXPORT bool | FormIt::Scenes::GetAnimationCollapsed (1::string const &name) |
Get the collpased status of an animation UI item. More... | |
FORMIT_CORE_EXPORT void | FormIt::Scenes::SetAnimationCollapsed (1::string const &name, bool bCollapsed) |
Set the collpased status of an animation UI item. More... | |
FORMIT_CORE_EXPORT::string | FormIt::Scenes::GetAnimationForScene (const 1::string &sceneName) |
Get the name of the animation to which a scene belongs. More... | |
FORMIT_CORE_EXPORT size_t | FormIt::Scenes::GetNumberOfScenesWithAnimation (1::string const &animationName) |
Returns the number of scenes in an animation, that are animated. More... | |
FORMIT_CORE_EXPORT bool FormIt::Scenes::ActivateScene | ( | 1::string const & | name | ) |
ActivateScene activates the given scene and returns success.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT ::pair<bool, 1::string> FormIt::Scenes::AddNewSceneToAnimation | ( | const 1::string & | animationName = "" | ) |
Add a new scene to the end of the given animation, or to the default animation if animationName is "".
[in] | animationName |
FORMIT_CORE_EXPORT ::pair<bool, 1::string> FormIt::Scenes::AddScene | ( | const 1::string & | afterSceneName = "" | ) |
AddScene adds a new scene and returns success and the name of the new Scene.
If afterSceneName is a valid scene name, the new scene is added after that scene in the list. Otherwise, the new scene is added at the end.
FORMIT_CORE_EXPORT bool FormIt::Scenes::AddScene | ( | FormIt::Scene const & | , |
const 1::string & | afterSceneName = "" |
||
) |
AddScene() function.
[in] | afterSceneName |
FORMIT_CORE_EXPORT ::pair<bool, 1::string> FormIt::Scenes::AddSceneAnimation | ( | ) |
Add a new scene animation. Returns the new name of the animation.
FORMIT_CORE_EXPORT bool FormIt::Scenes::AddScenesToAnimation | ( | const 1::string & | animationName, |
const 1::vector< 1::string > & | sceneNames, | ||
const 1::string & | sceneBeforeOrAfterName, | ||
bool | insertAfter | ||
) |
Adds existing scenes to an animation.
Returns true if scenes and animation exist.
[in] | animationName | |
[in] | sceneNames | |
[in] | sceneBeforeOrAfterName | |
[in] | insertAfter |
FORMIT_CORE_EXPORT bool FormIt::Scenes::AreScenesInitialized | ( | ) |
Returns true, if the scene manager exists and the scene API's can be called.
FORMIT_CORE_EXPORT ::pair<bool, 1::string> FormIt::Scenes::DuplicateScene | ( | 1::string const & | sceneName | ) |
DuplicateScene duplicates the scene with the given name and returns success and the name of the new Scene.
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::GetAnimationCollapsed | ( | 1::string const & | name | ) |
Get the collpased status of an animation UI item.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT ::string FormIt::Scenes::GetAnimationForScene | ( | const 1::string & | sceneName | ) |
Get the name of the animation to which a scene belongs.
Returns "", if the scene is not in an animation
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::GetAnimationLoop | ( | 1::string const & | name | ) |
Get the loop option of an animation.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT double FormIt::Scenes::GetCameraSpeed | ( | 1::string const & | sceneName | ) |
The speed (mph) at which the camera moves during the transition to the next scene.
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::GetEditCameras | ( | ) |
Get the camera editing mode.
FORMIT_CORE_EXPORT bool FormIt::Scenes::GetIncludeInAnimation | ( | 1::string const & | sceneName | ) |
Whether the given scene is part of the animation.
[in] | sceneName |
FORMIT_CORE_EXPORT size_t FormIt::Scenes::GetNumberOfScenes | ( | ) |
GetNumberOfScenes returns the number of scenes.
FORMIT_CORE_EXPORT size_t FormIt::Scenes::GetNumberOfScenesWithAnimation | ( | ) |
Returns the number of scenes that are included in the animation.
FORMIT_CORE_EXPORT size_t FormIt::Scenes::GetNumberOfScenesWithAnimation | ( | 1::string const & | animationName | ) |
Returns the number of scenes in an animation, that are animated.
[in] | animationName |
FORMIT_CORE_EXPORT double FormIt::Scenes::GetPauseTime | ( | 1::string const & | sceneName | ) |
The time that the given Scene is paused during presentation mode.
[in] | sceneName |
FORMIT_CORE_EXPORT ::pair<bool, SceneCaptureFlags> FormIt::Scenes::GetPropertiesToCapture | ( | 1::string const & | name | ) |
GetPropertiesToCapture gets the Scene properties to capture.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT ::pair<bool, FormIt::Scene const&> FormIt::Scenes::GetScene | ( | const 1::string & | sceneName | ) |
GetScene() function.
[in] | sceneName |
FORMIT_CORE_EXPORT ::pair<bool, FormIt::SceneAnimation const&> FormIt::Scenes::GetSceneAnimation | ( | const 1::string & | animationName | ) |
Get the animation for the given name.
[in] | animationName |
FORMIT_CORE_EXPORT ::vector<FormIt::SceneAnimation> const& FormIt::Scenes::GetSceneAnimations | ( | ) |
Get all scene animations.
FORMIT_CORE_EXPORT ::vector<1::string> FormIt::Scenes::GetSceneNames | ( | const 1::string & | animationName = "" | ) |
GetSceneNames returns a list of scene names for the given animation.
If "" is used gets all top level scenes that are not in an animation
[in] | animationName |
FORMIT_CORE_EXPORT ::vector<1::string> FormIt::Scenes::GetSceneNamesFromAnimation | ( | const 1::string & | animationName | ) |
Get a list of scenes that belong to the given animation.
IF the animation name is passed as "", scenes that don't belong to an aniamtion are returned
[in] | animationName |
FORMIT_CORE_EXPORT ::vector<FormIt::Scene> const& FormIt::Scenes::GetScenes | ( | ) |
GetScenes returns a list of scenes.
FORMIT_CORE_EXPORT void FormIt::Scenes::GetScenesSortedByAnimations | ( | 1::vector< FormIt::Scene > & | aSortedScenes | ) |
Get all the scene sorted by animations like what is done in the scene widget.
[out] | aSortedScenes |
FORMIT_CORE_EXPORT double FormIt::Scenes::GetTransitionTime | ( | 1::string const & | sceneName | ) |
The time that the given Scene is animated to transition to the next scene.
[in] | sceneName |
FORMIT_CORE_EXPORT double FormIt::Scenes::GetTransitionTimeUsed | ( | 1::string const & | sceneName | ) |
Get 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 paramater. Otherwsie the basic transition time is returned.
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::GetUseCameraSpeed | ( | 1::string const & | sceneName | ) |
Whether the given scene is using the transition time or camera speed during animation.
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::IsPresenting | ( | ) |
IsPresenting() function.
FORMIT_CORE_EXPORT bool FormIt::Scenes::IsValidAnimationName | ( | const 1::string & | oldName, |
const 1::string & | newName, | ||
1::string & | errorMsg | ||
) |
Check if the given name is valid for an animation.
Returns success. Also returns an error string that can be posted in the UI, if the name is not valid.
[in] | oldName | |
[in] | newName | |
[out] | errorMsg |
FORMIT_CORE_EXPORT ::pair<bool, double> FormIt::Scenes::IsValidSceneCameraSpeed | ( | const 1::string & | speedString, |
1::string & | errorMsg | ||
) |
Check if the string containing the camera speed is valid.
Returns success and the speed value. Also returns an error string that can be posted in the UI, if the value is not valid.
[in] | speedString | |
[out] | errorMsg |
FORMIT_CORE_EXPORT bool FormIt::Scenes::IsValidSceneName | ( | const 1::string & | oldSceneName, |
const 1::string & | newSceneName, | ||
1::string & | errorMsg | ||
) |
Check if the given name is valid for a scene.
Returns success. Also returns an error string that can be posted in the UI, if the name is not valid.
[in] | oldSceneName | |
[in] | newSceneName | |
[out] | errorMsg |
FORMIT_CORE_EXPORT ::pair<bool, double> FormIt::Scenes::IsValidScenePauseTime | ( | const 1::string & | pauseTimeString, |
1::string & | errorMsg | ||
) |
Check if the string containing the pause time is valid.
Returns success and the pause time value. Also returns an error string that can be posted in the UI, if the value is not valid.
[in] | pauseTimeString | |
[out] | errorMsg |
FORMIT_CORE_EXPORT ::pair<bool, double> FormIt::Scenes::IsValidSceneTransitionTime | ( | const 1::string & | transitionTimeString, |
1::string & | errorMsg | ||
) |
Check if the string containing the transition time is valid.
Returns success and the transition time value. Also returns an error string that can be posted in the UI, if the value is not valid.
[in] | transitionTimeString | |
[out] | errorMsg |
FORMIT_CORE_EXPORT bool FormIt::Scenes::MoveSceneDown | ( | 1::string const & | sceneName | ) |
MoveSceneDown moves the given Scene down in the list.
Returns success.
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::MoveSceneUp | ( | 1::string const & | sceneName | ) |
MoveSceneUp moves the given Scene up in the list.
Returns success.
[in] | sceneName |
FORMIT_CORE_EXPORT void FormIt::Scenes::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.
If the other animation is "", the animations are placed at the end
[in] | animationNames | |
[in] | animationBeforeOrAfterName | |
[in] | insertAfter |
FORMIT_CORE_EXPORT bool FormIt::Scenes::RearrangeScenes | ( | size_t | oldPos, |
size_t | newPos | ||
) |
RearrangeScenes rearranges Scene at oldPos to be at newPos.
Returns success.
[in] | oldPos | |
[in] | newPos |
FORMIT_CORE_EXPORT bool FormIt::Scenes::RemoveAnimation | ( | 1::string const & | name | ) |
Removes the animation.
All scenes it contains are moved to the default "animation"
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT bool FormIt::Scenes::RemoveScene | ( | 1::string const & | name | ) |
RemoveScene removes the given scene and returns success.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SceneNameExists | ( | 1::string const & | sceneName | ) |
SceneNameExists returns true if a Scene with the given name exists.
[in] | sceneName |
FORMIT_CORE_EXPORT void FormIt::Scenes::SetAnimationCollapsed | ( | 1::string const & | name, |
bool | bCollapsed | ||
) |
Set the collpased status of an animation UI item.
[in] | name | Name for the Object |
[in] | bCollapsed |
FORMIT_CORE_EXPORT void FormIt::Scenes::SetAnimationLoop | ( | 1::string const & | name, |
bool | bEnabled | ||
) |
Set the loop option of an animation.
[in] | name | Name for the Object |
[in] | bEnabled |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetAnimationName | ( | 1::string const & | name, |
1::string const & | newName | ||
) |
Sets the given Animation's name.
[in] | name | Name for the Object |
[in] | newName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetCameraSpeed | ( | 1::string const & | sceneName, |
double | cameraSpeed | ||
) |
Set the speed (mph) at which the camera moves during the transition to the next scene.
[in] | sceneName | |
[in] | cameraSpeed |
FORMIT_CORE_EXPORT void FormIt::Scenes::SetEditCameras | ( | bool | bEditCameras, |
const 1::string & | animationName, | ||
const 1::string & | sceneName | ||
) |
Set the camera editing mode.
[in] | bEditCameras | |
[in] | animationName | |
[in] | sceneName |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetIncludeInAnimation | ( | 1::string const & | sceneName, |
bool | bIncludeInAnimation | ||
) |
Set whether the given scene is part of the animation.
[in] | sceneName | |
[in] | bIncludeInAnimation |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetPauseTime | ( | 1::string const & | sceneName, |
double | pauseTime | ||
) |
Set the time that the given Scene is paused during presentation mode.
[in] | sceneName | |
[in] | pauseTime |
FORMIT_CORE_EXPORT void FormIt::Scenes::SetPresentationMode | ( | bool | b, |
const 1::string & | fromScene | ||
) |
Start a continuous loop scene animation.
If the fromScene name is valid, the animation starts at that scene.
[in] | b | |
[in] | fromScene |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetPropertiesToCapture | ( | 1::string const & | name, |
SceneCaptureFlags | |||
) |
SetPropertiesToCapture sets the Scene properties to capture.
[in] | name | Name for the Object |
FORMIT_CORE_EXPORT void FormIt::Scenes::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.
If the fromScene name is valid, the animation starts at that scene. fps, motionBlur and blendFrames are parameters for the movie generation
[in] | b | |
[in] | fromScene | |
[in] | fps | |
[in] | motionBlur | |
[in] | blendFrames |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetSceneName | ( | 1::string const & | sceneName, |
1::string const & | newSceneName | ||
) |
SetSceneName sets the given Scene's name.
[in] | sceneName | |
[in] | newSceneName |
FORMIT_CORE_EXPORT void FormIt::Scenes::SetScenes | ( | 1::vector< FormIt::Scene > & | ) |
SetScenes sets the list of scenes.
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetTransitionTime | ( | 1::string const & | sceneName, |
double | transitionTime | ||
) |
Set the time that the given Scene is animated to transition to the next scene.
[in] | sceneName | |
[in] | transitionTime |
FORMIT_CORE_EXPORT bool FormIt::Scenes::SetUseCameraSpeed | ( | 1::string const & | sceneName, |
bool | bUseCameraSpeed | ||
) |
Set whether the given scene is using the transition time or camera speed during animation.
[in] | sceneName | |
[in] | bUseCameraSpeed |
FORMIT_CORE_EXPORT void FormIt::Scenes::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.
If record is true, the animation is intended to be exported to a movie. fps, motionBlur and blendFrames are parameters for the movie generation
[in] | bStart | |
[in] | animation | |
[in] | fromScene | |
[in] | record | |
[in] | fps | |
[in] | motionBlur | |
[in] | blendFrames |
FORMIT_CORE_EXPORT bool FormIt::Scenes::UpdateScene | ( | 1::string const & | name | ) |
UpdateScene captures the current rendering state and applies it to the given scene.
Returns success.
[in] | name | Name for the Object |