Public Types | Public Member Functions | Static Public Attributes

Interface7 Class Reference

This reference page is linked to from the following overview topics: Scene Graph, Adding Modifiers to Objects.


Search for all occurrences

Detailed Description

#include <maxapi.h>

Inheritance diagram for Interface7:
Inheritance graph
[legend]

List of all members.

Public Types

enum   PivotMode { kPIV_NONE = PIV_NONE, kPIV_PIVOT_ONLY = PIV_PIVOT_ONLY, kPIV_OBJECT_ONLY = PIV_OBJECT_ONLY, kPIV_HIERARCHY_ONLY = PIV_HIERARCHY_ONLY }
 

Pivot modes the system can be in.

More...
enum   ResCode { kRES_INTERNAL_ERROR = -3, kRES_MOD_NOT_FOUND = -2, kRES_MOD_NOT_APPLICABLE = -1, kRES_SUCCESS = 0 }

Public Member Functions

virtual void  GetSelNodeTab (INodeTab &selectedNodes) const =0
  Retrieves the currently selected nodes into the supplied parameter.
virtual PivotMode  GetPivotMode () const =0
  Returns the current pivot mode the system is in.
virtual void  SetPivotMode (PivotMode pivMode)=0
  Set the pivot mode of the system.
virtual bool  GetAffectChildren () const =0
  Returns true if the transforms applied to a node will affect its children, otherwise returns false.
virtual void  SetAffectChildren (bool bAffectChildren)=0
  Sets whether the transforms applied to a node will affect its children.
virtual void  GetCurRefCoordSysName (MSTR &name) const =0
  Given a reference coordinate system id, returns the name of it.
virtual void  AddRefCoordNode (INode *node)=0
  Allows for setting the specified node's axis, as the current reference coordiante system.
virtual INode GetRefCoordNode ()=0
virtual bool  ShouldContinueRenderOnError () const =0
  Only relevant for network rendering.
virtual void  SetupFrameRendParams (FrameRendParams &frp, RendParams &rp, ViewExp *vx, RECT *r)=0
virtual void  SetupFrameRendParams_MXS (FrameRendParams &frp, RendParams &rp, ViewExp *vx, RECT *r, bool useSelBox)=0
virtual int  InitDefaultLights (DefaultLight *dl, int maxn, BOOL applyGlobalLevel=FALSE, ViewExp *vx=NULL, BOOL forRenderer=FALSE)=0
virtual void  IncrRenderActive ()=0
  Methods used to sync use with Material Editor sample rendering.
virtual void  DecrRenderActive ()=0
virtual BOOL  IsRenderActive ()=0
virtual BOOL  XRefRenderBegin ()=0
virtual void  XRefRenderEnd ()=0
virtual void  OpenRenderDialog ()=0
virtual void  CancelRenderDialog ()=0
virtual void  CloseRenderDialog ()=0
virtual void  CommitRenderDialogParameters ()=0
virtual void  UpdateRenderDialogParameters ()=0
virtual BOOL  RenderDialogOpen ()=0
virtual Bitmap GetLastRenderedImage ()=0
virtual HWND  GetStatusPanelHWnd ()=0
  Returns the window handle of the status panel window (this holds the MAXScript mini-listener)
virtual void  SetListenerMiniHWnd (HWND wnd)=0
virtual HWND  GetListenerMiniHWnd ()=0
virtual int  MAXScriptHelp (MCHAR *keyword=NULL)=0
  Starts the MAXScript help.
virtual MAXScriptPrefs GetMAXScriptPrefs ()=0
  Retrieves maxscript preferences.
virtual BOOL  OpenTrackViewWindow (const MCHAR *tv_name, const MCHAR *layoutName=NULL, Point2 pos=Point2(-1.0f,-1.0f), int width=-1, int height=-1, int dock=TV_FLOAT)=0
virtual BOOL  BringTrackViewWindowToTop (const MCHAR *tv_name)=0
  Sets the fous to the specified track view window.
virtual BOOL  TrackViewZoomSelected (const MCHAR *tv_name)=0
virtual BOOL  TrackViewZoomOn (const MCHAR *tv_name, Animatable *parent, int subNum)=0
virtual BOOL  CloseTrackView (const MCHAR *tv_name)=0
virtual int  NumTrackViews ()=0
virtual const MCHAR *  GetTrackViewName (int i)=0
virtual BOOL  SetTrackViewFilter (const MCHAR *tv_name, DWORD mask, int which, BOOL redraw=TRUE)=0
  The mask bits are defined in MAXSDK/INCLUDE/ITREEVW.H.
virtual BOOL  ClearTrackViewFilter (const MCHAR *tv_name, DWORD mask, int which, BOOL redraw=TRUE)=0
virtual DWORD  TestTrackViewFilter (const MCHAR *tv_name, DWORD mask, int which)=0
virtual void  FlushAllTrackViewWindows ()=0
virtual void  UnFlushAllTrackViewWindows ()=0
virtual void  CloseAllTrackViewWindows ()=0
virtual void  SetCurEditObject (BaseObject *obj, BaseNode *hintNode=NULL)=0
virtual BaseObject GetCurEditObject ()=0
  Get the object or modifier that is currently being edited in the modifier panel.
virtual void  AddModToSelection (Modifier *mod)=0
virtual void  InvalidateObCache (INode *node)=0
virtual INode FindNodeFromBaseObject (ReferenceTarget *obj)=0
virtual void  SelectedHistoryChanged ()=0
virtual BOOL  CmdPanelOpen ()=0
virtual void  CmdPanelOpen (BOOL openClose)=0
virtual void  SuspendEditing (DWORD whichPanels=(1<< TASK_MODE_MODIFY), BOOL alwaysSuspend=FALSE)=0
  Suspends / Resumes command panels specified via bits set in whichPanels param.
