MotionBuilder 2017

Software Dependencies

• Supported Operating Systems - Microsoft Windows 7 SP1 or later (64-bit only), Red Hat Linux 6.5 (64-bit only), and CentOS 6.5 (64-bit only).
• MotionBuilder 2017 and the distributed plug-ins are compiled using Visual Studio 2012.
• GCC 4.8.2 is required for Linux.

New Methods, Properties, and Others

• Added the following in the FBCharacterExtension class for retarget motion:
  • The FBCharacterExtension::RetargetMode property for character extension retarget mode.
  • The FBCharacterExtension::GetSourceExtension() method that returns the character extension used to drive the extension during retargeting.
  • The FBCharacterExtension::SetSourceExtension() method that sets the character extension to drive this extension during retargeting.
  • The FBCharacterExtension::GetSourceExtensionIndex() method that returns an enum which indicates the extension used as a source during retargeting; 0 is none, 1-n represent the (ith - 1) character extension in the source character.
  • The FBCharacterExtension::SetSourceExtensionIndex() method that sets an enum which indicates the extension used as a source during retargeting; 0 is none, 1-n represent the (ith - 1) character extension in the source character.
  • The FBCharacterExtension::GetRetargetPropertyCount() method returns the total number of retarget properties.
  • The FBCharacterExtension::GetRetargetReferenceProperty() method returns the reference property of the given index.
  • The FBCharacterExtension::GetRetargetSourceProperty() method returns the source property of the given index. The source property is the property that drives the reference property during retargeting.
  • The FBCharacterExtension::SetRetargetSourceProperty() method sets the source property for retargeting.

  • The FBCharacterExtension::RemoveRetargetSourceProperty() removes the source property for retargeting.

• Added methods to the FBTake class which provide the ability to add and manage take-based markers on the MotionBuilder timeline. In addition to FBTake::AddTimeMark(), new methods set marker time, color, and name.
• Added methods to the FBPlayerControl class which provide the ability to add and manage global markers on the MotionBuilder timeline. In addition to FBPlayerControl::AddGlobalTimeMark(), new methods set the global marker time, color, and name.
• Added FBTimeMarkAction enums to determine the assigned action of time and global marks.
• Added the following in the FBModel class for collapsing and expanding nodes in Schematic View.
  • FBModel::CollapseInSchematic() collapses the model in Schematic view.
  • FBModel::ExpandInSchematic() expands the model in Schematic view.
• Added kFBCharacterKeyingFullBodyNoPull enum for FBCharacterKeyingMode which determines if character is in Full Body-No Pull keying mode.
• Added the FBAnimationNode::ReadData() method in Python to read data from the animation node.
• Added the FBCycleCreator class for creating an animation cycle for the current character.
• Added the following in the FBMenuManager class for executing main menu commands.
  • FBMenuManager::ExecuteMenuItem()specifies the menu path containing the menu to execute.
  • FBMenuManager::ExecuteMenuItemFromFullPath()specifies path to the menu item to execute.
• Added the following in the FBTake class for creating poses from non-model objects.
  • FBTake::SetLayerRealSelection()
  • FBTake::GetLayerRealSelection()
• Added the following in the FBStoryClip class:
  • The FBStoryClip::UpdateFromCurrentTake() method updates the clip animation from the current take animation for the clip track's scope.
  • The FBStoryClip::ConnectedToTake property. When connected to current take, you can update from current take, but cannot edit clip animation by adding keys.
• Added the FBCharacterExtension::GetStancePose() method in Python to retrieve the character extension stance pose.
• Added the following for the custom grouping of clips feature:
  • Added the FBStoryGroupClip class.
  • The FBStoryFolder::AlignSelectedClipsGroup() method for aligning clips inside a group.
  • The FBStoryFolder::ExpandSelectedClips() method for expanding selected clips.
• Added the FBModelPath3D::UpdateGeometry() method in Python for updating the path geometry explicitly.
• Added the FBHUD::CreateCustomElement() method in Python for adding custom HUD elements.
• Added the following for cycle analysis:
  • Added the FBCharacter::CycleAnalysisCurrentCharacter() method for running cycle analysis on the current character.
  • Added the FBCharacter::GetCycleAnalysisNode() method for getting the cycle analysis node from the current character.
  • Added these methods in the FBCycleAnalysisNode class:

    FBCycleAnalysisNode::GetPoseFCurve() - Returns the FBFCurve for pose.

    FBCycleAnalysisNode::GetRootRFCurve() - Returns the FBFCurve for RootR.

    FBCycleAnalysisNode::GetRootHFCurve() - Returns the FBFCurve for RootH.

    FBCycleAnalysisNode::GetRootXZFCurve() - Returns the FBFCurve for RootXZ.

    FBCycleAnalysisNode::GetRootSpeedFCurve() - Returns the FBFCurve for RootSpeed.

  • Added the following properties in the FBCycleAnalysisNode class:

    FBCycleAnalysisNode::RealTime - Real time.

    FBCycleAnalysisNode::RootRMode - RootR mode.

    FBCycleAnalysisNode::RootHMode - RootH mode.

    FBCycleAnalysisNode::RootXZMode - RootXZ mode.

    FBCycleAnalysisNode::RootSpeedMode - Root speed mode.

