Public Types | Public Member Functions

IContainerPreferences Class Reference

This reference page is linked to from the following overview topics: Major New Features, SDK Change Details.


Search for all occurrences

Detailed Description

This interface provides access to the container preferences.

#include <IContainerManager.h>

Inheritance diagram for IContainerPreferences:
Inheritance graph
[legend]

List of all members.

Public Types

enum   DisplayStatusOverride { eAlways = 0x0, eNever, ePerContainer }
 

Possible values for global container status display.

More...

Public Member Functions

virtual
IContainerObject13::AccessType 
SaveAsPreviousAccessType () const =0
  Returns the access type that will be used when a container is saved in 3ds max 2010 format.
virtual void  SetSaveAsPreviousAccessType (IContainerObject13::AccessType accessType)=0
  Sets the access type that will be used when a container is saved in 3ds max 2010 format.
virtual DisplayStatusOverride  DisplayStatus () const =0
  Returns the global override of individual container viewport status display.
virtual void  SetDisplayStatus (DisplayStatusOverride displayStatus)=0
  Sets a potential override of individual container viewport status display.
virtual bool  NoUpdateCheck () const =0
  Returns whether automatic detection of out of date containers is set.
virtual void  SetNoUpdateCheck (bool noUpdateCheck)=0
  Sets automatic detection of out of date containers.
virtual bool  UpdateOnLoad () const =0
  Returns whether an eventual out of date source definition will be updated on load.
virtual void  SetUpdateOnLoad (bool updateOnLoad)=0
  Sets whether an eventual out of date source definition will be updated on load.
virtual bool  UpdateOnReload () const =0
  Returns whether an eventual out of date source definition will be updated on reload.
virtual void  SetUpdateOnReload (bool updateOnReload)=0
  Sets whether an eventual out of date source definition will be updated on reload.
virtual float  StatusUpdateInterval () const =0
  Returns the time interval between container status updates, in seconds.
virtual void  SetStatusUpdateInterval (float statusInterval)=0
  Sets the time interval between container status updates, in seconds.

Member Enumeration Documentation

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.


Member Function Documentation

virtual IContainerObject13::AccessType SaveAsPreviousAccessType ( ) const [pure virtual]

Returns the access type that will be used when a container is saved in 3ds max 2010 format.

virtual void SetSaveAsPreviousAccessType ( IContainerObject13::AccessType  accessType ) [pure virtual]

Sets the access type that will be used when a container is saved in 3ds max 2010 format.

virtual DisplayStatusOverride DisplayStatus ( ) const [pure virtual]

Returns the global override of individual container viewport status display.

See also:
DisplayStatusOverride
virtual void SetDisplayStatus ( DisplayStatusOverride  displayStatus ) [pure virtual]

Sets a potential override of individual container viewport status display.

See also:
DisplayStatusOverride
virtual bool NoUpdateCheck ( ) const [pure virtual]

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

virtual void SetNoUpdateCheck ( bool  noUpdateCheck ) [pure virtual]

Sets automatic detection of out of date containers.

virtual bool UpdateOnLoad ( ) const [pure virtual]

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

virtual void SetUpdateOnLoad ( bool  updateOnLoad ) [pure virtual]

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

virtual bool UpdateOnReload ( ) const [pure virtual]

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

virtual void SetUpdateOnReload ( bool  updateOnReload ) [pure virtual]

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

virtual float StatusUpdateInterval ( ) const [pure virtual]

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

virtual void SetStatusUpdateInterval ( float  statusInterval ) [pure virtual]

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


IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences
IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences IContainerPreferences