IScriptSecurityManager Class Reference

#include <IScriptSecurityManager.h>

Class Description

Interface class for the Script Security Manager.

Interface for the Script Security Manager class. This class has only one instance and is responsible for specifying behavior when loading/saving scripts from/to a scene file.

Inheritance diagram for IScriptSecurityManager:

Public Types
enum	SceneEmbeddedScriptUsage {   kMXSScriptedCADef, kMXSPersistentCallback, kScriptControl, kClipState,   kCrowd, kScriptedBehavior, kCrowdTransition, kOperatorMaxscript,   kBirthScript, kScriptOperator, kScriptTest, kPFSourceEveryStepUpdateScript,   kPFSourceFinalStepUpdateScript, kFloatWire, kSceneOther, kEmbeddedScriptUsageCount }
	Scene File Embedded Script Usage. More...
enum	NonSceneEmbeddedScriptUsage { kSVGVectorBitmap, kNonSceneOther, kNonEmbeddedScriptUsageCount }
	Non-scene File Embedded Script Usage. More...
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual bool	IsLoadSaveOfSceneScriptsEnabled () const =0
	Gets whether loading and saving of scene file scripts is enabled. More...
virtual void	EnableLoadSaveOfSceneScripts (bool enabled)=0
	Sets whether loading and saving of scene file scripts is enabled. More...
virtual bool	IsLoadSaveOfMAXScriptPersistentGlobalsEnabled () const =0
	Gets whether loading and saving of MAXScript persistent global variables from scene files is enabled. More...
virtual void	EnableLoadSaveOfMAXScriptPersistentGlobals (bool enabled)=0
	Sets whether loading and saving of MAXScript persistent global variables from scene files is enabled. More...
virtual void	LogSceneEmbeddedScriptFoundDuringLoad (SceneEmbeddedScriptUsage usage)=0
	Log that scene file script with specified usage was found while loaded a scene file. Analytics reported per scene file load or merge. More...
virtual void	LogNonSceneEmbeddedScriptFound (NonSceneEmbeddedScriptUsage usage)=0
	Log that data file with embedded script with specified usage was found. Analytics reported per 3ds Max session. More...
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 BaseInterface *	GetInterface (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. More...
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...
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)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
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)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Static Public Member Functions
static ScriptSecurityManagerExport IScriptSecurityManager *	GetInstance ()
	Returns the only instance of this manager. More...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
static UtilExport void *	operator 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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Additional Inherited Members
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_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)
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()

Member Enumeration Documentation

enum SceneEmbeddedScriptUsage

Scene File Embedded Script Usage.

Enumerator
kMXSScriptedCADef	MAXScript scripted custom attribute definition.
kMXSPersistentCallback	MAXScript persistent callback.
kScriptControl	ScriptControl : Controller - <script_controller>.script.
kClipState	ClipState : ReferenceTarget : <ClipState>.script.
kCrowd	Crowd : helper : <Crowd>.script.
kScriptedBehavior	Scripted_Behavior : MAXObject : <scripted_behavior>.script.
kCrowdTransition	CrowdTransition : MAXObject : <crowdtransition>.script.
kOperatorMaxscript	Operator_Maxscript : IDataChannelEngineClass : <Operator_Maxscript>.script.
kBirthScript	Birth_Script : Helper : <Birth_Script>.Proceed_Script.
kScriptOperator	Script_Operator : Helper : <Script_Operator>.Proceed_Script.
kScriptTest	Script_Test : Helper : <Script_Test>.Proceed_Script.
kPFSourceEveryStepUpdateScript	PF_Source : GeometryClass : <PF_Source>.Every_Step_Update_Script.
kPFSourceFinalStepUpdateScript	PF_Source : GeometryClass : <PF_Source>.Final_Step_Update_Script.
kFloatWire	Float_Wire : FloatController : <Float_Wire>.getExprText index.
kSceneOther	Scene Other.
kEmbeddedScriptUsageCount

        {
            kMXSScriptedCADef,                  
            kMXSPersistentCallback,             
            kScriptControl,                     
            kClipState,                         
            kCrowd,                             
            kScriptedBehavior,                  
            kCrowdTransition,                   
            kOperatorMaxscript,                 
            kBirthScript,                       
            kScriptOperator,                    
            kScriptTest,                        
            kPFSourceEveryStepUpdateScript,     
            kPFSourceFinalStepUpdateScript,     
            kFloatWire,                         
            kSceneOther,                        
            kEmbeddedScriptUsageCount
        };

enum NonSceneEmbeddedScriptUsage

Non-scene File Embedded Script Usage.

Enumerator
kSVGVectorBitmap	svg vector bitmap
kNonSceneOther	Non-scene Other.
kNonEmbeddedScriptUsageCount

        {
            kSVGVectorBitmap,                   
            kNonSceneOther,                     
            kNonEmbeddedScriptUsageCount
        };

Member Function Documentation

virtual bool IsLoadSaveOfSceneScriptsEnabled ( ) const

pure virtual

Gets whether loading and saving of scene file scripts is enabled.

virtual void EnableLoadSaveOfSceneScripts ( bool  enabled )

pure virtual

Sets whether loading and saving of scene file scripts is enabled.

virtual bool IsLoadSaveOfMAXScriptPersistentGlobalsEnabled ( ) const

pure virtual

Gets whether loading and saving of MAXScript persistent global variables from scene files is enabled.

virtual void EnableLoadSaveOfMAXScriptPersistentGlobals ( bool  enabled )

pure virtual

Sets whether loading and saving of MAXScript persistent global variables from scene files is enabled.

virtual void LogSceneEmbeddedScriptFoundDuringLoad ( SceneEmbeddedScriptUsage  usage )

pure virtual

Log that scene file script with specified usage was found while loaded a scene file. Analytics reported per scene file load or merge.

virtual void LogNonSceneEmbeddedScriptFound ( NonSceneEmbeddedScriptUsage  usage )

pure virtual

Log that data file with embedded script with specified usage was found. Analytics reported per 3ds Max session.

static ScriptSecurityManagerExport IScriptSecurityManager* GetInstance ( )

static

Returns the only instance of this manager.