The SchematicView MixinInterface is returned by the getView() method and the .current property in the SchematicViews Interface and provides access to properties and methods of a specific existing Schematic View.
Interface: SchematicView EXAMPLE
SchematicViews.open "My Schematic View" --> True sv = schematicviews.current --> <MixinInterface:SchematicView> sv.syncSelection --> True sv.syncSelection = False --> False
Properties:
<MixinInterface:SchematicView>.syncSelection : boolean : Read|Write Get/Set the Sync. Selection option state.
<MixinInterface:SchematicView>.alwaysArrange : boolean : Read|Write Get/Set the state of the Always Arrange option switch.
<MixinInterface:SchematicView>.showGrid : boolean : Read|Write Get/Set the visibility of the Grid.
<MixinInterface:SchematicView>.gridSnap : boolean : Read|Write Get/Set the state of the Grid Snap option.
<MixinInterface:SchematicView>.gridSpacing : integer : Read|Write Get/Set the spacing of the Grid.
<MixinInterface:SchematicView>.showBackgroundImage : boolean : Read|Write Enable/Disable the display of the background image.
<MixinInterface:SchematicView>.backgroundImageLock : boolean : Read|Write Lock/Unlock the background image.
<MixinInterface:SchematicView>.syncSelectionType : enum : Read|Write
syncSelectionType enums: {#viewports|#everything} Get/Set the Sync Selection Type.
<MixinInterface:SchematicView>.arrangeMethod : enum : Read|Write
arrangeMethod enums: {#stacked|#horiz|#vert} Get/Set the Arrange Method Type.
<MixinInterface:SchematicView>.linkStyle : enum : Read|Write
linkStyle enums: {#bezier|#straight|#circuit|#none} Get/Set the Link Style.
<MixinInterface:SchematicView>.moveChildren : boolean : Read|Write Get/Set whether children are moved with the parent.
<MixinInterface:SchematicView>.doubleBuffer : boolean : Read|Write Controls the state of "Double Buffer " checkbox in the "Schematic View Preferences" dialog. When set to true (default), double-buffer technique will be used to redraw the Schematic View. When set to false, the display will flicker noticeably.
<MixinInterface:SchematicView>.panToNodes : boolean : Read|Write Controls the state of "Pan to Added Node " checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.useWireframeColor : boolean : Read|Write Controls the state of the "Use Wireframe Color" checkbox in the "Schematic View Preferences" dialog. When set to True, the wireframe color will be used to display the node in Schematic View.
<MixinInterface:SchematicView>.zoomMousePoint : boolean : Read|Write Controls the state of "Zoom About Mouse" checkbox in the "Schematic View Preferences" dialog. When set to true, the zoom is performed with the mouse point as center.
<MixinInterface:SchematicView>.layoutWarning : boolean : Read|Write Controls the state of the "Display Layout Warning" checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.updateOnFocus : boolean : Read|Write Controls the state of the "Only Updates on Focus" checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.showTooltips : boolean : Read|Write Controls the state of "Show Tooltips" checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.snapFloaters : boolean : Read|Write Controls the state of "Snap Floaters" checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.relativeFloaters : boolean : Read|Write Controls the state of "Relative Floaters" checkbox in the "Schematic View Preferences" dialog.
<MixinInterface:SchematicView>.showShrink : boolean : Read|Write Get/Set the Shrink mode. This value is also controlled by the Layout > Toggle Shrink option in the Schematic View menu.
Methods:
<string><MixinInterface:SchematicView>.getName() Returns the name of the Schematic View.
<void><MixinInterface:SchematicView>.setName <string>name Sets the name of the Schematic View to the specified string.
<integer><MixinInterface:SchematicView>.beginEdit() Begins edit, increases the internal edit counter by one and returns it as integer. This prevents Schematic View from traversing the scene and generating new Schematic View Nodes. This guarantees that locally stored Schematic View Node IDs remain valid.
<integer><MixinInterface:SchematicView>.endEdit() Ends edit, decreases the internal edit counter by one and returns it as integer. Failure to call endEdit() after the corresponding beginEdit() will prevent Schematic View from updating based on scene changes.
<void><MixinInterface:SchematicView>.updateView <boolean>fullTraverse Updates the Schematic View. When the parameter is set to true, the node hierarchy will be fully traversed.
<integer><MixinInterface:SchematicView>.getSVNodeID <value>anim Returns the Schematic View Node ID for the supplied sub-anim.
FOR EXAMPLE:
resetMaxFile #noPrompt --reset the max scene --> OK teapot () --create a new teapot --> $Teapot:Teapot001 @ [0.000000,0.000000,0.000000] SchematicViews.open "Pots" --open a new Schematic View --> True --yes, it worked! --Get the ID of the Teapot node SchematicViews.current.getSVNodeID $Teapot001 --> 0 --it is ID 0 --Get the ID of the Visibility track of the Teapot node SchematicViews.current.getSVNodeID $Teapot001[1] --> -1 --no such SV node, returns -1 --Now get the ID of the Transformation track of the Teapot SchematicViews.current.getSVNodeID $Teapot001[3] --> 1 --it is ID 1 --Get the ID of the Position track of the Teapot SchematicViews.current.getSVNodeID $Teapot001[3][1] --> 2 --it is ID 1 --Get the ID of the Object track of the Teapot SchematicViews.current.getSVNodeID $Teapot001[4] --> 11 --it is ID 1
<int by value array><MixinInterface:SchematicView>.getSVNodeIDTab <value>anim Returns the Schematic View Node ID Tab as an array of integers. If anim is an instanced object, the array of Schematic View Node IDs corresponds to the Node IDs for that instanced object.
<maxObject><MixinInterface:SchematicView>.getSVNodeAnim <integer>svNodeID Returns the sub-anim object corresponding to the specified Schematic View Node ID
FOR EXAMPLE:
resetMaxFile #noPrompt --reset the max scene --> OK teapot () --create a new teapot --> $Teapot:Teapot001 @ [0.000000,0.000000,0.000000] SchematicViews.open "Pots" --open a new Schematic View --> True --yes, it worked! --Get the object node of the Teapot by ID (see example above) SchematicViews.current.getSVNodeAnim 0 --> $Teapot:Teapot001 @ [0.000000,0.000000,0.000000] --Now get the sub-anim of the Transformation track of the Teapot SchematicViews.current.getSVNodeAnim 1 --> Controller:Position_Rotation_Scale --Get the sub-anim of the Position track of the Teapot SchematicViews.current.getSVNodeAnim 2 --> Controller:Position_XYZ --Get the sub-anim of the Object track of the Teapot SchematicViews.current.getSVNodeAnim 11 --> Teapot
<string><MixinInterface:SchematicView>.getSVNodeName <integer>svNodeID Returns the Schematic View Node Name by ID
FOR EXAMPLE:
resetMaxFile #noPrompt --> OK teapot() --> $Teapot:Teapot001 @ [0.000000,0.000000,0.000000] SchematicViews.open "Pots" --> True SchematicViews.current.getSVNodeName 0 --> "Teapot001" SchematicViews.current.getSVNodeName 1 --> "Position/Rotation/Scale (Transform)" SchematicViews.current.getSVNodeName 2 --> "Position XYZ (Position)" SchematicViews.current.getSVNodeName 11 --> "Teapot (Object)"
<integer><MixinInterface:SchematicView>.getNumSVNodes() Returns the number of Schematic View nodes as integer.
<boolean><MixinInterface:SchematicView>.selectSVNode <integer>svNodeID [selectChildren:<boolean>]
selectChildren default value: false Selects the node by ID. If the optional selectChildren: argument is set to true , the children of the node are also selected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.deselectSVNode <integer>svNodeID [selectChildren:<boolean>]
selectChildren: default value: false Deselects the node by ID. If the optional selectChildren is set to true , the children of the node are also deselected. Returns true on success, false otherwise.
<void><MixinInterface:SchematicView>.selectAll() Selects all nodes in the Schematic View.
<void><MixinInterface:SchematicView>.deselectAll() Deselects all nodes in the Schematic View.
<void><MixinInterface:SchematicView>.selectInvert() Inverts the current selection in the Schematic View.
<boolean><MixinInterface:SchematicView>.selectChildren [svNodeID:<integer>]
svNodeID: default value: -1 Selects the children of all selected nodes. If the optional svNodeId is supplied and is not -1, only children of the specified node will be selected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.deselectChildren svNodeID:<integer>
svNodeID: default value: -1 Deselects the children of all selected nodes. If the optional svNodeId is supplied and is not -1, only children of the specified node will be deselected. The parent itself will not be deselected. Returns true on success, false otherwise.
<void><MixinInterface:SchematicView>.selectToScene() Synchronizes the Schematic View selection to the Scene - Selects the scene nodes that are selected in Schematic View.
<void><MixinInterface:SchematicView>.selectFromScene() Synchronizes the Schematic View selection from the Scene - Selects the Schematic View nodes that are selected in the scene.
<int by value array><MixinInterface:SchematicView>.getSelectedSVNodes() Returns an array of svNodeID integers - one for each selected node.
<boolean><MixinInterface:SchematicView>.isSelected <integer>svNodeID Returns true if the node specified by ID is selected, false otherwise.
<integer><MixinInterface:SchematicView>.numChildren <integer>svNodeID Returns the number of children nodes in the node specified by ID.
<integer><MixinInterface:SchematicView>.getChildSVNodeID <integer>svNodeID <integer>childNum Returns the svNodeID of the Nth child of the node specified by ID.
<integer><MixinInterface:SchematicView>.numParents [svNodeID:<integer>]
svNodeID: default value: -1 Returns the number of parents. If the optional svNodeID is specified as in not -1, the number of parent nodes of the node specified by ID will be returned.
<integer><MixinInterface:SchematicView>.getParentSVNodeID <integer>svNodeID <integer>parentNum Returns the Nth parent's svNodeID of the child specified by ID.
<integer><MixinInterface:SchematicView>.getFocus() Returns the svNodeID of the node that is in focus.
<boolean><MixinInterface:SchematicView>.hidesvNodeID:<integer>
svNodeID: default value: -1 Hides all selected nodes and their children. If the optional svNodeID is supplied and is not -1, only the specified node and its children will be hidden.
<boolean><MixinInterface:SchematicView>.unHide <integer>svNodeID Unhides the node specified by ID. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.collapseSVNodes [svNodeID:<integer>]
svNodeID: default value: -1 Collapses all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<void><MixinInterface:SchematicView>.hideAll() Hides all Schematic View nodes.
<void><MixinInterface:SchematicView>.showAll() Unhides all Schematic View nodes.
<boolean><MixinInterface:SchematicView>.expandSVNodes [svNodeID:<integer>]
svNodeID: default value: -1 Expands all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.shrink [svNodeID:<integer>]
svNodeID: default value: -1 Shrinks all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.unShrink [svNodeID:<integer>]
svNodeID: default value: -1 Unshrinks all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<void><MixinInterface:SchematicView>.unShrinkAll() Expands all Schematic View nodes.
<boolean><MixinInterface:SchematicView>.arrangeSVNode [svNodeID:<integer>]
svNodeID: default value: -1 Arranges all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.arrangeChildren [svNodeID:<integer>]
svNodeID: default value: -1 Arranges the children of all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<boolean><MixinInterface:SchematicView>.freeSVNode [svNodeID:<integer>]
svNodeID: default value: -1 Frees all selected nodes. If the optional svNodeID is supplied and is not -1, only the node specified by ID will be affected. Returns true on success, false otherwise.
<void><MixinInterface:SchematicView>.freeAll() Frees all Schematic View nodes.
<void><MixinInterface:SchematicView>.zoomExtents() Zooms the Schematic View to fit all nodes.
<void><MixinInterface:SchematicView>.zoomSelectedExtents() Zoom the Schematic View to fit the selected nodes.
<void><MixinInterface:SchematicView>.panToSelected() Pans the Schematic View to the Selected Nodes without changing the Zoom factor.
<boolean><MixinInterface:SchematicView>.zoomToSVNode <integer>svNodeID Zooms the Schematic View to show the Schematic View Node specified by ID. Returns True on success.
<boolean><MixinInterface:SchematicView>.panToSVNode <integer>svNodeID Pans the Schematic View to show the Schematic View Node specified by ID. Returns True on success.
<filename><MixinInterface:SchematicView>.getBackgroundImageName() Returns the background image name as filename.
<void><MixinInterface:SchematicView>.setBackgroundImageName <filename>name Sets the background image name to the specified filename.
<void><MixinInterface:SchematicView>.addBookmark <string>name <void><MixinInterface:SchematicView>.nextBookmark() Goes to the next Bookmark.
<void><MixinInterface:SchematicView>.prevBookmark() Goes to the previous Bookmark.
<boolean><MixinInterface:SchematicView>.setSVNodePos <integer>svNodeID <boolean>children <point2>point Sets the position of the Schematic View Node specified by ID to the supplied Point2 value. If the children parameter is set to True , the Children of the specified node will be repositioned too. Returns True on success.
<point2><MixinInterface:SchematicView>.getSVNodePos <integer>svNodeID Returns the position of the Schematic View Node specified by ID as a Point2 value.
<boolean><MixinInterface:SchematicView>.translateSVNode <integer>svNodeID <boolean>children <point2>point Translates the Schematic View Node specified by ID with the supplied Point2 value. If the children parameter is set to True , the Children of the specified node will be repositioned too. Returns True on success.
<boolean><MixinInterface:SchematicView>.translateSelected <point2>point Translates the selected Schematic View Nodes by the supplied Point2 value.
<boolean><MixinInterface:SchematicView>.canAssignController svNodeID:<integer>
svNodeID: default value: -1 Returns True if a controller can be assigned to the Schematic View Node specified by ID.
<boolean><MixinInterface:SchematicView>.showAssignControllerDialog svNodeID:<integer>
svNodeID: default value: -1 Opens the Assign Controller Dialog for the Schematic View Node specified by ID. Returns True on success.
<boolean><MixinInterface:SchematicView>.deleteSelected() Deletes the selected Schematic View Nodes. Returns True on success.
<boolean><MixinInterface:SchematicView>.showProperties [svNodeID:<integer>]
svNodeID: default value: -1 Opens the Properties dialog for the Schematic View Node specified by ID. Returns True on success.
<float><MixinInterface:SchematicView>.getSVNodeWidth() Returns the width of the Schematic View nodes.
<float><MixinInterface:SchematicView>.getSVNodeHeight() Returns the height of the Schematic View nodes.
<boolean><MixinInterface:SchematicView>.testSVNodeState <integer>svNodeID <enum>state
state enums: {#selected | #visible | #displayed | #inode | #localRoot | #animated | #instanced | #shrink | #freeMove | #freeMoveParent | #inactive} Returns true if the node supplied by ID is in the specified state. #inactive tests for frozen or hidden nodes, #localRoot tests if the Schematic View Node is the root of a hierarchy (no parents), and #inode tests if the Schematic View Node is a Node object.
<maxObject><MixinInterface:SchematicView>.getSVNodeOwner <integer>svNodeID Returns the scene object owning the Schematic View node supplied by ID.
<integer><MixinInterface:SchematicView>.getSVNodeAnimID <integer>svNodeID Returns the sub-anim ID of the Schematic View node supplied by ID.
<void><MixinInterface:SchematicView>.doubleClickSVNode <integer>svNodeID Performs a double-click over the Schematic View node supplied by ID.
<integer><MixinInterface:SchematicView>.getNumOutputRelationships <integer>svNodeID Returns the number of output relationships of the Schematic View node supplied by ID.
<enum><MixinInterface:SchematicView>.getOutputRelationshipType <integer>svNodeID <integer>relIndex
getOutputRelationshipType enums: {#unknown | #paramwire | #constraint | #light | #modifier | #controller) Returns the type of the specified output relationship of the Schematic View node supplied by ID.
<integer><MixinInterface:SchematicView>.getOutputRelationshipSVNodeID <integer>svNodeID <integer>relIndex Returns the Schematic View node ID of the specified output relationship of the Schematic View node supplied by ID.
<integer><MixinInterface:SchematicView>.getNumInputRelationships <integer>svNodeID Returns the number of input relationships of the Schematic View node supplied by ID.
<enum><MixinInterface:SchematicView>.getInputRelationshipType <integer>svNodeID <integer>relIndex
getInputRelationshipType enums: {#unknown | #paramwire | #constraint | #light | #modifier | #controller) Returns the type of the specified input relationship of the Schematic View node supplied by ID.
<integer><MixinInterface:SchematicView>.getInputRelationshipSVNodeID <integer>svNodeID <integer>relIndex Returns the Schematic View node ID of the specified input relationship of the Schematic View node supplied by ID.
<boolean><MixinInterface:SchematicView>.canMakeSVNodeUnique <integer>svNodeID Returns true if the Schematic View node supplied by ID can be made unique.
<boolean><MixinInterface:SchematicView>.makeSVNodeUnique <integer>svNodeID Makes the Schematic View node supplied by ID unique, returns true on success.
<boolean><MixinInterface:SchematicView>.setShowRelationships <integer>svNodeID <boolean>show Controls the relationships display for the Schematic View node supplied by ID.
<boolean><MixinInterface:SchematicView>.getShowRelationships <integer>svNodeID Returns true if the relationships display for the Schematic View node supplied by ID is enabled, false otherwise.
<void><MixinInterface:SchematicView>.showPreferencesDialog() Opens the Preferences dialog.
<void><MixinInterface:SchematicView>.showDisplayFloater <boolean>show Opens/closes the Preferences dialog. When the supplied parameter is true , the dialog will be opened, when false , it will be closed.
<void><MixinInterface:SchematicView>.showRelationshipDialog <boolean>all Opens the Relationships dialog. When the supplied parameter is true , all relationships will be shown.
<void><MixinInterface:SchematicView>.showInstancesDialog <boolean>all Opens the Instances dialog. When the supplied parameter is true , all instances will be shown.
<void><MixinInterface:SchematicView>.showObjectOccurrenceDialog() Opens the Object Occurrence dialog.
<void><MixinInterface:SchematicView>.showListViewDialog <&integer array>svNodes [title:<string>] [id:<integer>]
svNodes is In and Out parameter
title: default value: undefined
id: default value: 1 Opens the ListView dialog displaying the nodes specified by an array of ID passed by reference. The ID parameter is useful for enabling menu items specific to your custom List View content.
<void><MixinInterface:SchematicView>.hideListViewDialog() Closes the ListView dialog.
<int by value array><MixinInterface:SchematicView>.getSelectedListViewSVNodes() Returns the nodes currently selected in the ListView dialog.
<enum><MixinInterface:SchematicView>.getListViewDialogType()
getListViewDialogType enums: {#unknown | #relationship | #instance | #occurrence | #userDefined) Returns the current type of the ListView dialog. #userDefined is returned for List Views created with the showListViewDialog method.
<integer><MixinInterface:SchematicView>.getListViewDialogID() Returns the ID of the ListView dialog as integer.
<string><MixinInterface:SchematicView>.getListViewDialogTitle() Returns the title of the ListView dialog as string.
<boolean><MixinInterface:SchematicView>.setMode <enum>mode
mode enums: {#select | #connect | #paramwire | #pan | #zoom | #zoomregion} Sets the current Schematic View mode. Returns True on success, False otherwise.
<enum><MixinInterface:SchematicView>.getMode()
getMode enums: {#select | #connect | #paramwire | #pan | #zoom | #zoomregion) Returns the current Schematic View mode.
<boolean><MixinInterface:SchematicView>.setLayoutMode <enum>mode
mode enums: {#reference | #hierarchy} Sets the current Schematic View layout.
<enum><MixinInterface:SchematicView>.getLayoutMode()
getLayoutMode enums: {#reference | #hierarchy) Returns the current Schematic View layout.
<boolean><MixinInterface:SchematicView>.setDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers} Sets the specified Display Floater Filter. Returns True on success, False otherwise.
<boolean><MixinInterface:SchematicView>.clearDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers} Clears the specified Display Floater Filter. Returns True on success, False otherwise.
<boolean><MixinInterface:SchematicView>.testDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers} Tests the state of the specified Display Floater Filter. Returns True if the Filter is set, False otherwise.
<boolean><MixinInterface:SchematicView>.setIncludeFilter <enum>filter
filter enums: {#baseObjects | #modifierStack | #materials | #controllers | #staticValues | #pointControllerContainers | #skinDetails | #selectedOnly | #visibleOnly | #animatedOnly | #geometryHide | #shapesHide | #lightsHide | #cameraHide | #helpersHide | #spacewarpsHide | #bonesHide} Sets the specified Display Floater Include Filter. Returns True on success, False otherwise.
Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint.
<boolean><MixinInterface:SchematicView>.clearIncludeFilter <enum>filter
filter enums: {#baseObjects | #modifierStack | #materials | #controllers | #staticValues | #pointControllerContainers | #skinDetails | #selectedOnly | #visibleOnly | #animatedOnly | #geometryHide | #shapesHide | #lightsHide | #cameraHide | #helpersHide | #spacewarpsHide | #bonesHide} Clears the specified Display Floater Include Filter. Returns True on success, False otherwise.
Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint.
<boolean><MixinInterface:SchematicView>.testIncludeFilter <enum>filter
filter enums: {#baseObjects | #modifierStack | #materials | #controllers | #staticValues | #pointControllerContainers | #skinDetails | #selectedOnly | #visibleOnly | #animatedOnly | #geometryHide | #shapesHide | #lightsHide | #cameraHide | #helpersHide | #spacewarpsHide | #bonesHide} Tests the state of the specified Display Floater Include Filter. Returns True if the Include Filter is set, False otherwise.
Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint.
<integer><MixinInterface:SchematicView>.getBaseSVNodeID <integer> Returns the SVNodeID of the base SVNode (the INode).
<integer><MixinInterface:SchematicView>.getRootSVNodeID <integer> Returns the SVNodeID of the local root for the SVNode.
<Point2><MixinInterface:SchematicView>.screenToSV <Point2> Converts a screen coordinate into schematic view coordinates.
<Array of Integers><MixinInterface:SchematicView>.getSVNodeIDByPoint <Point2> Will return an array of the graphnodes under the sv coordinate passed in as Point2.