Moment of Inspiration Javascript Documentation

BRep	EditableListView	List	PointObject	UIControl
BackgroundImage	Face	MenuItem	PointPicker	UIProgressBar
BoundingBox	FactoryInputEnum	MeshObject	PointStreamPicker	UIRangeControl
ColorButton	FilesystemOM	Moi	PointTextInput	UnsignedIntegerTextInput
CommandButton	GeomObject	NumericTextInput	PropertiesPanel	VectorMath
CommandOM	GeomObjectBase	ObjectDatabaseStateEnum	PropertyBinder	View
CommandUIContainer	GeomObjectEnum	ObjectList	Selection	ViewPanel
ConstructionLine	GeometryDatabase	ObjectPicker	Settings	ViewlinkContainer
CoordinateFrame	GeometryFactory	ObjectSnapEnum	StateButton	Viewport
Curve	GeometryFactoryInput	ObjectStyle	TabButton	WaitableObject
CurveOrientation	Grid	Osnap	TabContainer	WaitableWindow
CurveSegment	Image	PickedPoint	Text	Window
DisplayModeEnum	IntegerTextInput	Point	TextInput
DrawingAids	LayoutPanel	Point2D	UI

Methods
Name	Result	Arguments
getEdges	ObjectList	Returns a list of the solid's edges.
getFaces	ObjectList	Returns a list of the solid's faces.
getJoinedEdges	ObjectList	Returns a list of the solid's joined edges.
getNakedEdges	ObjectList	Returns a list of the solid's naked edges.
getSeamEdges	ObjectList	Returns a list of the solid's edge seams.

Properties
Name	Type	Notes
fileName	string	read only The name of the file the background image was loaded from.
hidden	boolean	-1 if the background image is currently hidden, and 0 if it is visible.

Methods
Name	Result	Arguments
remove		Removes the background image.

Properties
Name	Type	Notes
center	Point	read only The Point at the geometric center of the BoundingBox.
diagonalLength	float	read only The distance from one corner of the BoundingBox to its diametrically opposite corner.
max	Point	Specifies the corner Point of the BoundingBox with the maximum x, y and z coordinates.
min	Point	Specifies the corner Point of the BoundingBox with the minimum x, y and z coordinates.
xLength	float	read only The length of the BoundingBox along its x-axis parallel edges.
yLength	float	read only The length of the BoundingBox along its y-axis parallel edges.
zLength	float	read only The length of the BoundingBox along its z-axis parallel edges.

Methods
Name	Result	Arguments
addBoundingBox		BoundingBox box Adds another bounding box to this one. This BoundingBox is modified to be the union of box and the original contents of the BoundingBox.
addObject		GeomObject obj, boolean useHighAccuracyBounds = 0 Adds the BoundingBox for obj to this one. This BoundingBox is modified to be the union of the BoundingBox for obj and the original contents of the BoundingBox.
addPoint		Point point Adds the BoundingBox for point to this one. This BoundingBox is modified to be the union of the BoundingBox for point and the original contents of the BoundingBox.
clear
get		float minX, float minY, float minZ, float maxX, float maxY, float maxZ
set		float minX, float minY, float minZ, float maxX, float maxY, float maxZ Sets the position and size of the BoundingBox to the region bounded by the two corner points (minX,minY,minZ) and (maxX,maxY,maxZ).

Properties
Name	Type	Notes
value	int	Specifies the current color value of the control. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.

Properties
Name	Type	Notes
active	boolean

Properties
Name	Type	Notes
lastCommandRevisionEnd	int	read only Specifies what the GeometryDatabase revision was at the end of the last command.
lastCommandRevisionStart	int	read only Specifies what the GeometryDatabase revision was at the start of the last command.
nonRepeatingCommands	string	Specifies the list of blank separated commands which cannot be repeated.

Methods
Name	Result	Arguments
cancel		Cancels the currently executing command (if any).
createFactory	GeometryFactory	string factoryName Creates and returns a GeometryFactory object that can be used to create the type of geometry specified by factoryName. Every geometry factory has a specific set of inputs, which define the characteristics of the geometry it creates (e.g. a line requires two Point objects to define its endpoints). In general, each MoI command starts by creating the appropriate type of geometry factory and then filling in all of the required inputs via user prompts and point and object picking. Once all of the factory inputs have been specfied, the factory is asked to create a new geometric object, based on its inputs, which is then added to the current scene. The possible values for factoryName are: addpoint align alignbackgroundimage arc3pt arccenter arccontinue arctangent arraycircular arraycurve arraydir arraygrid backgroundimage blend booleandifference booleanintersection booleanmerge booleanunion box box3pts boxcenter chamfer circle circle3pt circlediameter circletangent cone copy cylinder delete ellipse ellipsecorner ellipsediameter extend extrude fillet flip helix intersect join line loft merge mirror move network offset planarsrf plane plane3pts planecenter point polygon polygonedge polygonstar project railrevolve rect3pts rectangle rectcenter revolve rotate rotateaxis separate shell shrinktrimmedsrf sketchcurve sphere sweep text trim
execCommand		string commandName Executes the command specified by commandName. The set of possible values for commandName are: AddPoint Align Arc3pt ArcCenter ArcContinue ArcTangent ArrayCircular ArrayCurve ArrayDir ArrayGrid Blend BooleanDifference BooleanIntersection BooleanMerge BooleanUnion Box Box3pts BoxCenter Chamfer Circle Circle3pt CircleDiameter CircleTangent Cone Copy CopyClipboard Curve Cut Cylinder Delete Ellipse EllipseCorner EllipseDiameter Export Extend Extrude Fillet Helix History Image Import IncrementalSave InterpCurve Intersect Join Line Loft Mirror Move Network New Offset Open Paste PlanarSrf Plane Plane3pts PlaneCenter Point Polygon PolygonEdge PolygonStar Polyline Project RailRevolve Rect3pts Rectangle RectCenter Revolve Rotate RotateAxis Save SaveAs Scale Scale1D Scale2D Separate Shell ShowPoints ShrinkTrimmedSrf SketchCurve Sphere Sweep Text Trim The use and effect of each of these commands is described in the MoI Command Reference.
execCommandSet		string commandSetName
getCommandLineParams	string	Returns the command line parameters specified when invoking MoI.
getOption	any	string option, boolean fromIni = 0 Returns the value of a previously saved option. This method works in conjunction with the setOption method to allow you to set and get command options from one command execution to the next. If fromIni is omitted or false, the option is assumed to be stored in the application's temporary option's cache. If fromIni is true, the option is retrieved from the moi.ini file. If the option value requested has not previously been set, an exception is generated. The standard convention used for option names is to use the name of the file referencing the option followed by a suffix describing the purpose of the value (e.g. Options.htm_lastused). This is only a convention, but it helps guarantee that two different commands do not define and use the same option name.
redo		Performs a redo of a previously undone command. Successive calls redo the sequence of previously undone commands. There is no indication of when the last undone command has been redone.
registerCommandSpecificShortcutKey		string shortcut Registers a keyboard key as a shortcut key for this command. When the shortcut key is pressed, it will generate a UI event for the command. The possible values for shortcut are: Delete
repeatLastCommand		Repeats the last command executed that was not a non-repeatable command. Note that this does not create the same result that the last command created, but re-executes the command as if the user had initiated it again. That is, this method is equivalent to the user pressing Enter or the right mouse button after completing a command.
setCommandSpecificUndo		boolean newCommandSpecificUndo
setOption		string option, any varValue, boolean toIni = 0 Saves varValue under the name option. This method is used in conjunction with the getOption method to save and restore user specified command options from one execution of the command to the next. If toIni is omitted or false, varValue is stored in the application's temporary option/s cache. If toIni is true, varValue is permanently saved in the moi.ini file under the name specified by option. The standard convention used for option names is to use the name of the file referencing the option followed by a suffix describing the purpose of the value (e.g. Options.htm_lastused). This is only a convention, but it helps guarantee that two different commands do not define and use the same option name.
undo		Performs an undo of a command. Successive calls undo commands further back in the command history stack. There is no indication of when the last command in the history stack has been undone.

Methods
Name	Result	Arguments
pop		Pops and restores the user interface saved by the most recent call to the push method. If there was no matching previous call to push, an exception is generated.
push		string url Pushes the state of the current command user interface onto a stack, then loads and executes the command user interface specified by url.

Properties
Name	Type	Notes
isTemporary	boolean	Specifies whether or not the ConstructionLine is temporary. If true, the ConstructionLine is temporary and will be deleted at the end of the current operation. If false, it is not temporary.

Properties
Name	Type	Notes
origin	Point	Specifies the Point in world space that is the origin for this coordinate system.
xaxis	Point	Specifies the Point in world space that defines the x axis for this coordinate system. That is, the vector from origin to xaxis defines the positive x axis of the coordinate system.
yaxis	Point	Specifies the Point in world space that defines the y axis for this coordinate system. That is, the vector from origin to yaxis defines the positive y axis of the coordinate system.
zaxis	Point	read only Specifies the Point in world space that defines the z axis for this coordinate system. That is, the vector from origin to zaxis defines the positive z axis of the coordinate system.

Methods
Name	Result	Arguments
distancex	float	Point point
distancey	float	Point point
distancez	float	Point point
evaluate	Point	float x, float y, float z
get		float originX, float originY, float originZ, float xAxisX, float xAxisY, float xAxisZ, float yAxisX, float yAxisY, float yAxisZ
set		float newOriginX, float newOriginY, float newOriginZ, float newXAxisX, float newXAxisY, float newXAxisZ, float newYAxisX, float newYAxisY, float newYAxisZ Completely replaces the previous coordinate system with a new one whose origin in world space coordinates is given by (newOriginX,newOriginY,newOriginZ), and whose x and y axes are defined by the points (newXaxisX,newXaxisY,newXaxisZ) and (newYaxisX,newYaxisY,newZaxisZ) respectively, also in world coordinates. The z axis for the new coordinate system is derived implicitly from the new x and y axes using the right hand rule.