• Added new nodes (leaf roll bone) to the FBBodyNodeId enum.
• Added the following for the microphone audio device settings:

  Enums

  • FBExistingClipAction - Action to perform while preparing an Audio In object to record when the action clip associated to the recording path is in the scene.
  • FBExistingFileAction - Action to perform while preparing an Audio In object to record when the action clip associated to the recording path exists on the disk and is not empty.

  Methods

  • FBAudioFmt_ConvertChannelMode() - Converts an FBAudioChannelMode enum value to an equivalent FBAudioFmt object.
  • FBAudioFmt_ConvertBitDepthMode() - Converts an FBAudioBitDepthMode enum value to an equivalent FBAudioFmt object.
  • FBAudioFmt_ConvertRateMode() - Converts an FBAudioRateMode enum value to an equivalent FBAudioFmt object.
  • FBAudioIn::SetOnline() - Turns "Audio In" online or offline.
  • FBAudioIn::IsOnline() - Returns true if the "Audio In" is online or false if it is offline.
  • FBAudioIn::PrepareToRecord() - Prepares the "Audio In" for recording.
  • FBAudioIn::TurnOffRecording() - Turns off the "Audio In" recording.
  • FBAudioIn::IsReadyToRecord() - Returns true if the "Audio In" is ready to record. Otherwise, returns false.
  • FBAudioIn::GetSupportedFormats() - Returns all the "Audio In" supported formats (Bit Depths, Rates, and Channels).
  • FBAudioIn::SetRecordingFormat() - Sets the recording format (Bit Depth, Rate, and Channels to use). The "Audio In" must be offline when this method is called.
  • FBAudioIn::GetRecordingFormat() - Returns the current recording format (Bit Depth, Rate, and Channels).
  • FBAudioIn::SetDelay() - Sets the delay to use. The "Audio In" must be offline when this method is called (Windows only).
  • FBAudioIn::GetDelay() - Returns the currently set delay (Windows only).
  • FBAudioIn::SetDestination() - Sets the "Audio Out" object to be used as the destination. The "Audio In" must be offline when this method is called (Windows only).
  • FBAudioIn::GetDestination() - Returns the "Audio Out" object that is currently used as the destination (Windows only).
• Added the following methods to get or set the extrapolation on an FCurve:
  • FBFCurve::GetPostExtrapolationMode() - Get modes for post extrapolation.
  • FBFCurve::SetPostExtrapolationMode() - Set modes for post extrapolation.
  • FBFCurve::GetPostExtrapolationCount() - Get count for post extrapolation.
  • FBFCurve::SetPostExtrapolationCount() - Set count for post extrapolation.
  • FBFCurve::GetPreExtrapolationMode() - Get modes for pre extrapolation.
  • FBFCurve::SetPreExtrapolationMode() - Set modes for pre extrapolation.
  • FBFCurve::GetPreExtrapolationCount() - Get count for pre extrapolation.
  • FBFCurve::SetPreExtrapolationCount() - Set count for pre extrapolation.
• Added the FBCharacterFace::ExpressionGetShapeWeight() method that retrieves the weight of a shape to an expression. Additionally, the FBCharacterFace::ExpressionSetShapeWeight() method now supports weights greater than 1.0.
• Added the FBEventEvalGlobalCallback::GetEvaluateInfo() method that returns the Evaluation Info object associated with a callback event.
• Added the FBPlotOptions argument to the FBTake::PlotTakeOnObjects() method.
• FBVideoClip::CurrentFrameTimeCode - New property to read the embedded time code from the current frame in a clip.
• Added the following properties in the FBStoryClip class:
  • FBStoryClip::TravellingNode - New property to overwrite a track's travelling nodes.
  • FBStoryClip::TravellingNodeFunction - New property to overwrite a track's travelling node function.
  • FBStoryClip::GhostManipulatorMode - Time mode to display the ghost manipulator.
  • FBStoryClip::GhostCustomTime - Custom time to display ghost.
• Added the following enums:
  • FBStoryClipGhostTimeMode - Time mode to display ghost.
  • FBStoryClipNodeFunction - Node function.
• Added the following methods in the FBApplication class to access the scene properties:
  • FBApplication::GetSceneTitle() - Returns the scene title from the scene properties.
  • FBApplication::SetSceneTitle() - Sets the scene title.
  • FBApplication::GetSceneSubject() - Returns the scene subject from the scene properties.
  • FBApplication::SetSceneSubject() - Sets the scene subject.
  • FBApplication::GetSceneAuthor() - Returns the scene subject from the scene properties.
  • FBApplication::SetSceneAuthor() - Sets the scene author.
  • FBApplication::GetSceneKeywords() - Returns the scene keywords from the scene properties.
  • FBApplication::SetSceneKeywords() - Sets the scene keywords.
  • FBApplication::GetSceneRevisionNumber() - Returns the scene revision number from the scene properties.
  • FBApplication::SetSceneRevisionNumber() - Sets the scene revision number.
  • FBApplication::GetSceneComment() - Returns the scene comment from the scene properties.
  • FBApplication::SetSceneComment() - Sets the scene comment.
• FBPython::EvalLines() - Added to submit a script for parsing and execution.
• FBPose::CreatePoseThumbnail() - Added to create an image thumbnail for the current pose.

Improvements

• New callbacks have been added to the FBPropertyEventCallbackEvalPipeline property event that are invoked before and after plotting each frame:
  • kFBGlobalEvalCallbackBeforeDAG
  • kFBGlobalEvalCallbackAfterDAG
  • kFBGlobalEvalCallbackAfterDeform
  • kFBGlobalEvalCallbackBeforePlottingFrame
  • kFBGlobalEvalCallbackAfterPlottingFrame
• FBPropertyAnimatable::SetAnimated() and FBAnimationNode::SetCandidate() - A new pCheckLocked parameter is added to these functions so that they do not incorrectly change a locked property. This parameter is used for determining whether to check the locked status.
• The FBModelPath3D() Python sample code in the class documentation was updated.

Bug Fixes and Workarounds

For information on bug fixes and workarounds, refer to the MotionBuilder 2017 Release Notes.