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

This class provides methods that are called when using the color picker. More...

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

Inheritance diagram for ColorPickerCallback:

Public Member Functions

virtual ~ColorPickerCallback ()
 Destructor.
virtual void ButtonDown ()
 This method is called when the user has pressed the mouse button.
virtual void ButtonUp (BOOL accept)
 This method is called when the user has released the mouse button.
virtual void ColorChanged (AColor col, BOOL buttonUp)=0
 This callback proc gets called after the user changes the color.
virtual void BeingDestroyed (IPoint2 pos)=0
 This callback proc gets called when the color picker is closed.
virtual void OnOK ()
 This callback proc gets called when user click OK to confirm the color modification.
virtual void OnCancel ()
 This callback proc gets called when user click Cancel to cancel the color modification.

Additional Inherited Members

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
static UtilExport voidaligned_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.
static UtilExport voidmalloc_nullchecked (size_t size)
 Allocates memory via malloc without invoking 3dsmax's out of memory handler with potential CER.
static UtilExport voidcalloc_nullchecked (size_t num, size_t size)
 Allocates memory via calloc without invoking 3dsmax's out of memory handler with potential CER.
static UtilExport voidrealloc_nullchecked (void *memblock, size_t size)
 Reallocates memory via realloc without invoking 3dsmax's out of memory handler with potential CER.
static UtilExport voidLocalAlloc_nullchecked (unsigned int uFlags, size_t size)
 Allocates memory via LocalAlloc without invoking 3dsmax's out of memory handler with potential CER.

Detailed Description

This class provides methods that are called when using the color picker.

This is the only way to get currently selected color from modeless color pickers. Although the modal color picker returns the final color when user hits OK, you can still use this callback class with modeless color pickers too so that you can get interactive updates. All methods of this class are virtual.

See also
Class ColorPicker, ModalColorPicker, CreateColorPicker

Constructor & Destructor Documentation

◆ ~ColorPickerCallback()

virtual ~ColorPickerCallback ( )
inlinevirtual

Destructor.

40{;}

Member Function Documentation

◆ ButtonDown()

virtual void ButtonDown ( )
inlinevirtual

This method is called when the user has pressed the mouse button.

43{;}

◆ ButtonUp()

virtual void ButtonUp ( BOOL accept)
inlinevirtual

This method is called when the user has released the mouse button.

Parameters
[in]accept
TRUE if the mouse button was released normally; FALSE if the user canceled.
50{ (void)accept; }
MAXMEM_EXTERN_C UtilExport void(__cdecl *MAX_free)(void *memblock)

◆ ColorChanged()

virtual void ColorChanged ( AColor col,
BOOL buttonUp )
pure virtual

This callback proc gets called after the user changes the color.

Implement this method to handle interactive updates.

Parameters
[in]colThe new color. If the alpha channel is not needed, you can cast it into the Color class.
[in]buttonUpIndicates if the mouse button has been released (is up). TRUE if the button is up; FALSE if it is down.

◆ BeingDestroyed()

virtual void BeingDestroyed ( IPoint2 pos)
pure virtual

This callback proc gets called when the color picker is closed.

If you're holding a pointer to to the color picker, this is a good opportunity to set the pointer to null.

Parameters
[in]posThe last screen position of the color picker before it was closed.

◆ OnOK()

virtual void OnOK ( )
inlinevirtual

This callback proc gets called when user click OK to confirm the color modification.

72{;}

◆ OnCancel()

virtual void OnCancel ( )
inlinevirtual

This callback proc gets called when user click Cancel to cancel the color modification.

76{;}