Properties
Name	Type	Notes
isClosed	boolean	read only Specifies whether or not the curve is closed. If true, then the curve is closed. If false, then the curve is open.

Methods
Name	Result	Arguments
getEndPt	Point	Returns the ending Point of the curve.
getFacesOfEdge	ObjectList	Returns an ObjectList containing all Face objects that have this curve as an edge.
getLength	float	Returns the length of the curve.
getStartPt	Point	Returns the starting Point of the curve.

Properties
Name	Type	Notes
flipped	boolean
seam	float

Enumeration Values
Name	Value
Normal	0 The object is drawn using a drawing style consisting of a solid wireframe and solid shading.
FaintWireframe	1 The object is drawn using a drawing style consisting of a faint dashed wireframe and no shading, giving the object a ghosted appearance.

Properties
Name	Type	Notes
drawPlanar	boolean
gridSnap	boolean	Specifies whether grid snapping is on or off. If true, then grid snapping is turned on. If false, grid snapping is turned off.
objectSnap	boolean	Specifies whether object snapping is on or off. If true, then object snapping is turned on. If false, object snapping is turned off.
objectSnapAxis	boolean	Specifies whether object snapping to the world space x, y and z axes is on or off. If true, axis snapping is turned on. If false, axis snapping is turned off.
objectSnapCen	boolean	Specifies whether object snapping to the center point of circles, ellipses or circular arcs is turned on or off. If true, then center snapping is turned on. If false, center snapping is turned off.
objectSnapEnd	boolean	Specifies whether object snapping to the end points of curves or edges is on or off. If true, then end snapping is turned on. If false, end snapping is turned off.
objectSnapInt	boolean	Specifies whether object snapping to the intersection between two or more curves or edges is on or off. If true, then intersection snapping is turned on. If false, then intersection snapping is turned off.
objectSnapMarkerDisplayRadius	int	Specifies the maximum distance, in pixels, that a potential snap marker can be from the current cursor position before it will be displayed to the user. All snap markers within this radius are displayed, while those outside it are not.
objectSnapMarkerOpacity	int
objectSnapMid	boolean	Specifies whether object snapping to the midpoint of curves or edges is on or off. If true, then midpoint snapping is turned on. If false, then midpoint snapping is turned off.
objectSnapOn	boolean	Specifies whether object snapping to points on a curve or edge is on or off. If true, then point on curve snapping is turned on. If false, point on curve snapping is turned off.
objectSnapOnSrf	boolean	Specifies whether object snapping to points on the surface of a solid is on or off. If true, then surface snapping is turned on. If false, then surface snapping is turned off.
objectSnapOrigin	boolean	Specifies whether object snapping to the world origin is turned on or off. If true, then snapping to the world origin is turned on. If false, world origin snapping is turned off.
objectSnapPerp	boolean	Specifies whether object snapping is on or off for points on a curve or edge that are perpendicular to the curve's tangent at that point and a line through the point and the current base point. If true, then perpendicular snapping is turned on. If false, perpendicular snapping is turned off.
objectSnapPerpPerp	boolean
objectSnapProjectInOrthoViews	boolean
objectSnapPt	boolean
objectSnapQuad	boolean	Specifies whether object snapping to the quadrant points of circular or elliptical curves or edges is on or off. If true, then quadrant snapping is turned on. If false, quadrant snapping is turned off.
objectSnapRadius	int
objectSnapShowMarkers	boolean	Specifies whether or not object snap markers are displayed. If true, object snap markers are displayed. If false, they are not. Object snap markers are the small x symbols displayed in the editing viewports to show the location of potential snap points to the user.
objectSnapTan	boolean	Specifies whether object snapping is on or off for points on a curve or edge that form a tangent to the curve at that point with a line though the current base point. If true, then tangent snapping is turned on. If false, tangent snapping is turned off.
objectSnapTanTan	boolean
objectSnapUseApparentIntersections	boolean
snapToLockedObjects	boolean	Specifies whether or not snapping to locked objects is allowed. If true, the user can snap to points on locked objects. If false, no snap points on locked objects will be displayed.
snapToPickedPoints	boolean	Specified whether snapping to points already picked in the current command is on or off. If true, then picked point snapping is turned on. If false, then picked point snapping is turned off.
straightSnap	boolean	Specifies whether straight snapping is on or off. If true, then straight snapping is turned on. If false, straight snapping is turned off.
straightSnapActivateDistance	int	Specifies the distance, in pixels, the cursor can be from a straight snap line before it snaps to the line. That is, as soon as the cursor moves within the specified distance from a potential straight snap line, it will activate and snap to that line. Note that this value only controls how close the cursor must be in order to activate the straight snap. The distance the cursor must travel away from a straight snap line before deactivating the line is controlled by the value of straightSnapKeepActiveDistance.
straightSnapAngle	float	Specifies the angle, in degrees, at which straight snapping occurs. That is, straight snapping occurs at any multiple of this angle. For example, if the angle is 90, then straight snapping occurs at 0, 90, 180 and 270 degrees.
straightSnapEnablePerpendicular	boolean
straightSnapEnableSurfaceNormal	boolean
straightSnapEnableTangent	boolean
straightSnapEnableVertical	boolean
straightSnapKeepActiveDistance	int	Specifies the distance, in pixels, the cursor must move away from an active straight snap line before it deactivates the line. Note that this value only controls how far away the cursor must move before deactivating a straight snap. The distance the cursor must be from a potential straight snap line before activating the line is controlled by the value of straightSnapActivateDistance. Normally, the value of straightSnapKeepActiveDistance should be greater than the value of straightSnapActivateDistance in order to prevent straight snaps from turning on and off too rapidly while the cursor is moving.
straightSnapLineColor	int	Specifies the color used to draw straight snap lines as an integer of the form: 0xAARRGGBB, where AA is the alpha channel value, RR is the red channel value, GG is the green channel value, and BB is the blue channel value. Note that a value for AA of 0x00 is fully transparent, while 0xFF is fully opaque.
straightSnapLineStyle	string	Specifies the line style used to draw straight snap lines. The possible values are: Short Dashed Dashed Solid Specifying any other value will result in drawing solid straight snap lines.
straightSnapLineWidth	float	Specifies the width, in pixels, of the lines used to draw straight snaps.

Methods
Name	Result	Arguments
constructionLineDivSnap		float divisions
constructionLineProject
constructionLineReorient
constructionLineReposition
constructionLineRotate		float angleDegrees

Methods
Name	Result	Arguments
add
remove

Methods
Name	Result	Arguments
getEdges	ObjectList
getJoinedEdges	ObjectList
getNakedEdges	ObjectList
getSeamEdges	ObjectList

Enumeration Values
Name	Value
Unknown	0 The GeometryFactoryInput object has not been configured to accept any type of object.
Point	1 The GeometryFactoryInput object accepts Point objects.
CoordinateFrame	2 The GeometryFactoryInput object accepts CoordinateFrame objects.
Bool	3 The GeometryFactoryInput object accepts boolean values (i.e. true or false).
Double	4 The GeometryFactoryInput object accepts floating point values.
Int	5 The GeometryFactoryInput object accepts integer values.
String	6 The GeometryFactoryInput object accepts string values.
Object	7 The GeometryFactoryInput object accepts GeomObject objects.
ObjectList	8 The GeometryFactoryInput object accepts ObjectList objects.
List	9 The GeometryFactoryInput object accepts List objects.

Methods
Name	Result	Arguments
getCompactPath	string	string fileName, int numChars
getFileNameFromPath	string	string fullPath
getOpenFileName	string	string title, string filters
getSaveFileName	string	string title, string filters
incrementFileName	string	string fileName

Properties
Name	Type	Notes
databaseRevision	int	read only Specifies an internal revision number for the object. Any changes made to the object cause this value to change.
databaseState	ObjectDatabaseStateEnum	read only Specifies the state of the object relative to the current scene.
displayMode	DisplayModeEnum	Specifies the display mode used to draw the geometric object in any of the editing viewports.
hidden	boolean	Specifies whether the geometric object is visible or hidden. If true, the object is hidden in the editing viewports. If false, the object is visible in the editing viewports.
id	string	read only Specifies a unique id associated with each geometric object when it is added to the current scene.
locked	boolean	Specified whether the geometric object is locked or not. If true, the object is locked and cannot be selected. If false, it is not locked and can be selected. When in the locked state, objects are displayed greyed-out in the editing viewports, and have a padlock icon displayed next to them in the various application list views. They cannot be selected or modified while in the locked state.
name	string	Specifies the name of the object. The name of the object appears in the application's Objects list. More than one object can have the same name, which is useful as a means of grouping related objects in the scene. The name is also used for associating the object with a particular mesh when exporting to file formats that support named meshes.
selected	boolean	Specifies whether the geometric object is currently selected or not. If true, the object is selected. If false, it is not selected.
showPoints	boolean	Specifies whether the control points for the object are visible or not. If true, the control points are visible in the editing viewports. If false, the control points are not visible.
styleIndex	int	Specifies the index of the ObjectStyle object within the application's Styles list that is associated with the geometric object. The ObjectStyle controls some of the object's display appearance and exported material settings, and can also be used as a way of grouping related objects within the scene. The valid values are from 0 to (styles.length - 1). Values outside of this range are mapped internally to the default style.
type	GeomObjectEnum	read only Specifies what the type of the geometric object is.
updateWithHistory	boolean

Methods
Name	Result	Arguments
clone	GeomObject	Creates and returns a clone, or copy, of the object. The copy is identical to the original object, but has not yet been added to the current scene. You may add the object to the scene using the GeometryDatabase object's addObject or addObjects methods.
deleteHistoryData
getBoundingBox	BoundingBox	boolean useHighAccuracyBounds = 0 Returns a BoundingBox object describing the bounding box for the object.
getHistoryChildren	ObjectList
getHistoryData	string
getHistoryParents	ObjectList
getSubObjects	ObjectList	Returns an ObjectList containing all of the sub-objects contained within the geometric object. For example, a box solid returns a list of 30 sub-objects, consisting of 12 Curve, 12 CurveSegment and 6 Face objects.
setHitTest		boolean newHitTest