virtual void  ResumeEditing (DWORD whichPanels=(1<< TASK_MODE_MODIFY), BOOL alwaysSuspend=FALSE)=0
virtual void  SuspendMotionEditing ()=0
virtual void  ResumeMotionEditing ()=0
virtual int  AddClass (ClassDesc *cdesc, int dllNum=-1, int index=-1, bool load=true)=0
  This method expands Interface::AddClass.
virtual void  ReBuildSuperList ()=0
  Rebuilds the list of groups and categories of the Create Panel.
virtual BOOL  IsEditing ()=0
  Returns FALSE if the editing is stopped. While stopped, it shouldn't be resumed.
virtual void  ChangeHistory (int upDown)=0
  Allows for changing the modifier panel's.
virtual void  StartCreatingObject (ClassDesc *cd)=0
virtual BOOL  IsCreatingObject (Class_ID &id)=0
virtual BOOL  IsCreatingObject ()=0
virtual void  UpdateLockCheckObjectCounts ()=0
  Fast node creation for FileLink.
virtual INode CreateObjectNode (Object *obj, const MCHAR *name)=0
virtual BOOL  SetDir (int which, MCHAR *dir)=0
  The 'which' parameter corresponds to the 'MAX Directories' defines in maxapi.h.
virtual BOOL  AddAssetDir (MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType, int update=TRUE)=0
  Adds a permanent user path associated to a particular asset type.
virtual BOOL  DeleteAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType, int update=TRUE)=0
  Deletes the "ith" permanent user path associated with a particular asset type.
virtual void  UpdateAssetSection (MaxSDK::AssetManagement::AssetType assetType)=0
  Updates system configuration files' asset directory section of a particular asset type, with changes made to the session and/or permanent asset directories of that particular asset type.
virtual BOOL  AppendToCurFilePath (const MCHAR *toAppend)=0
  Appends a string to the current file name and file path.
virtual MSTR  GetMAXIniFile ()=0
  Returns empty MSTR if locType == LOC_REGISTRY.
virtual BOOL  OpenSchematicViewWindow (MCHAR *sv_name)=0
  --- Schematic View -------------------------------------------------- ///
virtual BOOL  SchematicViewZoomSelected (MCHAR *sv_name)=0
virtual BOOL  CloseSchematicView (MCHAR *sv_name)=0
virtual int  NumSchematicViews ()=0
virtual MCHAR *  GetSchematicViewName (int i)=0
virtual void  CloseAllSchematicViewWindows ()=0
virtual void  FlushAllSchematicViewWindows ()=0
virtual void  UnFlushAllSchematicViewWindows ()=0
virtual BOOL  DrawingEnabled ()=0
virtual void  EnableDrawing (BOOL onOff)=0
virtual BOOL  SceneResetting ()=0
virtual BOOL  QuitingApp ()=0
virtual BOOL  GetHideFrozen ()=0
virtual void  SetSceneDisplayFlag (DWORD flag, BOOL onOff, BOOL updateUI=TRUE)=0
  See 'Scene Display Flags' in maxapi.h for the possible values of 'flag'.
virtual BOOL  GetSceneDisplayFlag (DWORD flag)=0
virtual IScene GetScene ()=0
  Access to the scene interface.
virtual void  SetMtlSlot (int i, MtlBase *m)=0
virtual int  GetActiveMtlSlot ()=0
virtual void  SetActiveMtlSlot (int i)=0
virtual int  NumMtlSlots ()=0
virtual void  FlushMtlDlg ()=0
virtual void  UnFlushMtlDlg ()=0
virtual BOOL  IsMtlInstanced (MtlBase *m)=0
virtual Mtl FindMtlNameInScene (MSTR &name)=0
virtual void  PutMaterial (MtlBase *mtl, MtlBase *oldMtl, BOOL delOld=1, RefMakerHandle skipThis=0)=0
virtual BOOL  IsMtlDlgShowing ()=0
  Returns whether any Material Editor is open.
virtual void  OpenMtlDlg ()=0
  Opens the Material Editor. No effect if already open.
virtual void  CloseMtlDlg ()=0
  Closes the Material Editor. No effect is already closed.
virtual HWND  GetViewPanelHWnd ()=0
  Returns the window handle for the viewport frame.
virtual int  getActiveViewportIndex ()=0
  Viewport access by index.
virtual BOOL  setActiveViewport (int index)=0
virtual int  getNumViewports ()=0
virtual ViewExp getViewport (int i)=0
virtual void  resetAllViews ()=0
virtual MCHAR *  getActiveViewportLabel ()=0
  Viewport name access.
virtual MCHAR *  getViewportLabel (int index)=0
virtual void  SetRegionRect (int index, Rect r)=0
  Viewport blow-up and sub-region access.
virtual Rect  GetRegionRect (int index)=0
virtual void  SetBlowupRect (int index, Rect r)=0
virtual Rect  GetBlowupRect (int index)=0
virtual void  SetRegionRect2 (int index, Rect r)=0
virtual Rect  GetRegionRect2 (int index)=0
virtual void  SetBlowupRect2 (int index, Rect r)=0
virtual Rect  GetBlowupRect2 (int index)=0
virtual int  GetRenderType ()=0
virtual void  SetRenderType (int rtype)=0
virtual BOOL  GetLockImageAspRatio ()=0
virtual void  SetLockImageAspRatio (BOOL on)=0
virtual float  GetImageAspRatio ()=0
virtual void  SetImageAspRatio (float on)=0
virtual BOOL  GetLockPixelAspRatio ()=0
virtual void  SetLockPixelAspRatio (BOOL on)=0
virtual float  GetPixelAspRatio ()=0
virtual void  SetPixelAspRatio (float on)=0
virtual void  SetViewportGridVisible (int index, BOOL state)=0
virtual BOOL  GetViewportGridVisible (int index)=0
virtual void  ViewportInvalidate (int index)=0
virtual void  ViewportInvalidateBkgImage (int index)=0
virtual void  InvalidateAllViewportRects ()=0
virtual void  RedrawViewportsNow (TimeValue t, DWORD vpFlags=VP_DONT_SIMPLIFY)=0
virtual void  RedrawViewportsLater (TimeValue t, DWORD vpFlags=VP_DONT_SIMPLIFY)=0
virtual void  SetActiveViewportRenderLevel (int level)=0
  Sets the current viewport rendering level.
