Description
It provides methods for editing a Time Bookmark.
Object
| TimeBookmark(name=string) |
| TimeBookmark(startFrame=int) |
| TimeBookmark(startFrame=int, endFrame=int, color=int, name=string) |
Functions
| Name | Argument types | Returns | Description |
| setStartFrame | int | success (bool) | Sets the start frame of the Time Bookmark. |
| setEndFrame | int | success (bool) | Sets the end frame of the Time Bookmark. |
| setColor | int | success (bool) | Sets the color of the Time Bookmark. Available colors: kWhite kDarkWhite kLightGray kGray kDarkGray kBlack kLightPurple kPurple kDarkPurple kLightBlue kBlue kDarkBlue kLightTurquoise kTurquoise kDarkTurquoise kLightGreen kGreen kDarkGreen kLightYellow kYellow kDarkYellow kLightOrange kOrange kDarkOrange kLightRed kRed kDarkRed kLightPink kPink kDarkPink |
| setName | string | success (bool) | Sets the name (label) of the Time Bookmark. |
| delete | N/A | success (bool) | Deletes the Time Bookmark. |
| getStartFrame | N/A | int | Returns the start frame of the Time Bookmark. |
| getEndFrame | N/A | int | Returns the end frame of the Time Bookmark. |
| getColor | N/A | int | Returns the index color of the Time Bookmark. |
| getName | N/A | string | Returns the name (label) of the Time Bookmark. |
Examples
This sets the label of a time bookmark at frame 40:
from animBot import OpenAnimBot as OA
myTimeBookmark = OA.TimeBookmark(40)
myTimeBookmark.setName("run cycle")
This nudges the time bookmark 5 frames:
myTimeBookmark.setStartFrame(myTimeBookmark.getStartFrame() + 5)
This creates a Time Bookmark and set the start frame to 66:
myTimeBookmark = OA.createTimeBookmark() myTimeBookmark.setStartFrame(66)
This deletes the Time Bookmark at frame 50
myTimeBookmark = OA.TimeBookmark(50) myTimeBookmark.delete()