Enumeration Values
Name	Value
Unknown	0 The object is of an unknown type.
CurveSegment	1 The object is a CurveSegment.
Curve	2 The object is a Curve.
BRep	3 The object is a BRep (Boundary Representation).
Face	4 The object is a Face.
ConstructionLine	5 The object is a ConstructionLine.
PointObject	6 The object is a PointObject (i.e. a Point)
MeshObject	7 The object is a MeshObject.

Properties
Name	Type	Notes
Units	string	Specifies the base unit used for measuring distances and lengths in the current session. The possible values are: Feet Inches Meters
currentFileName	string	read only Specifies the full path and file name of the file currently being edited (e.g. C:\my_models\MoI_Ball.3dm). If no file has been loaded or saved yet, its value is the empty string.
currentFileNameDir	string	read only Specifies the full path to (but not the file name) of the file currently being edited (e.g. C:\my_models\). If no file has been loaded or saved yet, its value is the empty string.
defaultUnits	string	Specifies the default units to use for measuring distances and lengths for any new scene created. The possible values are: Feet Inches Meters
generatedObjectsInheritStyle	boolean	Specifies whether objects generated from another object inherit the style of the object they are generated from. If true, any generated object inherits the style of the object it is generated from. If false, any generated object is initially given the default style. For example, if a circle is extruded to create a cylinder, the cylinder is generated from the circle and will either inherit the circle's style or be given the default style, depending upon the setting of this property.
revision	int	read only
scaleOnImportDifferentUnits	boolean
scaleOnUnitChange	boolean	Specifies whether all geometric data should be scaled when the current unit system specified the Units property is changed. If true, then all geometric data is scaled appropriately when the unit system changes. If false, no change occurs to the geometric data when the unit system changes.
startupTemplate	string
tolerance	float	read only Specifies the tolerance value used internally by MoI when determining if two values are equal.
unitsShortLabel	string	read only Specifies the short form of the current units system specified by the Units property. The possible values are: ft in m

Methods
Name	Result	Arguments
addObject		GeomObject object Adds the geometric object specified by object to the current scene.
addObjects		ObjectList objects Adds all of the geometric objects contained in objects to the current scene.
addStyle	ObjectStyle	Creates and returns a new ObjectStyle object. The new object style will have already been added to the end of the application's Styles list.
calculateCurveOrientations	List	ObjectList curveList
copyToClipboard		ObjectList objects Copies all of the contents of objects to the system clipboard.
copyToClipboardCommand		ObjectList objects
createObjectList	ObjectList	Creates and returns a new, empty ObjectList.
deleteAll		Deletes all geometric data contained in the current session (i.e. solids, surfaces, curves, points, etc.).
deselectAll		Deselects all currently selected objects (solids, surfaces, curves, points, etc.).
fileExport		string fileName, string options = ""
fileImport		string fileName Imports the file specified by fileName into the current scene.
fileNew		boolean noQuerySaveChanges = 0 Clears the contents of the current scene and starts a new one. If noQuerySaveChanges is omitted or false, the user is prompted to save any unsaved changes to the current scene. If noQuerySaveChanges is true, the current scene is cleared without asking the user if they want to save their work.
findObject	GeomObject	string id Returns the geometric object with the specified id, or null no object wth the specified id is found.
findStyle	ObjectStyle	string styleName, boolean createIfNotFound = 0 Return the ObjectStyle object with the specified styleName, or null if no style object with the specified styleName is found. However, if the requested style is not found, but createIfNotFound is true, then a new ObjectStyle object with the specified styleName is created and added to the application's Styles list and returned as the result.
getObjectStyles	List	Returns a List of all currently defined ObjectStyle objects.
getObjects	ObjectList	Returns an ObjectList containing all currently defined geometric objects (solids, surfaces, curves, points, etc.). If no objects are defined, the list will be empty.
getOpenFileName	string	string dialogTitle = "", boolean isTemplate = 0
getSaveFileName	string	string default = ""
getSelectedObjects	ObjectList	Returns an ObjectList containing all currently selected geometric objects (solids, surfaces, curves, points, etc.). If no objects are selected, the list will be empty.
hide		boolean unused = 0 Hides all currently selected geometric objects.
incrementalSave
invertSelection		Inverts the current selection. All geometric objects not currently selected are selected, and all previously selected objects are unselected.
isolate		Isolates the currently selected geometric objects by hiding all non-selected objects.
isolateLock		Isolates the currently selected geometric objects by locking all non-selected objects.
lock		Locks all currently selected geometric objects. If no objects are currently selected, then all previously locked objects are unlocked. A locked object cannot be selected or modified, and will appear with a padlock icon when displayed in one of the application list views. The object will also usually appear greyed-out in any of the editing viewports.
open		string fileName, boolean noQuerySaveChanges = 0 Clears the current scene and loads in a new scene contained in the file specified by fileName. If noQuerySaveChanges is omitted or false, the user is prompted to save any unsaved changes to the current scene. If noQuerySaveChanges is true, the current scene is cleared without asking the user if they want to save their work.
openTemplate		string fileName, boolean noQuerySaveChanges = 0 Clears the current scene and loads in a new scene contained in the file specified by fileName. If noQuerySaveChanges is omitted or false, the user is prompted to save any unsaved changes to the current scene. If noQuerySaveChanges is true, the current scene is cleared without asking the user if they want to save their work. This method is identical to the open method, except that after loading the specified fileName, the openTemplate method discards the file name. This has the effect of forcing the user to specify a new save file name when they try to save the scene, thus preventing them from accidentally saving over the template file.
pasteFromClipboard		Paste the current contents of the system clipboard into the scene. In order for this to work correctly, the clipboard must contain some type of data meaningful to MoI. In most cases, this will be data previously sent to the clipboard from this, or another, copy of MoI.
removeObject		GeomObject object Removes object from the current scene.
removeObjects		ObjectList objects Removes all items in the objects list from the current scene.
save		Save the current contents of the scene to the file currently associated with the scene. If no file is associated with the scene, the system save file dialog is displayed, prompting the user to enter the name of the file to save the scene in.
saveAs		string fileName, string options = ""
selectAll		Selects all currently visible (i.e. non-hidden) objects (solids, surfaces, curves, etc.).
selectLastCreated		boolean deselectOthers = 0
selectNamed		string name Selects all objects having the specified name. Note that this does not deselect any currently selected objects. It simply adds any matching named objects to the current selection.
selectVisible		Selects all non-hidden, non-locked geometric objects.
showPoints		Toggles the visibility of the control points for all currently selected geometric objects. If one or more of the currently selected objects is not displaying its control points, then the control points for all selected objects are displayed. If all selected objects have their control points displayed, then the control points for all selected objects are hidden. If no objects are selected, this method has no effect.
showSubset
sortCurves		ObjectList curveList
styleEditorClosed		Informs the MoI application that the Style Editor dialog has been closed.
styleEditorOpened		Informs the MoI application that the Style Editor dialog has been opened.
unlockSubset

Properties
Name	Type	Notes
name	string	read only Specifies the name of the type of factory object this is. This is the same name passed to the CommandOM object's createFactory method used to create this object.
numInputs	int	read only Specifies the number of inputs this factory object has.

Methods
Name	Result	Arguments
addToListInput		int whichInput, any value Adds value to the end of the list of values for the input specified by whichInput.
calculate	ObjectList
cancel		Cancels the factory, preventing it from generating any new geometric objects.
clearInput		int whichInput Clears (i.e. resets) the value of the input specified by whichInput.
commit		Creates an instance of the type of GeomObject object this object is a factory for and adds it to the current scene.
createInput		string inputType
createInputType		FactoryInputEnum type
disableUIGeometry
disableUpdate		boolean varSuppress Specifies whether or not updates of the editing viewports should be performed while the factory inputs are being updated. If varSuppress is true, the the editing viewports will not update as the user interactively modifies the factory inputs. For example, if a line factory were active, but viewport updates were disabled, the user would not see the new line rubberbanding in the editing viewports. If varSuppress is false, the editing viewports are updated while the user interactively updates the factory inputs.
getInput	GeometryFactoryInput	int whichInput Returns a GeometryFactoryInput object which acts as a reference to the factory input specified by whichInput. This object is then typically used with a bindxxx method to allow binding the specified factory input to a user interface object, such as a PointPicker, which allows the user to interactively specify the value required by the factory input.
removeLastInput
reset		Resets (i.e. clears) the factory object back to its initial state.
setInput		int whichInput, any value Assigns value to the factory input specified by whichInput.
update		Causes the factory to update the editing viewports to reflect the factory's current input settings. This method is normally called after a script modifies one or more of the factory inputs using the setInput method.

Properties
Name	Type	Notes
name	string	Specifies the name of the factory input this object is associated with. The name identifies the purpose or role of the factory input. For example, the name of factory input 0 for a line factory is Start, reflecting its role of specifying the start point of the line it is creating.
type	FactoryInputEnum	read only Specifies the type of value the factory input associated with this object accepts.

Methods
Name	Result	Arguments
getValue	any	Returns the current value of the factory input this object is associated with.
setValue		any newValue Sets the value of the factory input this object is associated with to newValue.