virtual int  GetActiveViewportRenderLevel ()=0
  Returns the current viewport rendering level.
virtual void  SetActiveViewportShowEdgeFaces (BOOL show)=0
  Access to viewport show edge faces states.
virtual BOOL  GetActiveViewportShowEdgeFaces ()=0
virtual void  SetActiveViewportTransparencyLevel (int level)=0
  There are 3 levels of transparency: 0, 1 and 2.
virtual int  GetActiveViewportTransparencyLevel ()=0
virtual BOOL  GetDualPlanes ()=0
  Access dual plane settings.
virtual void  SetDualPlanes (BOOL b)=0
virtual void  SetTestOnlyFrozen (int onOff)=0
  When the flag is On, only frozen objects are hit tested during a pick.
virtual void  SetScaleMode (int mode)=0
  Scale modes: CID_OBJSCALE, CID_OBJUSCALE, CID_OBJSQUASH (see cmdmode.h)
virtual void  SetCenterMode (int mode)=0
  Center modes - see 'Origin modes' in maxapi.h.
virtual BOOL  InManipMode ()=0
  Manipulator related.
virtual void  StartManipulateMode ()=0
virtual void  EndManipulateMode ()=0
virtual BOOL  IsViewportCommandMode (CommandMode *m)=0
virtual void  ConvertFlagedNodesToXRefs (const MaxSDK::AssetManagement::AssetUser &fname, INode *rootNode, Tab< INode * > &nodes, int xFlags)=0
  --- XRefs ----------------------------------------------------------- ///
virtual void  XRefSceneSetIgnoreFlag (int index, DWORD f, BOOL onOff)=0
  'f' parameter can take values defined as 'Xref flag bits' in inode.h
virtual void  UpdateSceneXRefState ()=0
virtual BOOL  GetSnapActive ()=0
virtual void  SetSnapActive (BOOL onOff)=0
virtual int  GetSnapType ()=0
virtual void  SetSnapType (int type)=0
  See 'Snap types' in snap.h for possible values of 'type'.
virtual void  ToggleASnap ()=0
virtual int  ASnapStatus ()=0
virtual void  TogglePSnap ()=0
virtual int  PSnapStatus ()=0
virtual float  GetGridSpacing ()=0
virtual void  SetGridSpacing (float newVal)=0
virtual int  GetGridMajorLines ()=0
virtual void  SetGridMajorLines (float newVal)=0
virtual float  GetSnapAngle ()=0
virtual void  SetSnapAngle (float newVal)=0
virtual float  GetSnapPercent ()=0
virtual void  SetSnapPercent (float newVal)=0
virtual BOOL  GetPrimaryVisibility (INode *node)=0
virtual void  SetPrimaryVisibility (INode *node, BOOL onOff)=0
virtual BOOL  GetSecondaryVisibility (INode *node)=0
virtual void  SetSecondaryVisibility (INode *node, BOOL onOff)=0
virtual void  SetNodeAttribute (INodeTab &nodes, int whatAttrib, int onOff)=0
  Set the given attribute on the passed nodes.
virtual void  SetNodeAttribute (INode *node, int whatAttrib, int onOff)=0
  Set the given attribute on the passed node.
MAX_DEPRECATED void  InvalidateNodeRect (INode *node, TimeValue t, BOOL oldPos=FALSE)
virtual void  SetExpertMode (int onOff)=0
virtual int  GetExpertMode ()=0
virtual void  LoadCUIConfig (MCHAR *fileName)=0
virtual void  WriteCUIConfig ()=0
virtual void  SaveCUIAs ()=0
virtual void  LoadCUI ()=0
virtual void  RevertToBackupCUI ()=0
virtual void  ResetToFactoryDefaultCUI ()=0
virtual void  DoUICustomization (int startPage)=0
virtual int  GetDefaultImageListBaseIndex (SClass_ID sid, Class_ID cid)=0
virtual MSTR GetDefaultImageListFilePrefix (SClass_ID sid, Class_ID cid)=0
virtual float  GetGridIntens ()=0
virtual void  SetGridIntens (float f)=0
virtual BOOL  GetWhiteOrigin ()=0
virtual void  SetWhiteOrigin (BOOL b)=0
virtual BOOL  GetUseGridColor ()=0
virtual void  SetUseGridColor (BOOL b)=0
virtual void  UpdateColors (BOOL useGridColor, int gridIntensity, BOOL whiteOrigin)=0
virtual IMenu GetIMenu ()=0
virtual IMenuItem GetIMenuItem ()=0
virtual void  RepaintTimeSlider ()=0
virtual MSTR  GetTabPageTitle (ITabPage *page)=0
virtual BOOL  DoMaxFileSaveAsDlg (MSTR &fileName, BOOL setAsCurrent=TRUE)=0
virtual BOOL  DoMaxFileOpenDlg (MSTR &fileName, MSTR *defDir, MSTR *defFile)=0
virtual BOOL  DoMaxFileMergeDlg (MSTR &fileName, MSTR *defDir, MSTR *defFile)=0
virtual BOOL  DoMaxFileXRefDlg (MSTR &fileName, MSTR *defDir, MSTR *defFile)=0
virtual void  StartAnimPlayback2 (int selOnly)=0
  Old style playback with no immediate return.
virtual BOOL  IsValidModForSelection (ClassEntry *ce)=0
  Tests of modifier applicability.
virtual BOOL  IsValidModifier (INode &node, Modifier &mod)=0
  Returns FALSE if the specied modifier cannot be applied to the object.
