3ds Max C++ API Reference
Loading...
Searching...
No Matches
IMXSDebugger Class Referenceabstract

#include <IMXSDebugger.h>

+ Inheritance diagram for IMXSDebugger:

Public Types

enum  state {
  idle , getvar_getvar , getvar_getval , setvar_getvar ,
  setvar_eval_compile , setvar_eval , setvar_setval , eval_compile ,
  eval , attempting_break
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 

Public Member Functions

virtual void OpenDialog (BOOL breakExecution, const MCHAR *outString=nullptr, BOOL setFocus=FALSE)=0
 
virtual BOOL IsDialogOpen ()=0
 
virtual void CloseDialog ()=0
 
virtual HWND GetDialogHwnd ()=0
 
virtual void UpdateClipboardData ()=0
 
virtual void WriteString (const MCHAR *str)=0
 
virtual void WriteLine (const MCHAR *str)=0
 
virtual void BreakExecution (const MCHAR *outString=nullptr)=0
 
virtual void ContinueExecution ()=0
 
virtual BOOL IsExecutionBroken ()=0
 
virtual state GetState ()=0
 
virtual DWORD GetThreadID () const =0
 
virtual BOOL GetAllowBreakOnThrow ()=0
 
virtual BOOL SetAllowBreakOnThrow (BOOL breakExecution)=0
 
virtual BOOL GetBreakOnError ()=0
 
virtual BOOL SetBreakOnError (BOOL breakExecution)=0
 
virtual BOOL GetBreakOnException ()=0
 
virtual BOOL SetBreakOnException (BOOL breakExecution)=0
 
virtual BOOL GetDefaultBreakOnThrow ()=0
 
virtual BOOL SetDefaultBreakOnThrow (BOOL breakExecution)=0
 
virtual BOOL GetIgnoreCaughtThrows ()=0
 
virtual BOOL SetIgnoreCaughtThrows (BOOL ignore)=0
 
virtual BOOL GetIgnoreCaughtErrors ()=0
 
virtual BOOL SetIgnoreCaughtErrors (BOOL ignore)=0
 
virtual BOOL GetIgnoreCaughtExceptions ()=0
 
virtual BOOL SetIgnoreCaughtExceptions (BOOL ignore)=0
 
virtual BOOL GetEnabledInQuietMode ()=0
 
virtual BOOL SetEnabledInQuietMode (BOOL ignore)=0
 
virtual BOOL GetEnabledInNetRender ()=0
 
virtual BOOL SetEnabledInNetRender (BOOL ignore)=0
 
virtual BOOL GetStayOnTop ()=0
 
virtual BOOL SetStayOnTop (BOOL ignore)=0
 
virtual DWORD GetCommandTimeoutPeriod ()=0
 
virtual DWORD SetCommandTimeoutPeriod (DWORD millisecs)=0
 
virtual DWORD GetBreakTimeoutPeriod ()=0
 
virtual DWORD SetBreakTimeoutPeriod (DWORD millisecs)=0
 
virtual DWORD GetGCTimeoutPeriod ()=0
 
virtual DWORD SetGCTimeoutPeriod (DWORD millisecs)=0
 
virtual DWORD GetBreakCyclePeriod ()=0
 
virtual DWORD SetBreakCyclePeriod (DWORD millisecs)=0
 
virtual BOOL GetShowGlobalConstants ()=0
 
virtual BOOL SetShowGlobalConstants (BOOL ignore)=0
 
virtual BOOL GetShowFirstFrameOnly ()=0
 
virtual BOOL SetShowFirstFrameOnly (BOOL firstOnly)=0
 
virtual BOOL GetAllowUnsafeMethods () const =0
 
virtual BOOL SetAllowUnsafeMethods (BOOL allowUnsafe)=0
 
virtual BOOL GetClearOutputOnOpen () const =0
 
virtual BOOL SetClearOutputOnOpen (BOOL doClear)=0
 
- Public Member Functions inherited from FPInterfaceDesc
CoreExport FPInterfaceDesc ()
 
CoreExport FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
 
CoreExport ~FPInterfaceDesc ()
 
virtual void Init ()
 
LifetimeType LifetimeControl ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
CoreExport void LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
 
CoreExport void AppendFunction (int id,...)
 Add a new function to this interface descriptor.
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor.
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor.
 
CoreExport void SetClassDesc (ClassDesc *i_cd)
 
CoreExport va_list check_fn (va_list ap, int id)
 
CoreExport va_list scan_fn (va_list ap, int id, int index)
 
CoreExport va_list check_prop (va_list ap, int id)
 
CoreExport va_list scan_prop (va_list ap, int id, int index)
 
CoreExport va_list check_enum (va_list ap, EnumID id)
 
CoreExport va_list scan_enum (va_list ap, EnumID id, int index)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
CoreExport FPFunctionDefGetFnDef (FunctionID fid)
 
ActionTableGetActionTable ()
 
CoreExport void EnableActions (BOOL onOff)
 
virtual CoreExport HINSTANCE HInstance ()
 
virtual CoreExport const MCHARGetRsrcString (StringResID id)
 
- Public Member Functions inherited from FPInterface
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDesc ()=0
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
 
UtilExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Static Public Member Functions

static ScripterExport IMXSDebuggerGetInstance ()
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 

Additional Inherited Members

- Public Attributes inherited from FPInterfaceDesc
Interface_ID ID
 
MSTR internal_name
 
StringResID description
 
ClassDesccd
 
USHORT flags
 
Tab< FPFunctionDef * > functions
 
Tab< FPPropDef * > props
 
Tab< FPEnum * > enumerations
 
MSPluginClasspc
 
Rolloutrollout
 
ActionTableaction_table
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPInterfaceDesc
CoreExport void load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Member Enumeration Documentation

◆ state

enum state
Enumerator
idle 
getvar_getvar 
getvar_getval 
setvar_getvar 
setvar_eval_compile 
setvar_eval 
setvar_setval 
eval_compile 
eval 
attempting_break 
43 { idle,
48 }; // the possible debugger states
@ idle
Definition: IMXSDebugger.h:43
@ setvar_eval
Definition: IMXSDebugger.h:45
@ attempting_break
Definition: IMXSDebugger.h:47
@ getvar_getvar
Definition: IMXSDebugger.h:44
@ setvar_setval
Definition: IMXSDebugger.h:45
@ setvar_getvar
Definition: IMXSDebugger.h:45
@ eval
Definition: IMXSDebugger.h:46
@ eval_compile
Definition: IMXSDebugger.h:46
@ setvar_eval_compile
Definition: IMXSDebugger.h:45
@ getvar_getval
Definition: IMXSDebugger.h:44

Member Function Documentation

◆ GetInstance()

static ScripterExport IMXSDebugger * GetInstance ( )
static

◆ OpenDialog()

virtual void OpenDialog ( BOOL  breakExecution,
const MCHAR outString = nullptr,
BOOL  setFocus = FALSE 
)
pure virtual

◆ IsDialogOpen()

virtual BOOL IsDialogOpen ( )
pure virtual

◆ CloseDialog()

virtual void CloseDialog ( )
pure virtual

◆ GetDialogHwnd()

virtual HWND GetDialogHwnd ( )
pure virtual

◆ UpdateClipboardData()

virtual void UpdateClipboardData ( )
pure virtual

◆ WriteString()

virtual void WriteString ( const MCHAR str)
pure virtual

◆ WriteLine()

virtual void WriteLine ( const MCHAR str)
pure virtual

◆ BreakExecution()

virtual void BreakExecution ( const MCHAR outString = nullptr)
pure virtual

◆ ContinueExecution()

virtual void ContinueExecution ( )
pure virtual

◆ IsExecutionBroken()

virtual BOOL IsExecutionBroken ( )
pure virtual

◆ GetState()

virtual state GetState ( )
pure virtual

◆ GetThreadID()

virtual DWORD GetThreadID ( ) const
pure virtual

◆ GetAllowBreakOnThrow()

virtual BOOL GetAllowBreakOnThrow ( )
pure virtual

◆ SetAllowBreakOnThrow()

virtual BOOL SetAllowBreakOnThrow ( BOOL  breakExecution)
pure virtual

◆ GetBreakOnError()

virtual BOOL GetBreakOnError ( )
pure virtual

◆ SetBreakOnError()

virtual BOOL SetBreakOnError ( BOOL  breakExecution)
pure virtual

◆ GetBreakOnException()

virtual BOOL GetBreakOnException ( )
pure virtual

◆ SetBreakOnException()

virtual BOOL SetBreakOnException ( BOOL  breakExecution)
pure virtual

◆ GetDefaultBreakOnThrow()

virtual BOOL GetDefaultBreakOnThrow ( )
pure virtual

◆ SetDefaultBreakOnThrow()

virtual BOOL SetDefaultBreakOnThrow ( BOOL  breakExecution)
pure virtual

◆ GetIgnoreCaughtThrows()

virtual BOOL GetIgnoreCaughtThrows ( )
pure virtual

◆ SetIgnoreCaughtThrows()

virtual BOOL SetIgnoreCaughtThrows ( BOOL  ignore)
pure virtual

◆ GetIgnoreCaughtErrors()

virtual BOOL GetIgnoreCaughtErrors ( )
pure virtual

◆ SetIgnoreCaughtErrors()

virtual BOOL SetIgnoreCaughtErrors ( BOOL  ignore)
pure virtual

◆ GetIgnoreCaughtExceptions()

virtual BOOL GetIgnoreCaughtExceptions ( )
pure virtual

◆ SetIgnoreCaughtExceptions()

virtual BOOL SetIgnoreCaughtExceptions ( BOOL  ignore)
pure virtual

◆ GetEnabledInQuietMode()

virtual BOOL GetEnabledInQuietMode ( )
pure virtual

◆ SetEnabledInQuietMode()

virtual BOOL SetEnabledInQuietMode ( BOOL  ignore)
pure virtual

◆ GetEnabledInNetRender()

virtual BOOL GetEnabledInNetRender ( )
pure virtual

◆ SetEnabledInNetRender()

virtual BOOL SetEnabledInNetRender ( BOOL  ignore)
pure virtual

◆ GetStayOnTop()

virtual BOOL GetStayOnTop ( )
pure virtual

◆ SetStayOnTop()

virtual BOOL SetStayOnTop ( BOOL  ignore)
pure virtual

◆ GetCommandTimeoutPeriod()

virtual DWORD GetCommandTimeoutPeriod ( )
pure virtual

◆ SetCommandTimeoutPeriod()

virtual DWORD SetCommandTimeoutPeriod ( DWORD  millisecs)
pure virtual

◆ GetBreakTimeoutPeriod()

virtual DWORD GetBreakTimeoutPeriod ( )
pure virtual

◆ SetBreakTimeoutPeriod()

virtual DWORD SetBreakTimeoutPeriod ( DWORD  millisecs)
pure virtual

◆ GetGCTimeoutPeriod()

virtual DWORD GetGCTimeoutPeriod ( )
pure virtual

◆ SetGCTimeoutPeriod()

virtual DWORD SetGCTimeoutPeriod ( DWORD  millisecs)
pure virtual

◆ GetBreakCyclePeriod()

virtual DWORD GetBreakCyclePeriod ( )
pure virtual

◆ SetBreakCyclePeriod()

virtual DWORD SetBreakCyclePeriod ( DWORD  millisecs)
pure virtual

◆ GetShowGlobalConstants()

virtual BOOL GetShowGlobalConstants ( )
pure virtual

◆ SetShowGlobalConstants()

virtual BOOL SetShowGlobalConstants ( BOOL  ignore)
pure virtual

◆ GetShowFirstFrameOnly()

virtual BOOL GetShowFirstFrameOnly ( )
pure virtual

◆ SetShowFirstFrameOnly()

virtual BOOL SetShowFirstFrameOnly ( BOOL  firstOnly)
pure virtual

◆ GetAllowUnsafeMethods()

virtual BOOL GetAllowUnsafeMethods ( ) const
pure virtual

◆ SetAllowUnsafeMethods()

virtual BOOL SetAllowUnsafeMethods ( BOOL  allowUnsafe)
pure virtual

◆ GetClearOutputOnOpen()

virtual BOOL GetClearOutputOnOpen ( ) const
pure virtual

◆ SetClearOutputOnOpen()

virtual BOOL SetClearOutputOnOpen ( BOOL  doClear)
pure virtual