Properties
Name	Type	Notes
accentedLineColor	int	Specifies the color used to draw the accented (i.e. major) grid lines. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
accentedLineFrequency	int	Specifies the interval, measured in normal grid lines, at which an accented (i.e. major) grid line is drawn. For example, a value of 5 means that every fifth grid line is an accented grid line.
accentedLineStyle	string	Specifies the line style used to drawn accented (i.e. major) grid lines. The possible values are: Long Dashed Dashed Solid If an unrecognized value is used, a solid grid line is drawn.
accentedLineWidth	float	Specifies the width, in pixels, of an accented (i.e. major) grid line.
display	boolean	Specifies whether the grid is displayed or not. If true, then the grid is displayed. If false, the grid is not displayed.
lineColor	int	Specifies the color used to draw the normal (i.e. minor) grid lines. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
lineStyle	string	Specifies the line style used to drawn normal (i.e. minor) grid lines. The possible values are: Long Dashed Dashed Solid If an unrecognized value is used, a solid grid line is drawn.
lineWidth	float	Specifies the width, in pixels, of a normal (i.e. minor) grid line.
sections	int	Specifies the number of grid lines drawn in each quadrant of the grid.
showXYAxes	boolean	Specifies whether the x and y axes should be drawn. If true, the x and y axes are drawn. If false, the axes are not drawn.
size	float	Specifies the distance interval, measured in base units (e.g. 'Feet'), between each pair of grid lines.
snapSize	float	Specifies the grid snapping distance interval, measured in base units (e.g. 'Feet').
xAxisColor	int	Specifies the color used to draw the positive x axis line. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
yAxisColor	int	Specifies the color used to draw the positive y axis line. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.

Methods
Name	Result	Arguments
getSaveFileName	string	string default = "" Prompts the user for the name of a file to save the image in, and returns either the fully qualified name of the file that the user selected, or the empty string if the user cancels the file prompt. The value of default is a string specifying the default file name to use. If omitted, no default file name is displayed in the input field. If the user selects an existing file, the file prompt dialog will automatically ask if the user wants to replace the selected file, so there is no need to prompt the user again for this information.
save		string fileName Saves the bitmap image to the file specified by fileName.

Properties
Name	Type	Notes
integerValue	int	Specifies the current integer value of the control, either as entered by the user or set by the application.

Properties
Name	Type	Notes
dock	string	Specifies how the panel should be laid out with respect to the user interface element it is contained in. The possible values are: top: The panel should be docked to the top edge of its parent. bottom: The panel should be docked to the bottom edge of its parent. left: The panel should be docked to the left edge of its parent. right: The panel should be docked to the right edge of its parent. fill: The panel should fill any unused space within its parent.

Properties
Name	Type	Notes
length	int	read only The number of elements currently in the list.

Methods
Name	Result	Arguments
add		any item Adds item to the end of the list.
item	any	int index Returns the index element of the list. The valid indices are from 0 to (list.length - 1). The method raises an exception if index is not in this range.
remove		int index Removes the index element from the list. The valid indices are from 0 to (list.length - 1). The method raises an exception if index is not in this range.

Properties
Name	Type	Notes
checked	boolean	Specifies whether the menu item should display a checked symbol next to the menu item text. If true, the checked symbol is displayed. If false, the checked symbol is not displayed.

Properties
Name	Type	Notes
command	CommandOM	read only Contains a reference to the CommandOM object, which provides access to the properties and methods used to manage and control the MoI application command execution environment.
drawingAids	DrawingAids	read only Contains a reference to the DrawingAids object, which provides access to the current state of all of the drawing aids (i.e. snaps, construction line data) available to the user.
expireDate	string	read only Contains the user's MoI trial license expiration date in the form: mmm-dd-yyyy (e.g. Sep-21-2009). Its value is the empty string if the user has a fully licensed copy of MoI installed.
filesystem	FilesystemOM	read only Contains a reference to the FilesystemOM object, which provides a number of methods for manipulating file names and prompting the user for file names.
geometryDatabase	GeometryDatabase	read only Contains a reference to the GeometryDatabase object, which provides access to all of the geometry data for the current session.
grid	Grid	read only Contains a reference to the Grid object, which provides access to all of the properties used to control the background grid drawn in the editing viewports.
selection	Selection	read only
settings	Settings	read only Contains a reference to the Settings object, which provides access to the properties which control the various file import and export options.
ui	UI	read only Contains a reference to the UI object, which provides access to the properties used to control the behavior of the MoI application user interface.
vectorMath	VectorMath	read only Contains a reference to the VectorMath object which provides useful helper methods for performing vector math operations and tests upon Point objects as well as factory methods for creating CoordinateFrame objects.
version	string	read only The version number of MoI in the form: x.y ttt...ttt, where x is the major version, y is the minor version, and ttt...ttt is an optional text modifier. For example: 2.0 Beta Jun-23-2009.
view	View	read only Contains a reference to the View object, which provides access to the properties which control the appearance and behavior of the editing viewports.

Methods
Name	Result	Arguments
copyTextToClipboard		string text Copies text to the system clipboard.
createList	List	Creates and returns a new List object, which can be used to store a list of any type of MoI data.
exit		boolean noQuerySaveChanges = 0 Causes MoI to exit. If noQuerySaveChanges is omitted or 0, the user is prompted first to save any unsaved changes. If noQuerySaveChanges is not 0, the program exits immediately without saving the contents of the user's current session.
getLog	string	Returns a string containing all messages written to the MoI application log using the log method.
launchHelp		Launches the MoI help system by loading the main MoI help file page into the user's default web browser.
log		string toLog Logs toLog to the MoI log. The current contents of the log can be retrieved using the getLog method.
test		string test

Properties
Name	Type	Notes
numericValue	float	Specifies the current floating point value of the control, either as entered by the user or set by the application.

Enumeration Values
Name	Value
Unknown	0 The current state of the object is unknown.
Unattached	1 The object has not yet been added to the current scene. That is, it has been created but not yet added to the scene.
InDatabase	2 The object is part of the current scene.
Deleted	3 The object has been deleted from the current scene.

Properties
Name	Type	Notes
length	int	read only Specifies the number of elements currently in the list.
numBReps	int	read only Specifies the number of BRep objects currently in the list.
numConstructionLines	int	read only Specifies the number of ConstructionLine objects currently in the list.
numCurves	int	read only Specifies the number of Curve objects currently in the list.
numEdges	int	read only Specifies the number of edge objects currently in the list.
numFaces	int	read only Specifies the number of Face objects currently in the list.
numOpenBReps	int	read only Specifies the number of open BRep objects currently in the list.
numPoints	int	read only Specifies the number of PointObject objects currently in the list.
numSingleFaceBReps	int	read only Specifies the number of BRep objects with a single face currently in the list.
numSolids	int	read only Specifies the number of solid objects currently in the list.
numStandaloneCurves	int	read only Specifies the number of stand-alone Curve objects currently in the list.
numTopLevelObjects	int	read only Specifies the number of top-level objects currently in the list. A top-level object is an object the user can directly select or manipulate in the user interface without having to first select a parent object.

Methods
Name	Result	Arguments
addObject		GeomObject obj Adds the geometric object specified by obj to the end of the list.
callMethod		string methodName
getBReps	ObjectList	Returns a new ObjectList containing only the BRep objects contained in the list.
getBoundingBox	BoundingBox	Returns the smallest BoundingBox containing all of the objects in the list.
getConstructionLines	ObjectList	Returns a new ObjectList containing only the ConstructionLine objects contained in the list.
getCurves	ObjectList	Returns a new ObjectList containing only the Curve objects contained in the list.
getEdges	ObjectList	Returns a new ObjectList containing only the edge objects contained in the list.
getFaces	ObjectList	Returns a new ObjectList containing only the Face objects contained in the list.
getHighAccuracyBoundingBox	BoundingBox	Returns the smallest BoundingBox containing all of the objects in the list. This is similar to the result returned by the getBoundingBox method, but returns a more accurate resul which may take longer to compute. Use it instead of getBoundingBox in cases where accuracy matters more than speed.
getOpenBReps	ObjectList	Returns a new ObjectList containing only the open BRep objects contained in the list.
getPoints	ObjectList	Returns a new ObjectList containing only the PointObject objects contained in the list.
getSingleFaceBReps	ObjectList	Returns a new ObjectList containing only the BRep objects with a single face contained in the list.
getSolids	ObjectList	Returns a new ObjectList containing only the solid objects contained in the list.
getStandaloneCurves	ObjectList	Returns a new ObjectList containing only the stand-alone Curve objects contained in the list.
getTopLevelObjects	ObjectList	Returns a new ObjectList containing only the top-level objects contained in the list. A top-level object is an object the user can directly select or manipulate in the user interface without having to first select a parent object.
invertProperty		string propName
item	GeomObject	int index Returns the index element of the list. The elements of the list are numbered from 0 to (list.length - 1). If index is not in this range, an exception is generated.
lockSelection		Locks the selection status of all geometric objects in the list. That is, if an object in the list is unselected at the time this method is called, it cannot be selected after the call. And vice versa, if an object in the list is selected at the time this method is called, it cannot be unselected. The selection lock can be released using the unlockSelection method.
removeObject		GeomObject obj Removes the geometric object specified by obj from the list.
removeObjectAt		int index Removes the index element of the list from the list. An exception is generated if the specified index is not in the range from 0 to (list.length - 1).
setProperty		string propName, any pvarValue
sortBySelectionOrder		Sorts the items in the list by the order in which they were selected, with the first item in the list being the first one selected, and so on.
unlockSelection		Unlocks the selection status of all geometric items in the list. Refer to the lockSelection method for a description of what lock selection means.

Properties
Name	Type	Notes
finishOnPick	boolean	Specified whether picking is finished as soon as an object is picked. If true, then the object picker is finished as soon as an object is picked. If false, the object picker is not finished until the user explicitly finishes object picking (e.g. by pressing the Enter key).
max	int	Specifies the maximum number of objects that can be picked.
min	int	Specifies the minimum number of objects that can be picked.
objects	ObjectList	read only Specifies an ObjectList object containing the list of all objects that have been picked.