virtual ResCode  AddModifier (INode &node, Modifier &mod, int beforeIdx=0)=0
  Adds the specified modifier to a node.
virtual ResCode  DeleteModifier (INode &node, Modifier &mod)=0
  Deletes the first occurance of the specified modifier from the node's modifier stack.
virtual ResCode  DeleteModifier (INode &node, int modIdx)=0
  Deletes the modifier at the specified index from the node's modifier stack Returns one of the following values: kRES_INTERNAL_ERROR, kRES_MOD_NOT_FOUND or kRES_SUCCESS.
virtual IDerivedObject FindModifier (INode &node, Modifier &mod, int &modStackIdx, int &derivedObjIdx)=0
  Finds the first occurance of the specified modifier on a node.
virtual IDerivedObject FindModifier (INode &node, int modIdx, int &idx, Modifier *&mod)=0
  Finds the modifier at the specified modstack index on a node.
virtual IDerivedObject FindModifier (INode &node, Modifier &mod, ModContext &mc, int &modStackIdx, int &dobjidx)=0
  Finds the index of a modifier instance in a modstack of a node, when the node, the modifier it's corresponding cod context are given.
virtual ResCode  DoDeleteModifier (INode &node, IDerivedObject &dobj, int idx)=0
virtual Object GetReplaceableObjRef (INode &node)=0
  A node's reference to its object should be replaced using this method.
virtual void  OpenEnvEffectsDialog ()=0
virtual void  CloseEnvEffectsDialog ()=0
virtual BOOL  EnvEffectsDialogOpen ()=0

Static Public Attributes

static CoreExport const
Interface_ID 
kInterface7InterfaceID
  The ID for this interface. Pass this ID to Interface::GetInterface to get an Interface7 pointer.

Member Enumeration Documentation

enum PivotMode

Pivot modes the system can be in.

Enumerator:
kPIV_NONE 

Transforms will affect the objects' world transform.

kPIV_PIVOT_ONLY 

Transforms will affect only the pivot point of objects.

kPIV_OBJECT_ONLY 

Transforms will affect only the objects and not their pivot points.

kPIV_HIERARCHY_ONLY 

Rotation and Scale will be applied to the hierarchy by rotating or scaling the position of the pivot point without rotating or scaling the pivot point itself.

    {
        kPIV_NONE = PIV_NONE,
        kPIV_PIVOT_ONLY = PIV_PIVOT_ONLY,
        kPIV_OBJECT_ONLY = PIV_OBJECT_ONLY,
        kPIV_HIERARCHY_ONLY = PIV_HIERARCHY_ONLY
    };
enum ResCode

Member Function Documentation

virtual void GetSelNodeTab ( INodeTab selectedNodes ) const [pure virtual]

Retrieves the currently selected nodes into the supplied parameter.

It clears the node tab supplied as parameter before using it.

virtual PivotMode GetPivotMode ( ) const [pure virtual]

Returns the current pivot mode the system is in.

virtual void SetPivotMode ( PivotMode  pivMode ) [pure virtual]

Set the pivot mode of the system.

virtual bool GetAffectChildren ( ) const [pure virtual]

Returns true if the transforms applied to a node will affect its children, otherwise returns false.

virtual void SetAffectChildren ( bool  bAffectChildren ) [pure virtual]

Sets whether the transforms applied to a node will affect its children.

If bAffectChildren is true, the children of a node will be transformed when their parent node is transformed. Otherwise, they won't be transformed.

virtual void GetCurRefCoordSysName ( MSTR name ) const [pure virtual]

Given a reference coordinate system id, returns the name of it.

virtual void AddRefCoordNode ( INode node ) [pure virtual]

Allows for setting the specified node's axis, as the current reference coordiante system.

virtual INode* GetRefCoordNode ( ) [pure virtual]
virtual bool ShouldContinueRenderOnError ( ) const [pure virtual]

Only relevant for network rendering.

It is possible to set a job flag indicates that max should attempt to continue to render even when an "error" has been detected. This method allows plug-ins to determine whether this flag has been set.

virtual void SetupFrameRendParams ( FrameRendParams frp,
RendParams rp,
ViewExp vx,
RECT *  r 
) [pure virtual]
virtual void SetupFrameRendParams_MXS ( FrameRendParams frp,
RendParams rp,
ViewExp vx,
RECT *  r,
bool  useSelBox 
) [pure virtual]
virtual int InitDefaultLights ( DefaultLight dl,
int  maxn,
BOOL  applyGlobalLevel = FALSE,
ViewExp vx = NULL,
BOOL  forRenderer = FALSE 
) [pure virtual]
virtual void IncrRenderActive ( ) [pure virtual]

Methods used to sync use with Material Editor sample rendering.

virtual void DecrRenderActive ( ) [pure virtual]
virtual BOOL IsRenderActive ( ) [pure virtual]
virtual BOOL XRefRenderBegin ( ) [pure virtual]
virtual void XRefRenderEnd ( ) [pure virtual]
virtual void OpenRenderDialog ( ) [pure virtual]
virtual void CancelRenderDialog ( ) [pure virtual]
virtual void CloseRenderDialog ( ) [pure virtual]
virtual void CommitRenderDialogParameters ( ) [pure virtual]
virtual void UpdateRenderDialogParameters ( ) [pure virtual]
virtual BOOL RenderDialogOpen ( ) [pure virtual]
virtual Bitmap* GetLastRenderedImage ( ) [pure virtual]
virtual HWND GetStatusPanelHWnd ( ) [pure virtual]

Returns the window handle of the status panel window (this holds the MAXScript mini-listener)

virtual void SetListenerMiniHWnd ( HWND  wnd ) [pure virtual]
virtual HWND GetListenerMiniHWnd ( ) [pure virtual]
virtual int MAXScriptHelp ( MCHAR *  keyword = NULL ) [pure virtual]

Starts the MAXScript help.

