Class used to handle some custom controls options. More...

#include <custcont.h>

Inheritance diagram for ICustomControlsOptions:

Public Member Functions
virtual void	SetPrintIconPaths (bool printIconPaths, bool persist)=0
	Set to print or not the icons paths and to persist or not that option.

virtual bool	GetPrintIconPaths () const =0
	Indicates whether icon paths are printed to the listener.

virtual void	SetPrintTextClippingIssues (bool printClippingErrors, bool persist)=0
	Set to print or not ui text-clipping errors and to persist or not that option.

virtual bool	GetPrintTextClippingIssues () const =0
	Indicates whether ui text-clipping errors are printed to the listener.

virtual int	GetTextClippingIssuesSensitivityX () const =0
	Get the x sensitivity for reporting test-clipping errors.

virtual void	SetTextClippingIssuesSensitivityX (int val, bool persist)=0
	Set the x sensitivity for reporting test-clipping errors and to persist or not.

virtual int	GetTextClippingIssuesSensitivityY () const =0
	Get the y sensitivity for reporting test-clipping errors.

virtual void	SetTextClippingIssuesSensitivityY (int val, bool persist)=0
	Set the y sensitivity for reporting test-clipping errors and to persist or not.

virtual float	GetUIUserScaleFactor () const =0
	Gets the additional user UI scaling factor.

virtual void	SetUIUserScaleFactor (float userScaleFactor)=0
	Sets the additional UI scaling factor.

virtual void	SetPrintToolClipInfo (bool printToolClipInfo, bool persist)=0
	Set to print or not the tool clip information and to persist or not that option.

virtual bool	GetPrintToolClipInfo () const =0
	Indicates whether tool clip information is printed to the listener.

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.

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)

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 BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDesc ()=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 ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.

UtilExport BaseInterface *	GetInterface (Interface_ID id) override

virtual UtilExport Interface_ID	GetID ()

virtual LifetimeType	LifetimeControl ()

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.

virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.

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.

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.

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.

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 void *	operator 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 void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.

static UtilExport void *	aligned_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.

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)

Detailed Description

Class used to handle some custom controls options.

Member Function Documentation

◆ SetPrintIconPaths()

virtual void SetPrintIconPaths	(	bool	printIconPaths,
		bool	persist
	)

pure virtual

Set to print or not the icons paths and to persist or not that option.

◆ GetPrintIconPaths()

virtual bool GetPrintIconPaths ( ) const

pure virtual

Indicates whether icon paths are printed to the listener.

◆ SetPrintTextClippingIssues()

virtual void SetPrintTextClippingIssues	(	bool	printClippingErrors,
		bool	persist
	)

pure virtual

Set to print or not ui text-clipping errors and to persist or not that option.

◆ GetPrintTextClippingIssues()

virtual bool GetPrintTextClippingIssues ( ) const

pure virtual

Indicates whether ui text-clipping errors are printed to the listener.

◆ GetTextClippingIssuesSensitivityX()

virtual int GetTextClippingIssuesSensitivityX ( ) const

pure virtual

Get the x sensitivity for reporting test-clipping errors.

Differences greater than or equal to this value will be reported

◆ SetTextClippingIssuesSensitivityX()

virtual void SetTextClippingIssuesSensitivityX	(	int	val,
		bool	persist
	)

pure virtual

Set the x sensitivity for reporting test-clipping errors and to persist or not.

◆ GetTextClippingIssuesSensitivityY()

virtual int GetTextClippingIssuesSensitivityY ( ) const

pure virtual

Get the y sensitivity for reporting test-clipping errors.

Differences greater than or equal to this value will be reported

◆ SetTextClippingIssuesSensitivityY()

virtual void SetTextClippingIssuesSensitivityY	(	int	val,
		bool	persist
	)

pure virtual

Set the y sensitivity for reporting test-clipping errors and to persist or not.

◆ GetUIUserScaleFactor()

virtual float GetUIUserScaleFactor ( ) const

pure virtual

Gets the additional user UI scaling factor.

Returns: The users UI scaling factor.

See also: SetUIUserScaleFactor, MaxSDK::GetUIScaleFactor( int monitorID = -1 )

◆ SetUIUserScaleFactor()

virtual void SetUIUserScaleFactor ( float userScaleFactor )

pure virtual

Sets the additional UI scaling factor.

Parameters

[in] userScaleFactor - The new scaling factor. If this value is set to some positive value above zero, it will affect the UI scaling of certain 3dsmax UI elements.

See also: GetUIUserScaleFactor(), MaxSDK::GetUIScaleFactor( int monitorID = -1 )

◆ SetPrintToolClipInfo()

virtual void SetPrintToolClipInfo	(	bool	printToolClipInfo,
		bool	persist
	)

pure virtual

Set to print or not the tool clip information and to persist or not that option.

◆ GetPrintToolClipInfo()

virtual bool GetPrintToolClipInfo ( ) const

pure virtual

Indicates whether tool clip information is printed to the listener.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetPrintIconPaths()

◆ GetPrintIconPaths()

◆ SetPrintTextClippingIssues()

◆ GetPrintTextClippingIssues()

◆ GetTextClippingIssuesSensitivityX()

◆ SetTextClippingIssuesSensitivityX()

◆ GetTextClippingIssuesSensitivityY()

◆ SetTextClippingIssuesSensitivityY()

◆ GetUIUserScaleFactor()

◆ SetUIUserScaleFactor()

◆ SetPrintToolClipInfo()

◆ GetPrintToolClipInfo()