Class MohoDoc
Version added:
before 9.5
The MohoDoc class represents the current Moho document object.
d = moho.document returns the current document object open in Moho. d is of type MohoDoc - see the ScriptInterface class.
d = moho.document returns the current document object open in Moho. d is of type MohoDoc - see the ScriptInterface class.
Methods of MohoDoc:
| Name | Returns | Description | Ver |
| AddLayerComp | void | Added in version 10 | 10 |
| AddLayerCompWithName | LayerComp | Added in version 12 | 12 |
| AddStyle | M_Style | Added in version 14.0 | 14.0 |
| AddStyle | void | < 9.5 | |
| Allow3D | bool | < 9.5 | |
| AnimDuration | int32 | Returns the duration of the document's animation | < 9.5 |
| ApplyLayerComp | void | Added in version 10 | 10 |
| ApplyLayerComp | void | Added in version 10 | 10 |
| AspectRatio | real | Returns the aspect ratio of the final rendered output | < 9.5 |
| BackCol | rgb_color | < 9.5 | |
| CleanLayerComps | void | Added in version 10 | 10 |
| ClearAnimation | void | < 9.5 | |
| ClearSecondarySelection | void | < 9.5 | |
| CountLayerComps | int32 | Added in version 10 | 10 |
| CountLayers | int32 | Returns the number of top-level layers in the document | < 9.5 |
| CountSelectedLayers | int32 | Returns number of selected layers. | < 9.5 |
| CountStyles | int32 | < 9.5 | |
| CurrentDocAction | char | Returns the name of the current action, or an empty string for the mainline | 10 |
| DeleteKeysAtFrame | void | < 9.5 | |
| DeleteLayerComp | void | Added in version 10 | 10 |
| DepthSort | void | Performs a depth sort on all layers in the document | < 9.5 |
| DuplicateLayer | MohoLayer | < 9.5 | |
| EndFrame | int32 | Return's the document's end frame | < 9.5 |
| Fps | real | Returns the frame rate of the document (frames per second) | < 9.5 |
| GetCameraDirection | Vector3 | < 9.5 | |
| GetCameraMatrix | void | < 9.5 | |
| GetLayerComp | LayerComp | Added in version 10 | 10 |
| GetOutsideViewMatrix | void | Returns the transformation matrix for viewing the scene from the "orbit" view | < 9.5 |
| GetSelectedLayer | MohoLayer | < 9.5 | |
| GlobalRenderStyle | MohoRenderStyle | < 9.5 | |
| Height | int32 | Returns the pixel height of the final rendered output | < 9.5 |
| IsLayerValid | bool | < 9.5 | |
| IsLayerValid | bool | < 9.5 | |
| IsOutsideViewEnabled | bool | Returns true if the user is orbiting the workspace, and not viewing the scene through the camera | < 9.5 |
| IsRedoable | bool | < 9.5 | |
| IsStyleUsed | bool | < 9.5 | |
| IsUndoable | bool | < 9.5 | |
| Layer | MohoLayer | Access an individual layer in the document | < 9.5 |
| LayerAbsoluteID | int32 | Returns layer's absolute ID no matter its hierarchy level | < 9.5 |
| LayerByAbsoluteID | MohoLayer | Returns a layer by its current absolute ID | < 9.5 |
| LayerByName | MohoLayer | < 9.5 | |
| LayerID | int32 | Returns document's top level layer's ID | < 9.5 |
| Metadata | LM_Message | Added in version 10 | 10 |
| Name | char | < 9.5 | |
| NoiseGrain | int32 | < 9.5 | |
| Path | char | returns the full path for the current document | < 9.5 |
| PrepMultiUndo | void | < 9.5 | |
| PrepUndo | void | Added in version 12.2 | 12.2 |
| PrepUndo | void | Mark a point in editing that the user can "undo" to return to | < 9.5 |
| Redo | void | < 9.5 | |
| Refresh | void | Added in version 9.5 | 9.5 |
| RelinkStyles | void | < 9.5 | |
| RemoveStyle | void | < 9.5 | |
| RenameStyle | void | < 9.5 | |
| SetAllow3D | void | < 9.5 | |
| SetBackCol | void | < 9.5 | |
| SetCurrentDocAction | void | Added in version 10 | 10 |
| SetDirty | void | Marks the document as "dirty" or modified, prompting the user to save if they try to quit | < 9.5 |
| SetEndFrame | void | Sets the document's end frame | < 9.5 |
| SetFps | void | < 9.5 | |
| SetNoiseGrain | void | < 9.5 | |
| SetShape | void | Set's the pixel width and height of the final rendered output | < 9.5 |
| SetStartFrame | void | Sets the document's start frame | < 9.5 |
| SetStereoSeparation | void | < 9.5 | |
| SetUserComments | void | Added in version 12 | 12 |
| SetUserTags | void | Added in version 12 | 12 |
| StartFrame | int32 | Returns the document's start frame (typically 1) | < 9.5 |
| StereoSeparation | real | < 9.5 | |
| StripUserComments | void | Strips comments from document and all layers | 12 |
| StripUserTags | void | Strips tags from document and all layers | 12 |
| Style | M_Style | This method is working as specified when called with a character string | < 9.5 |
| StyleByID | M_Style | Added in version 12 | 12 |
| Undo | void | < 9.5 | |
| UserComments | char | Added in version 12 | 12 |
| UserTags | char | Added in version 12 | 12 |
| Width | int32 | Returns the pixel width of the final rendered output | < 9.5 |
Properties of MohoDoc:
| Name | Type | Description | Ver |
| fCameraPanTilt | AnimVec2 | the camera pan/tilt animation channel. the x component is tilt (i.e. rotation around the camera's x axis); the y component is pan | < 9.5 |
| fCameraRoll | AnimVal | the camera roll animation channel (i.e. rotation around the camera's z axis) | < 9.5 |
| fCameraTrack | AnimVec3 | the camera tracking animation channel | < 9.5 |
| fCameraZoom | AnimVal | the camera zoom animation channel. The value in this channel is: Base FoV(v)/FoV(v). [FoV(v) is Field of View (vertical). Base FoV(v) is defined by the global constant LM_ZoomCamera.DEFAULT_FOV = 60 degrees (1.0472 Rad) in AS11 and previous] | < 9.5 |
| fTimelineMarkers | AnimString | Added in version 10.1 | 10.1 |