Methods
Name	Result	Arguments
allowBReps		Allow BRep (i.e. Boundary Representation) objects to be picked.
allowCurves		Allow Curve objects to be picked.
allowEdgeCurves		Allow CurveSegment objects to be picked.
allowEditPoints		Allow object control points to be picked.
allowFaces		Allow Face objects to be picked.
allowPointObjects		Allow PointObject objects to be picked.
allowStandaloneCurves		Allow stand-alone Curve objects to be picked.
allowTopLevelObjects		Allow top-level objects to be picked.
disableWindowing		Disables selecting objects in the editing viewports by dragging a selection window rectangle around them.
done	boolean	Terminates the object picking operation and returns whether or not the object picking session was successful. If return value of true indicates that at least the minimum number of objects specified was picked. A return value of false indicates that fewer than the minimum number of objects specified was picked.
resetAllow		Resets the set of object types that can be picked back to the empty set.

Enumeration Values
Name	Value
None	0
Origin	1 Snap to the world space origin at (0,0,0).
Axis	2 snap to a point on one of the world axes.
End	3 Snap to one of the end points of a line, curve or circular arc.
Mid	4 Snap to the mid-point of a line or circular arc.
Cen	5 Snap to the center of a circle, ellipse or circular arc.
Int	6 Snap to the intersection point of two lines or curves.
StraightSnapInt	7 Snap to a straight line passing through a base point.
SelfInt	8
CPlaneInt	9
Quad	10 Snap to one of the quadrant points of a circle, ellipse or circular arc.
Pt	11
PtOnObject	12
On	13 Snap to a point on a curve.
OnSrf	14 Snap to a point on the surface of a solid object.
Perp	15 Snap to a point perpendicular to a line, circle, ellipse, circular arc or curve.
Tan	16 Snap to a point tangential to a circle, ellipse, circular arc or curve.
PerpPerp	17
TanTan	18
Div	19 Snap to one of the division points specified for a construction line.

Properties
Name	Type	Notes
color	int	Specifies the color associated with the object style. The value is an integer of the form: 0xRRGGBB, where RR specifies the red channel value, GG specifies the green channel value, and BB specifies the blue channel value. Any geometric objects assigned the style will also use the color when drawn on the screen and when exported to any file format that supports material definitions.
hexcolor	string	read only Specifies the current color associated with the object style as a hexadecimal string of the form: #RRGGBB, where RR specifies the red channel value, GG specifies the green channel value, and BB specifies the blue channel value.
index	int	read only Specifies the 0-based index of the object style within the application's Styles list.
name	string	Specifies the name associated with the object style. The name appears in the application's Styles list as part of the style's description. It is also used as the material name for any geometric objects assigned that style when they are exported to a file format which supports named material styles.

Methods
Name	Result	Arguments
moveDown		Attempts to move the object style down one slot in the application's Styles list. It performs no action if the object style is already the bottommost style in the list.
moveUp		Attempts to move the object style up one slot in the application's Styles list. It performs no action if the object style is already the topmost style in the list.
remove		Removes the object style from the application's Styles list.

Properties
Name	Type	Notes
isOnCurve	boolean	read only Specifies whether the PickedPoint os on a curve. If true, the point is on a curve. If false, the point is not on a curve.
object	GeomObject	read only Specifies a geometric object the PickedPoint is associated with. The value is null if the snapping condition does not involve a geometric object.
otherObject	GeomObject	read only Specifies another geometric object the PickedPoint is associated with, for snapping conditions involving more than a single object. The value is null if two objects are not involved.
otherParameter	float	read only Specifies another numeric value describing some aspect of the snapping condition. Like the parameter property, the interpretation of the value depends upon the snapping condition. For example, in the case of an intersection snapping condition, it represents the distance from the starting point to the point of intersection.
parameter	float	read only Specifies a numeric value describing some aspect of the snapping condition. The interpretation of the value depends upon the snapping condition. For example, in some cases the value is a number between 0.0 and 1.0 specifying the fractional distance of the snapping point along the curve when traveling from the curve's start to end point.
pt	Point	read only Specifies a Point object containing the snapping point.
screenDist	float	read only
type	ObjectSnapEnum	read only Specifies the ObjectSnapEnum enumeration value that describes the snapping condition satisfied.
typeString	string	read only Specifies a text string describing the snapping condition satisfied.

Properties
Name	Type	Notes
numOsnaps	int	read only Specifies the number of object snap conditions the picked point satisfies.
screenX	float	read only Specifies the x coordinate in screen space of the picked point.
screenY	float	read only Specifies the y coordinate in screen space of the picked point.
viewport	Viewport	read only Specifies the Viewport object that the point was picked in.

Methods
Name	Result	Arguments
osnap	Osnap	int index Returns one of the Osnap conditions that the picked point satisfies. The particular Osnap condition to return is specified by index, which must be in the range from 0 to numOsnaps - 1.

Properties
Name	Type	Notes
x	float	The x coordinate of the Point.
y	float	The y coordinate of the Point.
z	float	The z coordinate of the Point.

Methods
Name	Result	Arguments
add		Point pointToAdd Adds the x coordinate of pointToAdd to the x coordinate of this Point, adds the y coordinate of pointToAdd to the y coordinate of this Point, and adds the z coordinate of pointToAdd to the z coordinate of this Point. The results replace the current x, y and z coordinates of this Point.
get		float x, float y, float z
scale		float factor Multiplies the x, y and z coordinates of this Point by the specified scale factor. The results replace the current values for the x, y and z coordinate of this Point.
set		float newX, float newY, float newZ Sets the x, y and z coordinates of this Point to the new values specified by newX, newY and newZ.
toString	string	int numDecimals = -1 Returns the result of converting the Point to a string of the form: (x,y,z) using the number of decimal places specified by numDecimals. If numDecimals is omitted or -1, the default number of decimal places is used.

Properties
Name	Type	Notes
x	float	The x coordinate of the Point2D.
y	float	The y coordinate of the Point2D.

Methods
Name	Result	Arguments
add		Point2D pointToAdd Adds the x coordinate of pointToAdd to the x coordinate of this Point2D, and adds the y coordinate of pointToAdd to the y coordinate of this Point2D. The results replace the current x and y coordinates of this Point2D.
get		float x, float y
scale		float factor Multiplies the x and y coordinates of this Point2D by the specified scale factor. The results replace the current values for the x and y coordinate of this Point2D.
set		float newX, float newY Sets the x and y coordinates of this Point2D to the new values specified by newX and newY.
toString	string	int numDecimals = -1 Returns the result of converting the Point to a string of the form: (x,y) using the number of decimal places specified by numDecimals. If numDecimals is omitted or -1, the default number of decimal places is used.

Properties
Name	Type	Notes
pt	Point	read only Specifies the Point object used to represent the position of the point.

Properties
Name	Type	Notes
allowMidObjectSnap	boolean
altDown	boolean	read only Specifies whether or not the user is currently pressing the Alt key. If true, the user is pressing the Alt key. If false, they are not.
basept	PickedPoint	read only Specifies the PickedPoint object representing the current base point used for picking points. If no base point has been specified, the value is null. The base point is used for various types of snapping behavior, such as straight snapping, tangent snapping, and any other type of snapping which is based on two points (i.e. a base point and a snap target point).
controlDown	boolean	read only Specifies whether or not the user is currently pressing the Control key. If true, the user is pressing the Control key. If false, they are not.
cplane	CoordinateFrame	read only
disableBasePt	boolean	Specifies whether snapping behavior that depends upon a base point is enabled or not. If true, any snapping behavior that uses a base point is disabled. If false, base point snapping behavior is enabled.
disableObjectSnap	boolean	Specifies whether object snapping behavior is enabled or not. If true, object snapping behavior is disabled. If false, object snapping behavior is enabled.
disableSnapToBasePt	boolean	Specifies whether snapping to the base point is enabled or not. If true, snapping to the base point is disabled. If false, snapping to the base point is enabled.
disableStraightSnap	boolean
disableTanPerpObjectSnap	boolean
disableVerticalStraightSnap	boolean
enableOnObjectSnap	boolean
finishOnMouseDown	boolean
finishOnMouseUp	boolean
hasRelocatedBasePt	boolean	read only
inMouseDown	boolean	read only
inMouseUp	boolean	read only
onlyUseSnapFunc	boolean
orientedptframe	CoordinateFrame	read only
param	float	read only
pt	PickedPoint	read only Specifies a PickedPoint object representing the most recent point a user has interactively picked using the PointPicker object. If the user has not yet picked a point, the value is null.
ptframe	CoordinateFrame	read only
relocatedBasePt	Point	read only
resetOnMouseLeave	boolean
shiftDown	boolean	read only Specifies whether or not the user is currently pressing the Shift key. If true, the user is pressing the Shift key. If false, they are not.
stickToSurfacesMode	string

Methods
Name	Result	Arguments
addSnapFunc		object pdispFunc, string funcName = ""
addSnapPoint		Point point, string textLabel
addSnapPostFunc		object pdispFunc, string funcName = ""
addStraightSnapAngle		float angleInDegrees, string label
bindBasePt		object target Binds the point referenced by target to the PickingObject for use as the base point for various types of snapping behavior. Refer to the description of the basept property for more details. Note that this is different than the setBasePt method. The value for target should be a GeometryFactoryInput object, as returned by the getInput method of a GeometryFactory object, ands allows the PointPicker basePt value to be bound to the same Point object obtained from the GeometryFactory object.
bindFunc		object target, string funcName = ""
bindFuncPostUpdate		object target, string funcName = ""
bindResultCPlane		object target
bindResultFrame		object target
bindResultOrientation		object target
bindResultPt		object target
clearBasePt
clearBindings		Clears (i.e. removes) any bindings created by calling any of the bindBasePt, bindFunc, bindFuncPostUpdate, bindResultCPlane, bindResultFrame, bindResultOrientation or bindResultPt methods.
clearCurrentSnaps
clearSnapFuncPoint
clearSnapFuncs
clearSnapPoints
clearStraightSnapAngles
disableStraightSnapAngle		float angleInDegrees
reset		Resets the PointPicker object back to its initial state.
restrictToLinePtDir		Point basePt, Point dir, boolean projectAll Restrict the user to only selecting points along the line defined by startPt and the vector dir. If projectAll is true, the user can select any point along the infinite line that goes through startPt in the direction specified by dir. If projectAll is false, the user can only select points along the line segment between startPt and startPt + dir.
restrictToLinePtPt		Point startPt, Point endpt, boolean projectAll Restrict the user to only selecting points along the line defined by startPt and endPt. If projectAll is true, the user can select any point along the infinite line that goes through startPt and endPt. If projectAll is false, the user can only select points along the line segment between startPt and endPt.
restrictToObject		GeomObject obj Restrict the user to only selecting points on the geometric object specified by obj.
restrictToPlane		CoordinateFrame plane, boolean projectAll
restrictToPlaneThroughPt		Point point, boolean projectAll
setAngleConstraint		float angleDegrees
setBasePt		Point point Sets the current base point for the PointPicker to the Point specified by point. Refer to the basept property description for more information on how the base point is used.
setDistanceConstraint		float distance
setPt		Point point Sets the picked point to point.
setRadialIntersection		CoordinateFrame frame, Point point
setSnapFuncPoint		Point point, string textLabel
setX		float x
setY		float y
setZ		float z

