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 -->
``` Properties: Get/Set the Sync. Selection option state. Get/Set the state of the Always Arrange option switch. Get/Set the visibility of the Grid. Get/Set the state of the Grid Snap option. Get/Set the spacing of the Grid. Enable/Disable the display of the background image. Lock/Unlock the background image. Get/Set the Sync Selection Type. Get/Set the Arrange Method Type. Get/Set the Link Style. Get/Set whether children are moved with the parent. 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. Controls the state of "Pan to Added Node " checkbox in the "Schematic View Preferences" dialog. 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. 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. Controls the state of the "Display Layout Warning" checkbox in the "Schematic View Preferences" dialog. Controls the state of the "Only Updates on Focus" checkbox in the "Schematic View Preferences" dialog. Controls the state of "Show Tooltips" checkbox in the "Schematic View Preferences" dialog. Controls the state of "Snap Floaters" checkbox in the "Schematic View Preferences" dialog. Controls the state of "Relative Floaters" checkbox in the "Schematic View Preferences" dialog. Get/Set the Shrink mode. This value is also controlled by the Layout > Toggle Shrink option in the Schematic View menu. Methods: Returns the name of the Schematic View. Sets the name of the Schematic View to the specified string. 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. 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. Updates the Schematic View. When the parameter is set to true, the node hierarchy will be fully traversed. 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 ``` 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. 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 ``` 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)" ``` Returns the number of Schematic View nodes as integer. 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. 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. Selects all nodes in the Schematic View. Deselects all nodes in the Schematic View. Inverts the current selection in the Schematic View. 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. 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. Synchronizes the Schematic View selection to the Scene - Selects the scene nodes that are selected in Schematic View. Synchronizes the Schematic View selection from the Scene - Selects the Schematic View nodes that are selected in the scene. Returns an array of svNodeID integers - one for each selected node. Returns true if the node specified by ID is selected, false otherwise. Returns the number of children nodes in the node specified by ID. Returns the svNodeID of the Nth child of the node specified by ID. 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. Returns the Nth parent's svNodeID of the child specified by ID. Returns the svNodeID of the node that is in focus. 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. Unhides the node specified by ID. Returns true on success, false otherwise. 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. Hides all Schematic View nodes. Unhides all Schematic View nodes. 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. 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. 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. Expands all Schematic View nodes. 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. 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. 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. Frees all Schematic View nodes. Zooms the Schematic View to fit all nodes. Zoom the Schematic View to fit the selected nodes. Pans the Schematic View to the Selected Nodes without changing the Zoom factor. Zooms the Schematic View to show the Schematic View Node specified by ID. Returns True on success. Pans the Schematic View to show the Schematic View Node specified by ID. Returns True on success. Returns the background image name as filename. Sets the background image name to the specified filename. Goes to the next Bookmark. Goes to the previous Bookmark. 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. Returns the position of the Schematic View Node specified by ID as a Point2 value. 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. Translates the selected Schematic View Nodes by the supplied Point2 value. Returns True if a controller can be assigned to the Schematic View Node specified by ID. Opens the Assign Controller Dialog for the Schematic View Node specified by ID. Returns True on success. Deletes the selected Schematic View Nodes. Returns True on success. Opens the Properties dialog for the Schematic View Node specified by ID. Returns True on success. Returns the width of the Schematic View nodes. Returns the height of the Schematic View nodes. 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. Returns the scene object owning the Schematic View node supplied by ID. Returns the sub-anim ID of the Schematic View node supplied by ID. Performs a double-click over the Schematic View node supplied by ID. Returns the number of output relationships of the Schematic View node supplied by ID. Returns the type of the specified output relationship of the Schematic View node supplied by ID. Returns the Schematic View node ID of the specified output relationship of the Schematic View node supplied by ID. Returns the number of input relationships of the Schematic View node supplied by ID. Returns the type of the specified input relationship of the Schematic View node supplied by ID. Returns the Schematic View node ID of the specified input relationship of the Schematic View node supplied by ID. Returns true if the Schematic View node supplied by ID can be made unique. Makes the Schematic View node supplied by ID unique, returns true on success. Controls the relationships display for the Schematic View node supplied by ID. Returns true if the relationships display for the Schematic View node supplied by ID is enabled, false otherwise. Opens the Preferences dialog. Opens/closes the Preferences dialog. When the supplied parameter is true , the dialog will be opened, when false , it will be closed. Opens the Relationships dialog. When the supplied parameter is true , all relationships will be shown. Opens the Instances dialog. When the supplied parameter is true , all instances will be shown. Opens the Object Occurrence dialog. 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. Closes the ListView dialog. Returns the nodes currently selected in the ListView dialog. Returns the current type of the ListView dialog. #userDefined is returned for List Views created with the showListViewDialog method. Returns the ID of the ListView dialog as integer. Returns the title of the ListView dialog as string. Sets the current Schematic View mode. Returns True on success, False otherwise. Returns the current Schematic View mode. Sets the current Schematic View layout. Returns the current Schematic View layout. Sets the specified Display Floater Filter. Returns True on success, False otherwise. Clears the specified Display Floater Filter. Returns True on success, False otherwise. Tests the state of the specified Display Floater Filter. Returns True if the Filter is set, False otherwise. Sets the specified Display Floater Include Filter. Returns True on success, False otherwise. Note: Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint. Clears the specified Display Floater Include Filter. Returns True on success, False otherwise. Note: Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint. Tests the state of the specified Display Floater Include Filter. Returns True if the Include Filter is set, False otherwise. Note: Prior to 3ds Max 2022 #pointControllerContainers was called #masterPoint. Returns the SVNodeID of the base SVNode (the INode). Returns the SVNodeID of the local root for the SVNode. Converts a screen coordinate into schematic view coordinates. Will return an array of the graphnodes under the sv coordinate passed in as Point2.<MixinInterface:SchematicView>.syncSelection : boolean : Read|Write
<MixinInterface:SchematicView>.alwaysArrange : boolean : Read|Write
<MixinInterface:SchematicView>.showGrid : boolean : Read|Write
<MixinInterface:SchematicView>.gridSnap : boolean : Read|Write
<MixinInterface:SchematicView>.gridSpacing : integer : Read|Write
<MixinInterface:SchematicView>.showBackgroundImage : boolean : Read|Write
<MixinInterface:SchematicView>.backgroundImageLock : boolean : Read|Write
<MixinInterface:SchematicView>.syncSelectionType : enum : Read|Write
syncSelectionType enums: {#viewports|#everything}
<MixinInterface:SchematicView>.arrangeMethod : enum : Read|Write
arrangeMethod enums: {#stacked|#horiz|#vert}
<MixinInterface:SchematicView>.linkStyle : enum : Read|Write
linkStyle enums: {#bezier|#straight|#circuit|#none}
<MixinInterface:SchematicView>.moveChildren : boolean : Read|Write
<MixinInterface:SchematicView>.doubleBuffer : boolean : Read|Write
<MixinInterface:SchematicView>.panToNodes : boolean : Read|Write
<MixinInterface:SchematicView>.useWireframeColor : boolean : Read|Write
<MixinInterface:SchematicView>.zoomMousePoint : boolean : Read|Write
<MixinInterface:SchematicView>.layoutWarning : boolean : Read|Write
<MixinInterface:SchematicView>.updateOnFocus : boolean : Read|Write
<MixinInterface:SchematicView>.showTooltips : boolean : Read|Write
<MixinInterface:SchematicView>.snapFloaters : boolean : Read|Write
<MixinInterface:SchematicView>.relativeFloaters : boolean : Read|Write
<MixinInterface:SchematicView>.showShrink : boolean : Read|Write
<string><MixinInterface:SchematicView>.getName()
<void><MixinInterface:SchematicView>.setName <string>name
<integer><MixinInterface:SchematicView>.beginEdit()
<integer><MixinInterface:SchematicView>.endEdit()
<void><MixinInterface:SchematicView>.updateView <boolean>fullTraverse
<integer><MixinInterface:SchematicView>.getSVNodeID <value>anim
<int by value array><MixinInterface:SchematicView>.getSVNodeIDTab <value>anim
<maxObject><MixinInterface:SchematicView>.getSVNodeAnim <integer>svNodeID
<string><MixinInterface:SchematicView>.getSVNodeName <integer>svNodeID
<integer><MixinInterface:SchematicView>.getNumSVNodes()
<boolean><MixinInterface:SchematicView>.selectSVNode <integer>svNodeID [selectChildren:<boolean>]
selectChildren default value: false
<boolean><MixinInterface:SchematicView>.deselectSVNode <integer>svNodeID [selectChildren:<boolean>]
selectChildren: default value: false
<void><MixinInterface:SchematicView>.selectAll()
<void><MixinInterface:SchematicView>.deselectAll()
<void><MixinInterface:SchematicView>.selectInvert()
<boolean><MixinInterface:SchematicView>.selectChildren [svNodeID:<integer>]
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.deselectChildren svNodeID:<integer>
svNodeID: default value: -1
<void><MixinInterface:SchematicView>.selectToScene()
<void><MixinInterface:SchematicView>.selectFromScene()
<int by value array><MixinInterface:SchematicView>.getSelectedSVNodes()
<boolean><MixinInterface:SchematicView>.isSelected <integer>svNodeID
<integer><MixinInterface:SchematicView>.numChildren <integer>svNodeID
<integer><MixinInterface:SchematicView>.getChildSVNodeID <integer>svNodeID <integer>childNum
<integer><MixinInterface:SchematicView>.numParents [svNodeID:<integer>]
svNodeID: default value: -1
<integer><MixinInterface:SchematicView>.getParentSVNodeID <integer>svNodeID <integer>parentNum
<integer><MixinInterface:SchematicView>.getFocus()
<boolean><MixinInterface:SchematicView>.hidesvNodeID:<integer>
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.unHide <integer>svNodeID
<boolean><MixinInterface:SchematicView>.collapseSVNodes [svNodeID:<integer>]
svNodeID: default value: -1
<void><MixinInterface:SchematicView>.hideAll()
<void><MixinInterface:SchematicView>.showAll()
<boolean><MixinInterface:SchematicView>.expandSVNodes [svNodeID:<integer>]
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.shrink [svNodeID:<integer>]
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.unShrink [svNodeID:<integer>]
svNodeID: default value: -1
<void><MixinInterface:SchematicView>.unShrinkAll()
<boolean><MixinInterface:SchematicView>.arrangeSVNode [svNodeID:<integer>]
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.arrangeChildren [svNodeID:<integer>]
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.freeSVNode [svNodeID:<integer>]
svNodeID: default value: -1
<void><MixinInterface:SchematicView>.freeAll()
<void><MixinInterface:SchematicView>.zoomExtents()
<void><MixinInterface:SchematicView>.zoomSelectedExtents()
<void><MixinInterface:SchematicView>.panToSelected()
<boolean><MixinInterface:SchematicView>.zoomToSVNode <integer>svNodeID
<boolean><MixinInterface:SchematicView>.panToSVNode <integer>svNodeID
<filename><MixinInterface:SchematicView>.getBackgroundImageName()
<void><MixinInterface:SchematicView>.setBackgroundImageName <filename>name
<void><MixinInterface:SchematicView>.addBookmark <string>name
<void><MixinInterface:SchematicView>.nextBookmark()
<void><MixinInterface:SchematicView>.prevBookmark()
<boolean><MixinInterface:SchematicView>.setSVNodePos <integer>svNodeID <boolean>children <point2>point
<point2><MixinInterface:SchematicView>.getSVNodePos <integer>svNodeID
<boolean><MixinInterface:SchematicView>.translateSVNode <integer>svNodeID <boolean>children <point2>point
<boolean><MixinInterface:SchematicView>.translateSelected <point2>point
<boolean><MixinInterface:SchematicView>.canAssignController svNodeID:<integer>
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.showAssignControllerDialog svNodeID:<integer>
svNodeID: default value: -1
<boolean><MixinInterface:SchematicView>.deleteSelected()
<boolean><MixinInterface:SchematicView>.showProperties [svNodeID:<integer>]
svNodeID: default value: -1
<float><MixinInterface:SchematicView>.getSVNodeWidth()
<float><MixinInterface:SchematicView>.getSVNodeHeight()
<boolean><MixinInterface:SchematicView>.testSVNodeState <integer>svNodeID <enum>state
state enums: {#selected | #visible | #displayed | #inode | #localRoot | #animated | #instanced | #shrink | #freeMove | #freeMoveParent | #inactive}
<maxObject><MixinInterface:SchematicView>.getSVNodeOwner <integer>svNodeID
<integer><MixinInterface:SchematicView>.getSVNodeAnimID <integer>svNodeID
<void><MixinInterface:SchematicView>.doubleClickSVNode <integer>svNodeID
<integer><MixinInterface:SchematicView>.getNumOutputRelationships <integer>svNodeID
<enum><MixinInterface:SchematicView>.getOutputRelationshipType <integer>svNodeID <integer>relIndex
getOutputRelationshipType enums: {#unknown | #paramwire | #constraint | #light | #modifier | #controller)
<integer><MixinInterface:SchematicView>.getOutputRelationshipSVNodeID <integer>svNodeID <integer>relIndex
<integer><MixinInterface:SchematicView>.getNumInputRelationships <integer>svNodeID
<enum><MixinInterface:SchematicView>.getInputRelationshipType <integer>svNodeID <integer>relIndex
getInputRelationshipType enums: {#unknown | #paramwire | #constraint | #light | #modifier | #controller)
<integer><MixinInterface:SchematicView>.getInputRelationshipSVNodeID <integer>svNodeID <integer>relIndex
<boolean><MixinInterface:SchematicView>.canMakeSVNodeUnique <integer>svNodeID
<boolean><MixinInterface:SchematicView>.makeSVNodeUnique <integer>svNodeID
<boolean><MixinInterface:SchematicView>.setShowRelationships <integer>svNodeID <boolean>show
<boolean><MixinInterface:SchematicView>.getShowRelationships <integer>svNodeID
<void><MixinInterface:SchematicView>.showPreferencesDialog()
<void><MixinInterface:SchematicView>.showDisplayFloater <boolean>show
<void><MixinInterface:SchematicView>.showRelationshipDialog <boolean>all
<void><MixinInterface:SchematicView>.showInstancesDialog <boolean>all
<void><MixinInterface:SchematicView>.showObjectOccurrenceDialog()
<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
<void><MixinInterface:SchematicView>.hideListViewDialog()
<int by value array><MixinInterface:SchematicView>.getSelectedListViewSVNodes()
<enum><MixinInterface:SchematicView>.getListViewDialogType()
getListViewDialogType enums: {#unknown | #relationship | #instance | #occurrence | #userDefined)
<integer><MixinInterface:SchematicView>.getListViewDialogID()
<string><MixinInterface:SchematicView>.getListViewDialogTitle()
<boolean><MixinInterface:SchematicView>.setMode <enum>mode
mode enums: {#select | #connect | #paramwire | #pan | #zoom | #zoomregion}
<enum><MixinInterface:SchematicView>.getMode()
getMode enums: {#select | #connect | #paramwire | #pan | #zoom | #zoomregion)
<boolean><MixinInterface:SchematicView>.setLayoutMode <enum>mode
mode enums: {#reference | #hierarchy}
<enum><MixinInterface:SchematicView>.getLayoutMode()
getLayoutMode enums: {#reference | #hierarchy)
<boolean><MixinInterface:SchematicView>.setDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers}
<boolean><MixinInterface:SchematicView>.clearDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers}
<boolean><MixinInterface:SchematicView>.testDisplayFloaterFilter <enum>filter
filter enums: {#expand | #focus | #baseObjects | #modifierStack | #materials | #controllers | #controllersPos | #controllersRot | #controllersScale | #relConstraints | #relControllers | #relParamWires | #relLights | #relModifiers}
<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}
<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}
<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}
<integer><MixinInterface:SchematicView>.getBaseSVNodeID <integer>
<integer><MixinInterface:SchematicView>.getRootSVNodeID <integer>
<Point2><MixinInterface:SchematicView>.screenToSV <Point2>
<Array of Integers><MixinInterface:SchematicView>.getSVNodeIDByPoint <Point2>