virtual MAXScriptPrefs& GetMAXScriptPrefs ( ) [pure virtual]

Retrieves maxscript preferences.

virtual BOOL OpenTrackViewWindow ( const MCHAR *  tv_name,
const MCHAR *  layoutName = NULL,
Point2  pos = Point2(-1.0f,-1.0f),
int  width = -1,
int  height = -1,
int  dock = TV_FLOAT 
) [pure virtual]
virtual BOOL BringTrackViewWindowToTop ( const MCHAR *  tv_name ) [pure virtual]

Sets the fous to the specified track view window.

virtual BOOL TrackViewZoomSelected ( const MCHAR *  tv_name ) [pure virtual]
virtual BOOL TrackViewZoomOn ( const MCHAR *  tv_name,
Animatable parent,
int  subNum 
) [pure virtual]
virtual BOOL CloseTrackView ( const MCHAR *  tv_name ) [pure virtual]
virtual int NumTrackViews ( ) [pure virtual]
virtual const MCHAR* GetTrackViewName ( int  i ) [pure virtual]
virtual BOOL SetTrackViewFilter ( const MCHAR *  tv_name,
DWORD  mask,
int  which,
BOOL  redraw = TRUE 
) [pure virtual]

The mask bits are defined in MAXSDK/INCLUDE/ITREEVW.H.

Internally, the mask bits are stored in two DWORDs The 'which' param tells which to work with - valid values are 0 and 1.

virtual BOOL ClearTrackViewFilter ( const MCHAR *  tv_name,
DWORD  mask,
int  which,
BOOL  redraw = TRUE 
) [pure virtual]
virtual DWORD TestTrackViewFilter ( const MCHAR *  tv_name,
DWORD  mask,
int  which 
) [pure virtual]
virtual void FlushAllTrackViewWindows ( ) [pure virtual]
virtual void UnFlushAllTrackViewWindows ( ) [pure virtual]
virtual void CloseAllTrackViewWindows ( ) [pure virtual]
virtual void SetCurEditObject ( BaseObject obj,
BaseNode *  hintNode = NULL 
) [pure virtual]
virtual BaseObject* GetCurEditObject ( ) [pure virtual]

Get the object or modifier that is currently being edited in the modifier panel.

Implements Interface.

virtual void AddModToSelection ( Modifier mod ) [pure virtual]
virtual void InvalidateObCache ( INode node ) [pure virtual]
virtual INode* FindNodeFromBaseObject ( ReferenceTarget obj ) [pure virtual]
virtual void SelectedHistoryChanged ( ) [pure virtual]
virtual BOOL CmdPanelOpen ( ) [pure virtual]
virtual void CmdPanelOpen ( BOOL  openClose ) [pure virtual]
virtual void SuspendEditing ( DWORD  whichPanels = (1<< TASK_MODE_MODIFY),
BOOL  alwaysSuspend = FALSE 
) [pure virtual]

Suspends / Resumes command panels specified via bits set in whichPanels param.

virtual void ResumeEditing ( DWORD  whichPanels = (1<< TASK_MODE_MODIFY),
BOOL  alwaysSuspend = FALSE 
) [pure virtual]
virtual void SuspendMotionEditing ( ) [pure virtual]
virtual void ResumeMotionEditing ( ) [pure virtual]
virtual int AddClass ( ClassDesc cdesc,
int  dllNum = -1,
int  index = -1,
bool  load = true 
) [pure virtual]

This method expands Interface::AddClass.

It allows for adding new ClassDesc dynamically to create panel

virtual void ReBuildSuperList ( ) [pure virtual]

Rebuilds the list of groups and categories of the Create Panel.

virtual BOOL IsEditing ( ) [pure virtual]

Returns FALSE if the editing is stopped. While stopped, it shouldn't be resumed.

virtual void ChangeHistory ( int  upDown ) [pure virtual]

Allows for changing the modifier panel's.

virtual void StartCreatingObject ( ClassDesc cd ) [pure virtual]
virtual BOOL IsCreatingObject ( Class_ID id ) [pure virtual]
virtual BOOL IsCreatingObject ( ) [pure virtual]
virtual void UpdateLockCheckObjectCounts ( ) [pure virtual]

Fast node creation for FileLink.

virtual INode* CreateObjectNode ( Object obj,
const MCHAR *  name 
) [pure virtual]
virtual BOOL SetDir ( int  which,
MCHAR *  dir 
) [pure virtual]

The 'which' parameter corresponds to the 'MAX Directories' defines in maxapi.h.

Implemented in Interface8.

virtual BOOL AddAssetDir ( MCHAR *  dir,
MaxSDK::AssetManagement::AssetType  assetType,
int  update = TRUE 
) [pure virtual]

Adds a permanent user path associated to a particular asset type.

Parameters:
[in] dir An absolute path
[in] assetType An enumeration constant representing the asset type
[in] Update system configuration files with the new data
Returns:
TRUE if the path was added, FALSE if not
Remarks:
Remember that this function is for adding permanent user paths, not session user paths. Session user paths are temporary.
virtual BOOL DeleteAssetDir ( int  i,
MaxSDK::AssetManagement::AssetType  assetType,
int  update = TRUE 
) [pure virtual]

Deletes the "ith" permanent user path associated with a particular asset type.

Parameters:
[in] i The index of the directory you want to delete
[in] assetType An enumeration constant representing the asset type
[in] Update system configuration files with the new data
Returns:
a c-string with an absolute path to the ith asset directory
Remarks:
Remember that this function returns a permanent user path, not a session user path.
virtual void UpdateAssetSection ( MaxSDK::AssetManagement::AssetType  assetType ) [pure virtual]

Updates system configuration files' asset directory section of a particular asset type, with changes made to the session and/or permanent asset directories of that particular asset type.

Parameters:
[in] assetType An enumeration constant representing the asset type
Returns:
a c-string with an absolute path to the ith asset directory
Remarks:
Remember that this function returns a permanent user path, not a session user path.
virtual BOOL AppendToCurFilePath ( const MCHAR *  toAppend ) [pure virtual]

