ColPick Class Reference

#include <hsv.h>

Class Description

See also

Class ColorPicker, Class HSVCallback, Class Class_ID, Class IPoint2, DWORD–COLORREF Color Format..

Description:

This is the base class for the creation of plug-in color selectors. The list of available color pickers appear in the 3ds Max user interface in the General page of the Preferences dialog. The chosen picker will be called whenever a user clicks on a 3ds Max color swatch control.

Plug-In Information:

Class Defined In HSV.H

Super Class ID COLPICK_CLASS_ID

Standard File Name Extension DLU

Extra Include File Needed HSV.H

Inheritance diagram for ColPick:

Public Member Functions
virtual INT_PTR	ModalColorPicker (HWND hwndOwner, DWORD *lpc, IPoint2 *spos, HSVCallback *callBack, const MCHAR *name)=0
virtual INT_PTR	ModalColorPicker (HWND hwndOwner, AColor *lpc, IPoint2 *spos, HSVCallback *callBack, const MCHAR *name)
virtual ColorPicker *	CreateColorPicker (HWND hwndOwner, DWORD initColor, IPoint2 *spos, HSVCallback *pcallback, const MCHAR *name, BOOL isObjectColor=FALSE)=0
virtual ColorPicker *	CreateColorPicker (HWND hwndOwner, AColor initColor, IPoint2 *spos, HSVCallback *pcallback, const MCHAR *name, BOOL isObjectColor=FALSE)
virtual const MCHAR *	ClassName ()=0
virtual Class_ID	ClassID ()=0
virtual void	DeleteThis ()=0
virtual INT_PTR	Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0)=0
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

Additional Inherited Members
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...

Member Function Documentation

virtual INT_PTR ModalColorPicker ( HWND  hwndOwner, DWORD *  lpc, IPoint2 *  spos, HSVCallback *  callBack, const MCHAR *  name  )

pure virtual

virtual INT_PTR ModalColorPicker ( HWND  hwndOwner, AColor *  lpc, IPoint2 *  spos, HSVCallback *  callBack, const MCHAR *  name  )

inlinevirtual

Remarks

This method is called to bring up the modal color picker.

Parameters:

HWND hwndOwner

The owning window handle

DWORD *lpc

A pointer to the color to be edited. See DWORD COLORREF Format.

IPoint2 *spos

The starting position of the dialog. This is set to ending position on return.

HSVCallback *callBack

This callback is called whenever color changes.

MCHAR *name

The name of color being edited

Returns

TRUE if the user pressed OK; FALSE on cancel.

         {return 0;}

virtual ColorPicker* CreateColorPicker ( HWND  hwndOwner, DWORD  initColor, IPoint2 *  spos, HSVCallback *  pcallback, const MCHAR *  name, BOOL  isObjectColor = FALSE  )

pure virtual

Remarks

This method is called to create and return a ColorPicker object for the modeless color picker.

Parameters:

HWND hwndOwner

The owning window handle.

DWORD initColor

The inital value of the color. See DWORD COLORREF Format.

IPoint2* spos

The starting position of dialog.

HSVCallback *pcallback

This callback is called whenever color changes.

MCHAR *name

The name of color being edited.

BOOL isObjectColor=FALSE

This indicates the color picker is being used for the object color in the command panel, and the color picker then displays the Add Color button

virtual ColorPicker* CreateColorPicker ( HWND  hwndOwner, AColor  initColor, IPoint2 *  spos, HSVCallback *  pcallback, const MCHAR *  name, BOOL  isObjectColor = FALSE  )

inlinevirtual

Remarks

This method is called to create and return a ColorPicker object for the modeless color picker.

Parameters:

HWND hwndOwner

The owning window handle.

AColor initColor

The inital value of the color.

IPoint2* spos

The starting position of dialog.

HSVCallback *pcallback

This callback is called whenever color changes.

MCHAR *name

The name of color being edited.

BOOL isObjectColor=FALSE

This indicates the color picker is being used for the object color in the command panel, and the color picker then displays the Add Color button

                                 {return NULL;}

virtual const MCHAR* ClassName ( )

pure virtual

Remarks

Returns the name of the class. This name appears in the drop down list of color picker choices.

virtual Class_ID ClassID ( )

pure virtual

Remarks

Returns the unique ClassID of this plug-in. The Class_ID for the default color picker is Class_ID(DEFAULT_COLPICK_CLASS_ID,0).

virtual void DeleteThis ( )

pure virtual

Remarks

This method is called to delete this instance of the plug-in class.

virtual INT_PTR Execute ( int  cmd, ULONG_PTR  arg1 = 0, ULONG_PTR  arg2 = 0, ULONG_PTR  arg3 = 0  )

pure virtual

Remarks

This method is used for future expansion and is currently not used.