Detailed Description

See also:: Class ColorPicker, Class HSVCallback, Class Class_ID, Class IPoint2, DWORD--COLORREF Color Format..

Description:: This class is available in release 3.0 and later only.

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 choosen 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

#include <hsv.h>

Inheritance diagram for ColPick:

Public Member Functions
virtual INT_PTR	ModalColorPicker (HWND hwndOwner, DWORD lpc, IPoint2 spos, HSVCallback callBack, MCHAR name)=0
virtual INT_PTR	ModalColorPicker (HWND hwndOwner, AColor lpc, IPoint2 spos, HSVCallback callBack, MCHAR name)
virtual ColorPicker *	CreateColorPicker (HWND hwndOwner, DWORD initColor, IPoint2 spos, HSVCallback pcallback, MCHAR *name, BOOL isObjectColor=FALSE)=0
virtual ColorPicker *	CreateColorPicker (HWND hwndOwner, AColor initColor, IPoint2 spos, HSVCallback pcallback, 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

Member Function Documentation

virtual INT_PTR ModalColorPicker	(	HWND	hwndOwner,
		DWORD *	lpc,
		IPoint2 *	spos,
		HSVCallback *	callBack,
		MCHAR *	name
	)		`[pure virtual]`

virtual INT_PTR ModalColorPicker	(	HWND	hwndOwner,
		AColor *	lpc,
		IPoint2 *	spos,
		HSVCallback *	callBack,
		MCHAR *	name
	)		`[inline, virtual]`

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

         {return 0;}

virtual ColorPicker* CreateColorPicker	(	HWND	hwndOwner,
		DWORD	initColor,
		IPoint2 *	spos,
		HSVCallback *	pcallback,
		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,
		MCHAR *	name,
		BOOL	isObjectColor = `FALSE`
	)		`[inline, 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.

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.

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