Appends a string to the current file name and file path.

It also updates the string in the application's title bar.

virtual MSTR GetMAXIniFile ( ) [pure virtual]

Returns empty MSTR if locType == LOC_REGISTRY.

Implemented in Interface8.

virtual BOOL OpenSchematicViewWindow ( MCHAR *  sv_name ) [pure virtual]

--- Schematic View -------------------------------------------------- ///

virtual BOOL SchematicViewZoomSelected ( MCHAR *  sv_name ) [pure virtual]
virtual BOOL CloseSchematicView ( MCHAR *  sv_name ) [pure virtual]
virtual int NumSchematicViews ( ) [pure virtual]
virtual MCHAR* GetSchematicViewName ( int  i ) [pure virtual]
virtual void CloseAllSchematicViewWindows ( ) [pure virtual]
virtual void FlushAllSchematicViewWindows ( ) [pure virtual]
virtual void UnFlushAllSchematicViewWindows ( ) [pure virtual]
virtual BOOL DrawingEnabled ( ) [pure virtual]
virtual void EnableDrawing ( BOOL  onOff ) [pure virtual]
virtual BOOL SceneResetting ( ) [pure virtual]
virtual BOOL QuitingApp ( ) [pure virtual]
virtual BOOL GetHideFrozen ( ) [pure virtual]
virtual void SetSceneDisplayFlag ( DWORD  flag,
BOOL  onOff,
BOOL  updateUI = TRUE 
) [pure virtual]

See 'Scene Display Flags' in maxapi.h for the possible values of 'flag'.

virtual BOOL GetSceneDisplayFlag ( DWORD  flag ) [pure virtual]
virtual IScene* GetScene ( ) [pure virtual]

Access to the scene interface.

virtual void SetMtlSlot ( int  i,
MtlBase m 
) [pure virtual]
virtual int GetActiveMtlSlot ( ) [pure virtual]
virtual void SetActiveMtlSlot ( int  i ) [pure virtual]
virtual int NumMtlSlots ( ) [pure virtual]
virtual void FlushMtlDlg ( ) [pure virtual]
virtual void UnFlushMtlDlg ( ) [pure virtual]
virtual BOOL IsMtlInstanced ( MtlBase m ) [pure virtual]
virtual Mtl* FindMtlNameInScene ( MSTR name ) [pure virtual]
virtual void PutMaterial ( MtlBase mtl,
MtlBase oldMtl,
BOOL  delOld = 1,
RefMakerHandle  skipThis = 0 
) [pure virtual]
virtual BOOL IsMtlDlgShowing ( ) [pure virtual]

Returns whether any Material Editor is open.

Pertains to either the Basic or Advanced editor according to the current mode; both cannot be open simultaneously.

See also:
Material Editor Dialog Mode values
virtual void OpenMtlDlg ( ) [pure virtual]

Opens the Material Editor. No effect if already open.

Opens either the Basic or Advanced editor according to the current mode; both cannot be open simultaneously.

See also:
Material Editor Dialog Mode values
virtual void CloseMtlDlg ( ) [pure virtual]

Closes the Material Editor. No effect is already closed.

Closes either the Basic or Advanced editor according to the current mode; both cannot be open simultaneously.

See also:
Material Editor Dialog Mode values
virtual HWND GetViewPanelHWnd ( ) [pure virtual]

Returns the window handle for the viewport frame.

virtual int getActiveViewportIndex ( ) [pure virtual]

Viewport access by index.

virtual BOOL setActiveViewport ( int  index ) [pure virtual]
virtual int getNumViewports ( ) [pure virtual]
virtual ViewExp* getViewport ( int  i ) [pure virtual]
virtual void resetAllViews ( ) [pure virtual]
virtual MCHAR* getActiveViewportLabel ( ) [pure virtual]

Viewport name access.

virtual MCHAR* getViewportLabel ( int  index ) [pure virtual]
virtual void SetRegionRect ( int  index,
Rect  r 
) [pure virtual]

Viewport blow-up and sub-region access.

virtual Rect GetRegionRect ( int  index ) [pure virtual]
virtual void SetBlowupRect ( int  index,
Rect  r 
) [pure virtual]
virtual Rect GetBlowupRect ( int  index ) [pure virtual]
virtual void SetRegionRect2 ( int  index,
Rect  r 
) [pure virtual]
virtual Rect GetRegionRect2 ( int  index ) [pure virtual]
virtual void SetBlowupRect2 ( int  index,
Rect  r 
) [pure virtual]
virtual Rect GetBlowupRect2 ( int  index ) [pure virtual]
virtual int GetRenderType ( ) [pure virtual]
virtual void SetRenderType ( int  rtype ) [pure virtual]
virtual BOOL GetLockImageAspRatio ( ) [pure virtual]
virtual void SetLockImageAspRatio ( BOOL  on ) [pure virtual]
virtual float GetImageAspRatio ( ) [pure virtual]
virtual void SetImageAspRatio ( float  on ) [pure virtual]
virtual BOOL GetLockPixelAspRatio ( ) [pure virtual]
virtual void SetLockPixelAspRatio ( BOOL  on ) [pure virtual]
virtual float GetPixelAspRatio ( ) [pure virtual]
virtual void SetPixelAspRatio ( float  on ) [pure virtual]
virtual void SetViewportGridVisible ( int  index,
BOOL  state 
) [pure virtual]
virtual BOOL GetViewportGridVisible ( int  index ) [pure virtual]
virtual void ViewportInvalidate ( int  index ) [pure virtual]
virtual void ViewportInvalidateBkgImage ( int  index ) [pure virtual]
virtual void InvalidateAllViewportRects ( ) [pure virtual]
virtual void RedrawViewportsNow ( TimeValue  t,
DWORD  vpFlags = VP_DONT_SIMPLIFY 
) [pure virtual]
Parameters:
t - The time to redraw the viewports at
vpFlags - See Viewport Degradation Flags for a list of possible values
virtual void RedrawViewportsLater ( TimeValue  t,
DWORD  vpFlags = VP_DONT_SIMPLIFY 
) [pure virtual]
Parameters:
t - The time to redraw the viewports at
vpFlags - See Viewport Degradation Flags for a list of possible values
virtual void SetActiveViewportRenderLevel ( int  level ) [pure virtual]