Properties
Name	Type	Notes
numPoints	int	read only Specifies the number of points the user has generated by dragging the mouse or pen.

Methods
Name	Result	Arguments
bind		object pdispBind
clearBindings		Clears (i.e. removes) all bindings previously set up using the bind method.
getPoint	Point	int whichPoint Returns the Point object at index whichPoint within the user generated sequence of points. The value of whichPoint must be in the range from 0 to numPoints - 1.
getPoint2D	Point2D	int whichPoint Returns the Point2D object at index whichPoint within the user generated sequence of points. The value of whichPoint must be in the range from 0 to numPoints - 1.

Properties
Name	Type	Notes
pointValue	Point	Specifies the current Point value of the control, either as entered by the user or set by the application.

Properties
Name	Type	Notes
hasLength	boolean	read only Specifies whether or not the current selection has a displayable length value. If true, the selection has a displayable length. If false, it does not.
hasRadius	boolean	read only Specifies whether or not the current selection has a displayable radius value. If true, the selection has a displayable radius. If false, it does not.
highAccuracyBoundingBox	BoundingBox	read only Specifies a BoundingBox that encompasses all objects in the current selection. This value is more accurate than the value of quickBoundingBox, but takes longer to compute. Use it in cases where accuracy matters more than speed.
keepVisible	boolean	Specifies whether or not the properties panel should be visible all of the time, or only when a command is not active. If true, then the properties panel is visible all the time. If false, then the properties panel is only visible when a command is not currently in progress.
length	float	read only Specifies the length of the current selection in cases where the hasLength property is true.
name	string	read only Specifies the name assigned to all objects in the current selection (if any).
numSelectedObjects	int	read only Specifies the number of geometric objects in the current selection.
numSelectedPoints	int	read only Specifies the number of points in the current selection.
objectType	string	read only Specifies a string describing the current set of selected objects. If no objects are selected, the value is the empty string. For example, if a line is selected, the value is Curve. If a sphere is selected, the value is Solid. If both a line and a sphere are selected, the value is 2 Objects.
quickBoundingBox	BoundingBox	read only Specifies a BoundingBox that encompasses all objects in the current selection. This value may be less accurate the the value of highAccuracyBoundingBox, but is faster to compute. Use it in cases where speed is more important than accuracy.
radius	float	read only Specifies the radius of the current selection in cases where the hasRadius property is true.
show	boolean	read only
showMaintainProportions	boolean	read only
styleHexColor	string	read only Returns the style color assigned to all of the objects in the current selection as a hexadecimal string of the form: #RRGGBB in the case when the styleVaries property is false, #FFFFFF in the case when the styleVaries property is true and the selection is not empty, and #000000 in the case where no object is selected. RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
styleIndex	int	read only Specifies the index of the ObjectStyle object within the application's Styles list that is assigned to all objects in the current selection in the case when the styleVaries property is false, and 0 in the case when the styleVaries property is true or no objects are currently selected.
styleName	string	read only Specifies the name of the style used by all of the objects in the current selection in the case when the styleVaries property is false, Various styles in the when the styleVaries property is true, and Default style in the case where no objects are selected.
styleVaries	boolean	read only Specifies whether or not all objects in the current selection have the same style. If true, the objects do not all have the same style. If false, all of the selected objects have the same style.
useDiameter	boolean	Specifies whether to display the radius or diameter of objects having such a property. If true, the diameter of the object is used. If false, the radius of the object is used.

Methods
Name	Result	Arguments
editName		Displays a pop-up dialog that prompts the user to enter a name to assign to all of the currently selected objects.
editSize		string which, string newValue, boolean varUniform
editStyleIndex		int newIndex Assigns the ObjectStyle whose index in the application's Style list is specified by styleIndex as the style for all of the currently selected objects.
registerCallback		object updatePanelFunc Specifies a function, updatePanelFunc, that should be called whenever any changes to the contents of the object occur that should be reflected in the properties panel.

Methods
Name	Result	Arguments
bind		object pdispTarget, string targetProperty, object pdispSource, string sourceProperty, boolean twoWay

Properties
Name	Type	Notes
filter	string

Properties
Name	Type	Notes
igesJoinOnImport	boolean
lwoScaleToMeters	boolean
lwoVertexNormalsStyle	string
meshExportCombineSameNamedObjects	boolean
objExportOrientation	string
objExportScaleFactor	float
objExportWriteMaterialAssignments	boolean
objExportWriteMtlFile	boolean
stlExportFileType	string

Methods
Name	Result	Arguments
editIniFile
getIniPath	string
restoreDefaults		string whichGroup = ""

Properties
Name	Type	Notes
value	boolean

Properties
Name	Type	Notes
active	boolean

Properties
Name	Type	Notes
activeTab	string
previousActiveTab	string	read only

Properties
Name	Type	Notes
textid	string	Specifies the id to look up in the appropriate user locale language file. The text string associated with the id in the language file is displayed as the contents of the control.

Properties
Name	Type	Notes
decimalPoint	string	read only

Methods
Name	Result	Arguments
activateFlyout
activateInline
onInput		string text

Properties
Name	Type	Notes
browserPosition	string	Specifies the position of the Scene Browser within the MoI main application window. The possible values are: Inside: At the bottom of the main toolbar panel on the left or right. Adjacent: Adjacent to the main toolbar panel in its own separate area. Opposite: On the opposite side of the MoI main application window from the main toolbar panel.
commandDialog	CommandUIContainer	read only Specifies the currently active CommandUIContainer object, or null if no command is currently active.
commandUI	object	read only
fontName	string	Specifies the name of the font used by the MoI user interface.
fontSize	float	Specifies the size, in points, of the font used by the MoI user interface.
fractionalDisplayPrecision	int
language	string	Specifies the language used for text appearing in the MoI user interface. The possible values for this are: Dutch English French German Italian Spanish Specifying a value not in this list will have no effect on the user interface.
mainWindow	Window	read only Specifies the Window object for the main MoI application window.
maxNumRecentFiles	int	Specifies the maximum number of recently edited files that the MoI application will keep track of. The list of recently edited files can be obtained by calling the getRecentFiles method. If the number of edited files exceeds the value of this property, the least recently edited files are discarded from the list as necessary.
maximizeToFullScreen	boolean
numDecimalPlaces	int
propertiesPanel	object	read only Contains a reference to the PropertiesPanel object, which provides access to information about the properties of the currently selected geometric objects.
showBrowserPane	boolean	Specifies whether the Scene Browser panel is visible or not. If true, the Scene Browser is visible. If false, the Scene Browser is hidden, except if browserPosition is Inside, in which case the Scene Browser is always visible.
showTrailingZeros	boolean
showViewportDisplayTime	boolean	Specifies whether or not the time, in milliseconds, it takes to refresh the contents of an editing viewport should be displayed in the top-left hand corner of each editing viewport. If true, the viewport refresh time is displayed. If false, it is not.
sidePanePosition	string	Specifies on which side of the main MoI application window the panel containing all of the editing tools and status views should be displayed. The possible values are: Left Right Specifying a value not in this list will generate an exception.

