Bookmark Messages

Action Messages

• BOOKMARK - If left or right Ctrl were pressed, creates a bookmark in the current location under the given name. Otherwise, transitions to the bookmark of the given name.

  Parameters:

  • name (unicode) - The name of bookmark (could be new or existing).

  • event ('RTFapi.EventRef) - InputDeviceEvent.

• BOOKMARK_CREATE - Creates a bookmark at the current location. This message is broadcastable. This message will trigger the following response messages: BOOKMARK_CREATED. This default maximum wait time for this message is 10.

  Parameters:

  • name (unicode) - The name of the new bookmark.

• BOOKMARK_FIT_TEMP_TO_VIEW - Temporarily sets a bookmark that has been adjusted to fit the contents of the scene to view, and interpolates towards it. The bookmark is not saved.

  Parameters:

  • bState (k.Bookma) - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

  • useTransition (bool) - True to use a transition to the new bookmark.

• BOOKMARK_GOTO - Jumps to the given bookmark name. The bookmark must exist in the current scene. This message is broadcastable. This message will trigger the following response messages: BOOKMARK_ARRIVAL. This default maximum wait time for this message is 30.

  Parameters:

  • name (unicode) - The name of the bookmark to go to.

  • useTransition (bool) - True to use a transition to the new bookmark.

• BOOKMARK_GOTO_TEMP - Temporarily sets a bookmark and interpolates towards it. The bookmark is not saved.

  Parameters:

  • bState (k.Bookma) - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

  • useTransition (bool) - True to use a transition to the new bookmark.

• BOOKMARK_HOME - Jumps to the Home Bookmark. This message will trigger the following response messages: BOOKMARK_ARRIVAL. This default maximum wait time for this message is 30.

  Parameters:

  • useTransition (bool) - True to use a transition to the new bookmark.

  • fitToView (bool) - True to fit to view.

• BOOKMARK_INITIAL - Jumps to the initial bookmark.

  Parameters:

  • useTransition (bool) - True to use a transition.

• BOOKMARK_REMOVE - Requests the removal the named bookmark. This message will trigger the following response messages: BOOKMARK_REMOVED. This default maximum wait time for this message is 10.

  Parameters:

  • name (unicode) - The name of the bookmark to remove.

• BOOKMARK_REQUEST_LIST - Requests that a new BOOKMARK_LIST message be issued.

• BOOKMARK_REQUEST_STATE - Requests the state for the named bookmark. Find the result with BOOKMARK_STATE message.

  Parameters:

  • name (unicode) - The bookmark name.

• BOOKMARK_SET - Sets the bookmark with the arguments. The arguments must be a tuple consisting of the navigator name, bookmark name, center of interest, position and stepper; otherwise it has no effect.

  Parameters:

  • bState (k.Bookma) - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

• BOOKMARK_SET_HOME - Sets the Home Bookmark to the specified bookmark.

  Parameters:

  • bookmarkName (unicode) - The name of the new home bookmark.

• BOOKMARK_SET_INITIAL - Sets the initial bookmark at the current location.

• BOOKMARK_STOP - Stops the current bookmark.

  Parameters:

  • stopTransition (bool) - True to set the view transition to 'None'.

Information Messages

• BOOKMARK_ARRIVE - Arrives at the current bookmark.

• BOOKMARK_DEPARTURE - Indicates that the application has left a bookmark. Used to update the UI and Viewer.

• BOOKMARK_LIST - Lists all bookmarks available for the current scene.

  Parameters:

  • bookList (list) - List of bookmark names.

• BOOKMARK_STATE - Indicates the name and the state of a given bookmark.

  Parameters:

  • name (unicode) - The bookmark name.

  • state (k.Bookma) - BookmarkState for a named bookmark. Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

Response Messages

• BOOKMARK_ARRIVAL - Indicates that the application has arrived at a bookmark. Used to update the UI and Viewer.

  Parameters:

  • bName (unicode) - The name of bookmark.

• BOOKMARK_CREATED - Indicates that a new bookmark has just been created.

  Parameters:

  • name (unicode) - The name of the new bookmark.

• BOOKMARK_REMOVED - Indicates that a named bookmark was removed.

  Parameters:

  • name (unicode) - The name of the bookmark that was removed.