Sets the current viewport rendering level.

Parameters:
level - See Viewport Rendering Levels for possible values
virtual int GetActiveViewportRenderLevel ( ) [pure virtual]

Returns the current viewport rendering level.

Returns:
See Viewport Rendering Levels for possible values
virtual void SetActiveViewportShowEdgeFaces ( BOOL  show ) [pure virtual]

Access to viewport show edge faces states.

virtual BOOL GetActiveViewportShowEdgeFaces ( ) [pure virtual]
virtual void SetActiveViewportTransparencyLevel ( int  level ) [pure virtual]

There are 3 levels of transparency: 0, 1 and 2.


0 - no transperancy
1 - if hardware rendring -> Blend, otherwise Stipple
2 - if hardware rendring -> Sorted Blend, otherwise Blend

virtual int GetActiveViewportTransparencyLevel ( ) [pure virtual]
virtual BOOL GetDualPlanes ( ) [pure virtual]

Access dual plane settings.

virtual void SetDualPlanes ( BOOL  b ) [pure virtual]
virtual void SetTestOnlyFrozen ( int  onOff ) [pure virtual]

When the flag is On, only frozen objects are hit tested during a pick.

virtual void SetScaleMode ( int  mode ) [pure virtual]

Scale modes: CID_OBJSCALE, CID_OBJUSCALE, CID_OBJSQUASH (see cmdmode.h)

virtual void SetCenterMode ( int  mode ) [pure virtual]

Center modes - see 'Origin modes' in maxapi.h.

virtual BOOL InManipMode ( ) [pure virtual]
virtual void StartManipulateMode ( ) [pure virtual]
virtual void EndManipulateMode ( ) [pure virtual]
virtual BOOL IsViewportCommandMode ( CommandMode m ) [pure virtual]
virtual void ConvertFlagedNodesToXRefs ( const MaxSDK::AssetManagement::AssetUser fname,
INode rootNode,
Tab< INode * > &  nodes,
int  xFlags 
) [pure virtual]

--- XRefs ----------------------------------------------------------- ///

This function is for internal use only.

virtual void XRefSceneSetIgnoreFlag ( int  index,
DWORD  f,
BOOL  onOff 
) [pure virtual]

'f' parameter can take values defined as 'Xref flag bits' in inode.h

virtual void UpdateSceneXRefState ( ) [pure virtual]
virtual BOOL GetSnapActive ( ) [pure virtual]
virtual void SetSnapActive ( BOOL  onOff ) [pure virtual]
virtual int GetSnapType ( ) [pure virtual]
virtual void SetSnapType ( int  type ) [pure virtual]

See 'Snap types' in snap.h for possible values of 'type'.

virtual void ToggleASnap ( ) [pure virtual]
virtual int ASnapStatus ( ) [pure virtual]
virtual void TogglePSnap ( ) [pure virtual]
virtual int PSnapStatus ( ) [pure virtual]
virtual float GetGridSpacing ( ) [pure virtual]
Remarks:
This method returns the grid spacing value that the user specifies in the Views / Grid and Snap Settings dialog in the Home Grid tab under Grid Spacing.

Implements Interface.

virtual void SetGridSpacing ( float  newVal ) [pure virtual]
virtual int GetGridMajorLines ( ) [pure virtual]
Remarks:
This method returns the value that the user specifies in the Views / Grid and Snap Settings dialog in the Home Grid tab under Major Lines every Nth.

Implements Interface.

virtual void SetGridMajorLines ( float  newVal ) [pure virtual]
virtual float GetSnapAngle ( ) [pure virtual]
virtual void SetSnapAngle ( float  newVal ) [pure virtual]
virtual float GetSnapPercent ( ) [pure virtual]
virtual void SetSnapPercent ( float  newVal ) [pure virtual]
virtual BOOL GetPrimaryVisibility ( INode node ) [pure virtual]
virtual void SetPrimaryVisibility ( INode node,
BOOL  onOff 
) [pure virtual]
virtual BOOL GetSecondaryVisibility ( INode node ) [pure virtual]
virtual void SetSecondaryVisibility ( INode node,
BOOL  onOff 
) [pure virtual]
virtual void SetNodeAttribute ( INodeTab nodes,
int  whatAttrib,
int  onOff 
) [pure virtual]

Set the given attribute on the passed nodes.

Parameters:
nodes - An array of nodes to set the attribute on
whatAttrib - One of the list of Interface7::SetNodeAttribute Defines
onOff - If true the attribute is set on all the nodes, if it is false, the attribute is cleared
virtual void SetNodeAttribute ( INode node,
int  whatAttrib,
int  onOff 
) [pure virtual]

Set the given attribute on the passed node.

