3ds Max C++ API Reference
IContainerPreferences Class Referenceabstract

This interface provides access to the container preferences. More...

#include <IContainerManager.h>

+ Inheritance diagram for IContainerPreferences:

Public Types

enum  DisplayStatusOverride { eAlways = 0x0 , eNever , ePerContainer }
 Possible values for global container status display.
More...
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 

Public Member Functions

virtual MAX_DEPRECATED IContainerObject13::AccessType SaveAsPreviousAccessType () const final
 
virtual MAX_DEPRECATED void SetSaveAsPreviousAccessType (IContainerObject13::AccessType) final
 
virtual DisplayStatusOverride DisplayStatus () const =0
 Returns the global override of individual container viewport status display. More...
 
virtual void SetDisplayStatus (DisplayStatusOverride displayStatus)=0
 Sets a potential override of individual container viewport status display. More...
 
virtual bool NoUpdateCheck () const =0
 Returns whether automatic detection of out of date containers is set. More...
 
virtual void SetNoUpdateCheck (bool noUpdateCheck)=0
 Sets automatic detection of out of date containers. More...
 
virtual bool UpdateOnLoad () const =0
 Returns whether an eventual out of date source definition will be updated on load. More...
 
virtual void SetUpdateOnLoad (bool updateOnLoad)=0
 Sets whether an eventual out of date source definition will be updated on load. More...
 
virtual bool UpdateOnReload () const =0
 Returns whether an eventual out of date source definition will be updated on reload. More...
 
virtual void SetUpdateOnReload (bool updateOnReload)=0
 Sets whether an eventual out of date source definition will be updated on reload. More...
 
virtual float StatusUpdateInterval () const =0
 Returns the time interval between container status updates, in seconds. More...
 
virtual void SetStatusUpdateInterval (float statusInterval)=0
 Sets the time interval between container status updates, in seconds. 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 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. 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)
 
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 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 BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Additional Inherited Members

- 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
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. More...
 
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. More...
 
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. 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_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...
 
- 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)
 

Detailed Description

This interface provides access to the container preferences.

Member Enumeration Documentation

◆ DisplayStatusOverride

Possible values for global container status display.

Enumerator
eAlways 

Always display status, regardless of individual container setting.

eNever 

Never display status, regardless of individual container setting.

ePerContainer 

Display status according to individual container setting.

82  {
84  eAlways = 0x0,
86  eNever,
89  };
@ ePerContainer
Display status according to individual container setting.
Definition: IContainerManager.h:88
@ eAlways
Always display status, regardless of individual container setting.
Definition: IContainerManager.h:84
@ eNever
Never display status, regardless of individual container setting.
Definition: IContainerManager.h:86

Member Function Documentation

◆ SaveAsPreviousAccessType()

virtual MAX_DEPRECATED IContainerObject13::AccessType SaveAsPreviousAccessType ( ) const
inlinefinalvirtual
Deprecated:
This has been deprecated as of 3ds Max 2023
92 { return {}; }

◆ SetSaveAsPreviousAccessType()

virtual MAX_DEPRECATED void SetSaveAsPreviousAccessType ( IContainerObject13::AccessType  )
inlinefinalvirtual
Deprecated:
This has been deprecated as of 3ds Max 2023
94 {}

◆ DisplayStatus()

virtual DisplayStatusOverride DisplayStatus ( ) const
pure virtual

Returns the global override of individual container viewport status display.

See also
DisplayStatusOverride

◆ SetDisplayStatus()

virtual void SetDisplayStatus ( DisplayStatusOverride  displayStatus)
pure virtual

Sets a potential override of individual container viewport status display.

See also
DisplayStatusOverride

◆ NoUpdateCheck()

virtual bool NoUpdateCheck ( ) const
pure virtual

Returns whether automatic detection of out of date containers is set.

◆ SetNoUpdateCheck()

virtual void SetNoUpdateCheck ( bool  noUpdateCheck)
pure virtual

Sets automatic detection of out of date containers.

◆ UpdateOnLoad()

virtual bool UpdateOnLoad ( ) const
pure virtual

Returns whether an eventual out of date source definition will be updated on load.

◆ SetUpdateOnLoad()

virtual void SetUpdateOnLoad ( bool  updateOnLoad)
pure virtual

Sets whether an eventual out of date source definition will be updated on load.

◆ UpdateOnReload()

virtual bool UpdateOnReload ( ) const
pure virtual

Returns whether an eventual out of date source definition will be updated on reload.

◆ SetUpdateOnReload()

virtual void SetUpdateOnReload ( bool  updateOnReload)
pure virtual

Sets whether an eventual out of date source definition will be updated on reload.

◆ StatusUpdateInterval()

virtual float StatusUpdateInterval ( ) const
pure virtual

Returns the time interval between container status updates, in seconds.

◆ SetStatusUpdateInterval()

virtual void SetStatusUpdateInterval ( float  statusInterval)
pure virtual

Sets the time interval between container status updates, in seconds.