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

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/ColorPicker.h>

Classes

struct  UnderlyingColorData
 Structure used to exchange underlying color data between the color picker and the window under the mouse cursor when the user is using the eyedropper tool to sample underlying scene colors. More...

Public Member Functions

 IColorPickerMgr ()=default
virtual ~IColorPickerMgr ()=default
virtual ColPickSetCurColPick (ColPick *colpick)=0
 Sets system-wide color picker plugin to be used.
virtual ColPickGetCurColPick () const =0
 Returns the current color picker plugin instance.

Static Public Member Functions

static CoreExport IColorPickerMgrGetInstance ()
 returns the singleton instance of this class.
static CoreExport UINT GetSampleUnderlyingColorMsgID ()
 Returns the message ID used to sample underlying colors.

Static Public Attributes

static constexpr const wchar_t * SAMPLE_UNDERLYING_COLOR_MESSAGE_STR
 Name of the system-wide message used to sample the underlying color at a given screen position.

Constructor & Destructor Documentation

◆ IColorPickerMgr()

IColorPickerMgr ( )
default

◆ ~IColorPickerMgr()

virtual ~IColorPickerMgr ( )
virtualdefault

Member Function Documentation

◆ GetInstance()

CoreExport IColorPickerMgr * GetInstance ( )
static

returns the singleton instance of this class.

◆ SetCurColPick()

virtual ColPick * SetCurColPick ( ColPick * colpick)
pure virtual

Sets system-wide color picker plugin to be used.

This is normally determined by user preference in the Preferences dialog and Plug-ins normally should not call this directly.

Parameters
[in]colpickPointer to the color picker plugin instance to make current.
Returns
Pointer to the previous color picker plugin instance.

◆ GetCurColPick()

virtual ColPick * GetCurColPick ( ) const
pure virtual

Returns the current color picker plugin instance.

Returns
Pointer to the current color picker plugin instance.