Methods
Name	Result	Arguments
alert		string text, string title = ""
beginUIUpdate		Prevents display updates while changes are being made to the user interface. Call this method before beginning a series of changes to the user interface to prevent the user from seeing partial updates of the display. Once all user interface changes are complete, call the endUIUpdate method to allow the user interface to update and reflect all of the changes that were made.
bindPropertyChangeFunc		object object, string propName, object func
bindUIToInput		string uIElementId, string uIElementProperty, GeometryFactoryInput input
clearCommandUI
clearPickedPoints		Discards all points that have been picked using the currently active PointPicker object.
createBackgroundImageEditor	WaitableObject
createDialog	WaitableWindow	string url, string options = "", object parentWindow = NULL Creates a new application window or dialog and returns a WaitableWindow object representing the new window. The content of the new window or dialog is specified by url, which should be a URL referring to a file containing, or linking to, the HTML, CSS and Javascript code needed to implement the new window's functionality. The optional options string contains a comma separated list of additional window features to be applied when creating the window. The available features are: resizable: Allow the user to resize the window. defaultWidth:n: Make the default width of the window n pixels. defaultHeight:n: Make the default height of the window n pixels. The optional parentWindow argument specifies the parent window for the new window or dialog, and defaults to the main MoI application window.
createObjectPicker	ObjectPicker	Creates and returns a new ObjectPicker object, which can be used to allow the user to pick geometric objects in the current scene while in the process of executing a command. For example, an ObjectPicker object is used by the various boolean commands to allow the user to pick the geometric objects to be booleaned together.
createOrientationEditor	WaitableObject	ObjectList curves, GeometryFactory factory, int whichInput
createPointPicker	PointPicker	Creates and returns a new PointPicker object, which can be used to allow the user to pick geometry points while in the process of executing a command. For example, a PointPicker object is used by the Line command to allow the user to pick the two endpoints of the line being created.
createPointStreamPicker	PointStreamPicker	Creates and returns a new PointStreamPicker object, which can be used to allow the user to generate a sequence (i.e. a stream) of points while dragging the mouse in the process of executing a command. For example, a PointStreamPicker object is used by the SketchCurve command to allow the user to generate a stream of points along the path the user traces out with the mouse or tablet pen.
endUIUpdate		Enables updates to the user interface and causes the user interface to be refreshed if any changes were made while user interface updates were disabled. This method is used in conjunction with the beginUIUpdate method to prevent partial updates to the display from occuring while a series of user interface changes are being performed.
fireUIEvent		string event
formatCoordinate	string	float coordinate, int precision = -1 Returns a string containing the specified coordinate value formatted to the number of decimal places specified by precision. If precision is omitted or -1, formatting is done using the default value of two decimal places.
formatFeetInches	string	float coordinate, int fractionalPrecision = -1 Returns a string containing the specified coordinate value formatted in feet and inches (e.g. 6' 8"). The precision of the result in terms of fractions of an inch is controlled by the value of fractionalPrecision, which defines the largest denominator that can be used in the fractional part expressed as a power of 2. For example, a value of 4 for fractionalPrecision means that the largest fractional denominator that could be used is 1/16", since 2^4 = 16. If fractionalPrecision is omitted or -1, then default formatting is used, which includes no fractional inches, but adds a trailing ? character if the specified coordinate is not an exact multiple of an inch.
formatNumber	string	float number, int numDecimalPlaces = -1 Returns a string containing the specified number value formatted to the number of decimal places specified by numDecimalPlaces. If numDecimalPlaces is omitted or -1, formatting is done using the default value of two decimal places.
getActivePointPicker	PointPicker	Returns the currently active PointPicker object, or null if no PointPicker is currently active.
getActiveViewport	Viewport	Returns the Viewport object for the currently active editing viewport. The active viewport is either: The editing viewport the mouse cursor is in The last editing viewport the user clicked in if the mouse cursor is not currently in an editing viewport.
getAvailableLanguages	List	Returns a List object containing the list of languages currently supported by the MoI user interface. The items in the list are the names of the supported languages (e.g. Dutch).
getLastClickedViewport	Viewport	Returns the Viewport object for the editing viewport the user last clicked in.
getLastPickedPoint	Point
getRecentFiles	object
getText	string	string id Returns the translation of the user interface string identified by id using the current language translation file, or the empty string if no match for id is found in the file.
getUIPanel	object	string panelUrl
getUIPanels	List
getViewportUnderMouse	Viewport	Returns the Viewport object for the editing viewport the mouse cursor is currently in. If the mouse cursor is not inside an editing viewport, null is returned.
hideUI		string idToHide Hides the HTML user interface element specified by idToHide, which should be the value of an id attribute for some HTML tag currently visible in the user interface. For example, the HTML content: ... could be hidden by calling moi.ui.hideUI("myView").
loadCommandUI		string url
redrawViewports		Forces the contents of all editing viewports to be redrawn immediately.
reloadPanels
removeLastPickedPoint
resetVisualStyles
showMenu	WaitableWindow	string url, object parentElement, int launchSide, int launchDir
showUI		string idToShow Shows the HTML user interface element specified by idToShow, which should be the value of an id attribute for some HTML tag currently hidden in the user interface. For example, the HTML content: ... could be made visible by calling moi.ui.showUI("myView").
updateBrowser

Properties
Name	Type	Notes
disabled	boolean	Specifies whether the control is enabled or disabled. If true, the control is disabled. If false, the control is enabled.

Methods
Name	Result	Arguments
bind		object pdispTarget, string targetProperty, object pdispSource, string sourceProperty, boolean twoWay
getControl	object
getMoi	Moi	Returns the top-level Moi object, which provides access to all of the other MoI application objects.
registerEvents

Properties
Name	Type	Notes
value	any

Properties
Name	Type	Notes
value	any

Properties
Name	Type	Notes
integerValue	int	Specifies the current unsigned integer value of the control, either as entered by the user or set by the application.

Methods
Name	Result	Arguments
add	object	object pointA, object pointB Returns a new Point object containing the vector sum of the two Point objects pointA and pointB.
average	object	object pointA, object pointB Returns a new Point object containing the vector average of the two Point objects pointA and pointB.
createBoundingBox	BoundingBox
createFrame	CoordinateFrame	Point origin = NULL, Point xAxis = NULL, Point yAxis = NULL Creates and returns a new CoordinateFrame object whose origin is at origin, whose x axis is defined by xAxis, and whose yAxis is defined by yAxis. If origin, xAxis and yAxis are omitted, it defaults to creating a copy of the world space coordinate system.
createFrontFrame	CoordinateFrame	Creates and returns a CoordinateFrame object equivalent to the world coordinate system as seen from the Front editing viewport. That is, with the positive x and z axes pointing to the right and up, respectively, and the y axis pointing out of the screen.
createPoint	Point	float x = 0.0, float y = 0.0, float z = 0.0 Creates and returns a new Point object whose coordinates are specified by x, y and z. If any of the x, y and z values are omitted, they default to 0.
createRightFrame	CoordinateFrame	Creates and returns a CoordinateFrame object equivalent to the world coordinate system as seen from the Right editing viewport. That is, with the positive y and z axes pointing to the right and up, respectively, and the x axis pointing out of the screen.
createTopFrame	CoordinateFrame	Creates and returns a CoordinateFrame object equivalent to the world coordinate system as seen from the Top editing viewport. That is, with the positive x and y axes pointing to the right and up, respectively, and the z axis pointing out of the screen.
distance	float	object pointA, object pointB Returns the distance between the two Point objects specified by pointA and pointB.
pointsAreEqual	boolean	object pointA, object pointB Returns true if pointA and pointB represent the same point in space. Returns false is the points are not the same.
pointsWithinTolerance	boolean	object pointA, object pointB Returns true if pointA and pointB represent almost the same point in space as specified by the current system defined tolerance. Returns false if they are farther apart than the system defined tolerance value.

Properties
Name	Type	Notes
allowRotationTilt3dx	boolean
axisLabels	string
backgroundImageDrawOrder	string	Specifies how background images should be drawn in the editing viewports relative to the scene objects. The possible values are: Below objects: Background images appear below all scene objects. With objects: Background images appear as if they were scene objects. Above objects: Background images appear above all scene objects.
backgroundImageShowIn	string	Specifies which editing viewports background images should be displayed in. The possible values are: All views Ortho only
backgroundImageTransparency	int	Specifies the amount of transparency to apply to each background image shown in the editing viewports. Values range from 0 (totally opaque) to 100 (totally transparent).
customFillLightLevel	float
customKeyLightLevel	float
edgeColorMode	string
edgeFixedColor	int
fixedLightPositions	boolean
hiddenLineOpacity	int	Specifies the opacity, or alpha value, used when drawing hidden lines in the editing viewports. The range of values is from 0 (totally transparent) to 255 (totally opaque).
hiddenLineStyle	string	Specifies the line style used to draw hidden lines in the editing viewports. The possible values are: Solid Dashed Long Dashed
lightDirection	Point	Specifies a Point representing the direction vector of the light used to illuminate the editing viewports.
lightingStyle	string
lineWidth	float	Specifies the line width, in pixels, used to draw both visible and hidden lines in the editing viewports.
linkOrthoViews	boolean	Specifies whether or not the panning and zooming of the different orthographic views are linked together. If true, then the orthographic views are linked together. If false, they are not. When the orthographic views are linked together, then the contents of the views are synchronized, and panning or zooming in one view will immediately be reflected in the other. When the views are not linked together, then each view may be panned and zoomed independently of the others.
lockedObjectsColor	int	Specifies the color used to draw the edges of locked objects in the editing viewports. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
lockedObjectsUseAlternateColor	boolean	Specifies whether locked objects use the lockObjectsColor for drawing their edges or not. If true, then locked objects draw their edges using the lockObjectsColor. If false, then locked objects draw their edges using the same color they would use when not locked.
meshAngle	float
meshDetailedInflections	boolean
metallicLighting	boolean
panButtonSensitivity	float	Specifies the sensitivity of the editing viewport pan button. The value is a multiplicative factor, with 1.0 being the normal default value. Values between 0.0 and less than 1.0 will pan slower than the default, while values greater than 1.0 will pan faster. Negative values are also allowed, which reverse the normal panning direction as well as affect the panning speed.
panSpeed3dx	float
reversePan3dx	boolean	Specifies whether or not the direction a 3DConnexion device pans in should be the reverse of the normal direction. If true, the normal panning direction is reversed. If false, the normal panning direction is used.
reversePanButton	boolean	Specifies whether or not the direction the editing viewport pan button moves in should be the reverse of the normal direction. If true, the normal panning direction is reversed. If false, the normal panning direction is used.
reverseRotateButton	boolean	Specifies whether or not the direction the editing viewport rotate button rotates in should be the reverse of the normal direction. If true, the normal rotation directions are reversed. If false, the normal rotation directions are used.
reverseRotateMouse	boolean	Specifies whether or not the direction the mouse drag button rotates in should be the reverse of the normal direction. If true, the normal rotation directions are reversed. If false, the normal rotation directions are used.
reverseRotation3dx	boolean	Specifies whether or not the direction a 3DConnexion device rotates in should be the reverse of the normal direction. If true, the normal rotation directions are reversed. If false, the normal rotation directions are used.
reverseScrollWheel	boolean	Specifies whether or not the effect of the scroll wheel should be reversed. If true, the effect of the scroll wheel is reversed. If false, the effect is normal.
reverseZoom3dx	boolean	Specifies whether or not the zooming direction of a 3DConnexion device is reversed. If true, the zooming direction of the 3DConnexion device is reversed. If false, the zooming direction is normal.
reverseZoomButton	boolean	Specifies whether or not the zooming direction of the editing viewport zoom button is reversed. If true, the zooming effect of the zoom button is reversed. If false, the zooming effect is normal.
rotateButtonSensitivity	float	Specifies the sensitivity of the editing viewport rotate button. The value is a multiplicative factor, with 1.0 being the normal default value. Values between 0.0 and less than 1.0 will rotate slower than the default, while values greater than 1.0 will rotate faster. Negative values are also allowed, which reverse the normal rotation direction as well as affect the rotation speed.
rotateMiddleButton	boolean	Specifies whther the middle mouse button is used for panning or rotating in the 3D view. If true, the middle mouse button rotates, and the right mouse button pans. If false, the middle mouse button pans, and the right mouse button rotates.
rotationSpeed3dx	float
rotationStyle	string	Specifies the style of rotation to use with the mouse or table pen. The possible values are:
shadeMode	string
showAxisIcon	boolean	Specifies whether the axis icon should be shown in the lower left hand corner of each editing viewport or not. If true, then the axis icon is shown. If false, then the axis icon is not shown. The axis icon shows the orientation of the x, y and z axes within the viewport.
showEditFrame	boolean	Specifies whether or not the scaling and rotation edit frame is drawn around the currently selected objects in the orthographic viewports. If true, the edit frame is displayed. If false, the edit frame is not displayed.
showHiddenLines	boolean	Specifies whether or not hidden lines are displayed in the editing viewports. If true, hidden lines are displayed in the editing viewports. If false, they are not.
showViewControls	boolean	Specifies whether or not the zoom, pan and rotate buttons should be displayed in each editing viewport. If true, the view controls are displayed. If false, the view controls are not displayed.
specularBrightness	float
specularFocusSize	float
specularHighlights	boolean
surfaceColorMode	string
surfaceFixedColor	int
swapPanZoom3dx	boolean
swapTwistTilt3dx	boolean
viewportBackgroundColor	int	Specifies the color used to draw the background of each editing viewport. The color is an integer of the form: 0xRRGGBB, where RR is the red channel value, GG is the green channel value, and BB is the blue channel value.
zoomButtonSensitivity	float	Specifies the sensitivity of the editing viewport zoom button. The value is a multiplicative factor, with 1.0 being the normal default value. Values between 0.0 and less than 1.0 will zoom slower than the default, while values greater than 1.0 will zoom faster. Negative values are also allowed, which reverse the normal zoom direction as well as affect the zoom speed.
zoomSpeed3dx	float

Methods
Name	Result	Arguments
getBackgroundImages	List	Returns a List object containing all current background images.
getCPlane	CoordinateFrame	Returns the CoordinateFrame object representing the current construction plane being used.
resetAll
resetCPlane		Resets the construction plane back to the system default, with the origin at the world space origin, and the x and y axes lined up with the world space x and y axes.
screenshot	Image	string area, boolean includeCursor Creates and returns an Image object containing a screen shot of the editing viewport specified by area. The possible values for area are: 3d top front right If the value of includeCursor is true, then the mouse cursor is included in the screen shot. If it is false, it is not.
setCPlane		CoordinateFrame frame, boolean applyToAllViews = -1, boolean orientOrthoViews = -1 Sets the current construction plane to the CoordinateFrame specified by frame. If applyToAllViews is true, the new construction plane affects all editing viewports. If false, only the 3D viewport is affected. If applyToAllViews is true, then the value of orientOrthoViews specifies how the new construction plane affects the orthographic editing viewports. If orientOrthoViews is true, then each of the orthographic viewports aligns its axes with the corresponding axes of the new construction plane. If false, the orthographic viewports remain oriented to the world space axes, but the origin of each viewport is modified to match the origin of the new construction plane.
setCPlaneInteractive		Allows the user to interactively set the origin and axes orientation for the construction plane in the editing viewports.

Properties
Name	Type	Notes
hideViewControls	boolean
mode	string	Specifies the current mode of the view panel. The possible values are: split 3d top front right The values corresponds to the display modes set by the view mode buttons on the MoI tool bar.

Methods
Name	Result	Arguments
getViewport	Viewport	string viewportName Return the Viewport object for corresponding to the specified viewportName. The legal values for viewportName are: 3d top bottom front bottom right left Note that top and bottom refer to the same viewport. The same is true for front, back and right, left.
reverseView		string view Reverses the view direction for the specified view. For example, if view is top, the view for the top/bottom viewport will switch to bottom if it was top, or to top if it was bottom. The legal values for view are: top bottom front back right left Note that top and bottom refer to the same viewport, and not to the current view direction of that viewport. The same is true for front, back and right, left.
setSize		int width, int height Sets the size of the view panel to the dimensions specified by width and height.

Methods
Name	Result	Arguments
load		string url

Properties
Name	Type	Notes
cameraFrame	CoordinateFrame	read only Specifies the CoordinateFrame object defining the position and orientation of the camera for the viewport.
cameraPt	Point	Specifies the position of the camera for the viewport.
cplane	CoordinateFrame	Specifies the CoordinateFrame object defining the construction plane for the viewport.
is3DView	boolean	read only Specifies whether the viewport is a 3D or 2D view. If true, the viewport displays a 3D view of the scene. If false, the viewport displays a 2D orthographic view of the scene.
leftRightAngle	float
name	string	read only Specifies the name of this viewport. The possible values are: 3D Top Front Right
projection	string	Specifies the type of projection used by the viewport. The possible values are: Perspective Parallel Note that setting a value of Perspective on a 2D viewport will have no effect. However, the 3D viewport can be changed between a Parallel and Perspective projection.
targetFrame	CoordinateFrame	read only Specified the CoordinateFrame object at which viewport camera is aimed.
targetPt	Point	Specifies the Point at which the viewport camera is pointed.
tiltAngle	float
upDownAngle	float
viewPanel	ViewPanel	read only Specifies the ViewPanel this viewport is part of.

Methods
Name	Result	Arguments
interactiveViewChange		string type
pan		float rightLeft, float upDown, float backwardsForwards = 0.0 Pans the viewport camera in the amount specified by rightLeft, upDown and backwardsForwards. As you might expect, the backwardsForwards amount only applies to viewports using a Perspective projection.
renderToClipboard		int width, int height Renders the contents of the viewport as an image to the system clipboard. The size of the rendered image is specified by width and height. If width and height do not match the aspect ratio of the viewport, the rendered image will be clipped.
reset		Resets the viewport camera and target back to their default positions.
rotate		string direction, float angleDegrees = 0.0 Rotates the viewport camera toward direction by the number of degrees specified by angleDegrees. The possible values for direction are: left right up down
setAngles		float upDownAngleDegrees = 0.0, float leftRightAngleDegrees = 0.0, float tiltAngleDegrees = 0.0
setCameraAndTarget		Point newCamera, Point newTarget Sets a new position newCamera for the viewport camera, and a new position newTarget at which it is aimed.
zoom		float zoomFactor Zooms the contents of the viewport by the amount specified by zoomFactor. Note that a zoomFactor of 1.0 has no effect, while values less than 1.0 zoom into the view, and values greater than 1.0 zoom out from the view.

Properties
Name	Type	Notes
cancelReason	string	read only Specifies the reason why a command was cancelled. This value is available after a call to the waitForEvent method returns false.
event	string	read only Specifies the type of event that caused the most recent call to the waitForEvent method to return. This value is available after a call to waitForEvent returns true. The possible values are: done: The user has indicated that the operation or request is done. finished: The operation or request is finished. Other values can also be returned that depend upon the user interface environment in which the object is running. These events can be: Shortcut keys defined for the command. Control ids for user interface elements such as buttons or checkboxes.

Methods
Name	Result	Arguments
allowNestedCancel		boolean newAllow = -1
cancel
waitForEvent	boolean	Suspends the caller until some type of event occurs. A true result indicates that a valid event occurred. In this case, the event property contains the type of event that occurred. A false result indicates that the operation was cancelled. In this case, the cancelReason property contains the reason the operation was cancelled.

Properties
Name	Type	Notes
htmlDocument	object	read only
htmlWindow	object	read only
window	Window	read only

Properties
Name	Type	Notes
dialogReturnValue	any	read only Specifies the value returned as the result of the dialog when the endDialog method was called.
isClosed	boolean	read only Specifies whether or not the window has been closed. If true, then the window has been closed. If false, the window is still open.
isMaximized	boolean	read only Specifies whether or not the window is in the maximized state. If true, the window is currently maximized. If false, the window is not maximized.
isMinimized	boolean	read only Specifies whether or not the window is in the minimized state. If true, the window is currently minimized. If false, the window is not minimized.
isRestored	boolean	read only Specifies whether or not the window is in the restored state. If true, the window is restored (i.e. neither in the minimized or maximized state). If false, the window is not in the restored state.
viewpanel	ViewPanel

Methods
Name	Result	Arguments
canChangeMaximizedSize	boolean
close		Closes the window. If the contentChanged method has been called on the window previously, the user will prompted if they want to save the contents of the window before closing it, and will be given the opportunity to cancel the close request.
contentChanged		Marks the contents of the window as having been modified. If the user attempts to close the window, or the close method is called, the user will be prompted if they want to save the contents of the window before closing it.
doModal	any	Makes the window into a modal dialog and suspends the caller until the dialog has completed. The result returned is the value passed as the argument to the doModal method used to terminate the dialog.
endDialog		any varDialogReturnValue Terminates a modal dialog window and specifies varDialogReturnValue as the result to be returned by the doModal method used to start the modal dialog.
maximize		Maximizes the window to full screen. If the window is already maximized, the method has no effect.
minimize		Minimizes the window to the system task bar. If the window is already minimized, the method has no effect.
restore		Restores the original size and position of the window from the minimized or maximized state. If the window is already in the restored state, the method has no effect.

Inputs
Index	Name	Type
0	Is corner	boolean

Inputs
Index	Name	Type
0	Objects	ObjectList
1	Alignment pt	CoordinateFrame
2	Align mode	string