Parameters:
node - A pointer to the node to set the attribute on
whatAttrib - One of the list of Interface7::SetNodeAttribute Defines
onOff - If true the attribute is set on all the nodes, if it is false, the attribute is cleared
MAX_DEPRECATED void InvalidateNodeRect ( INode node,
TimeValue  t,
BOOL  oldPos = FALSE 
)
Remarks:
Deprecated in 3ds Max 2012. Use INode::InvalidateRect instead.
virtual void SetExpertMode ( int  onOff ) [pure virtual]
virtual int GetExpertMode ( ) [pure virtual]
virtual void LoadCUIConfig ( MCHAR *  fileName ) [pure virtual]
virtual void WriteCUIConfig ( ) [pure virtual]
virtual void SaveCUIAs ( ) [pure virtual]
virtual void LoadCUI ( ) [pure virtual]
virtual void RevertToBackupCUI ( ) [pure virtual]
virtual void ResetToFactoryDefaultCUI ( ) [pure virtual]
virtual void DoUICustomization ( int  startPage ) [pure virtual]
virtual int GetDefaultImageListBaseIndex ( SClass_ID  sid,
Class_ID  cid 
) [pure virtual]
virtual MSTR* GetDefaultImageListFilePrefix ( SClass_ID  sid,
Class_ID  cid 
) [pure virtual]
virtual float GetGridIntens ( ) [pure virtual]
virtual void SetGridIntens ( float  f ) [pure virtual]
virtual BOOL GetWhiteOrigin ( ) [pure virtual]
virtual void SetWhiteOrigin ( BOOL  b ) [pure virtual]
virtual BOOL GetUseGridColor ( ) [pure virtual]
virtual void SetUseGridColor ( BOOL  b ) [pure virtual]
virtual void UpdateColors ( BOOL  useGridColor,
int  gridIntensity,
BOOL  whiteOrigin 
) [pure virtual]
virtual IMenu* GetIMenu ( ) [pure virtual]
virtual IMenuItem* GetIMenuItem ( ) [pure virtual]
virtual void RepaintTimeSlider ( ) [pure virtual]
virtual MSTR GetTabPageTitle ( ITabPage page ) [pure virtual]
virtual BOOL DoMaxFileSaveAsDlg ( MSTR fileName,
BOOL  setAsCurrent = TRUE 
) [pure virtual]
virtual BOOL DoMaxFileOpenDlg ( MSTR fileName,
MSTR defDir,
MSTR defFile 
) [pure virtual]
virtual BOOL DoMaxFileMergeDlg ( MSTR fileName,
MSTR defDir,
MSTR defFile 
) [pure virtual]
virtual BOOL DoMaxFileXRefDlg ( MSTR fileName,
MSTR defDir,
MSTR defFile 
) [pure virtual]
virtual void StartAnimPlayback2 ( int  selOnly ) [pure virtual]

Old style playback with no immediate return.

virtual BOOL IsValidModForSelection ( ClassEntry ce ) [pure virtual]

Tests of modifier applicability.

virtual BOOL IsValidModifier ( INode node,
Modifier mod 
) [pure virtual]

Returns FALSE if the specied modifier cannot be applied to the object.

virtual ResCode AddModifier ( INode node,
Modifier mod,
int  beforeIdx = 0 
) [pure virtual]

Adds the specified modifier to a node.

INode& node - the node the modifier will be added to Modifier& mod - the modifier instance that will be applied to node int beforeIdx - the index in the modstack where the modifier should be inserted. 0 means at the top of the modstack (just below the node) If the object's stack doesn't have beforeIdx number of modifiers in it, the modifier is added at the lowest possible index (just on top of the base object) Returns one of these error codes: kRES_INTERNAL_ERROR - if an error such as invalid pointer is encountered kRES_MOD_NOT_APPLICABLE - if the modifier is not applicable kRES_SUCCESS - on success

virtual ResCode DeleteModifier ( INode node,
Modifier mod 
) [pure virtual]

Deletes the first occurance of the specified modifier from the node's modifier stack.

Returns one of the following values: kRES_INTERNAL_ERROR, kRES_MOD_NOT_FOUND or kRES_SUCCESS

virtual ResCode DeleteModifier ( INode node,
int  modIdx 
) [pure virtual]

Deletes the modifier at the specified index from the node's modifier stack Returns one of the following values: kRES_INTERNAL_ERROR, kRES_MOD_NOT_FOUND or kRES_SUCCESS.

virtual IDerivedObject* FindModifier ( INode node,
Modifier mod,
int &  modStackIdx,
int &  derivedObjIdx 
) [pure virtual]

Finds the first occurance of the specified modifier on a node.

It returns a pointer to the derived object to which this modifier belongs, the index of the modifier within this derived object and the index within the modifier stack. If the modifier is not found, returns NULL. It searches the WS, then the OS part of the geom pipeline of the node.

virtual IDerivedObject* FindModifier ( INode node,
int  modIdx,
int &  idx,
Modifier *&  mod 
) [pure virtual]

Finds the modifier at the specified modstack index on a node.

It returns a pointer to the derived object to which this modifier belongs, the index of the modifier within this derived object, and a pointer to the modifier itself. If the modifier is not found, returns NULL. It searches both WS and OS part of the geom pipeline of the object

virtual IDerivedObject* FindModifier ( INode node,
Modifier mod,
ModContext mc,
int &  modStackIdx,
int &  dobjidx 
) [pure virtual]

Finds the index of a modifier instance in a modstack of a node, when the node, the modifier it's corresponding cod context are given.

It returns a pointer to the derived object to which this modifier belongs, the index of the modifier within this derived object, and a pointer to the modifier itself. If the modifier is not found, returns NULL. It searches both WS and OS part of the geom pipeline of the object node, mod and mc are input parameters, while modStackIdx and dobjidx are output params

virtual ResCode DoDeleteModifier ( INode node,
IDerivedObject dobj,
int  idx 
) [pure virtual]
virtual Object* GetReplaceableObjRef ( INode node ) [pure virtual]

A node's reference to its object should be replaced using this method.

Returns NULL when the operation cannot be completed, such as for Actively (File) Linked objects or their user created clone-instances / references.

virtual void OpenEnvEffectsDialog ( ) [pure virtual]
virtual void CloseEnvEffectsDialog ( ) [pure virtual]
virtual BOOL EnvEffectsDialogOpen ( ) [pure virtual]

Member Data Documentation

CoreExport const Interface_ID kInterface7InterfaceID [static]

The ID for this interface. Pass this ID to Interface::GetInterface to get an Interface7 pointer.


Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7
Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7 Interface7