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

#include <rollouts.h>

+ Inheritance diagram for PickerControlMode:

Public Member Functions

 PickerControlMode (PickerControlFilter *ifilter, const MCHAR *imsg, PickerControl *ipick)
 
 ~PickerControlMode ()
 
BOOL HitTest (IObjParam *ip, HWND hWnd, ViewExp *vpt, IPoint2 m, int flags) override
 
BOOL Pick (IObjParam *ip, ViewExp *vpt) override
 
PickNodeCallbackGetFilter () override
 
BOOL RightClick (IObjParam *ip, ViewExp *vpt) override
 
void EnterMode (IObjParam *ip) override
 
void ExitMode (IObjParam *ip) override
 
- Public Member Functions inherited from PickModeCallback
virtual BOOL HitTest (IObjParam *ip, HWND hWnd, ViewExp *vpt, IPoint2 m, int flags)=0
 
virtual BOOL Pick (IObjParam *ip, ViewExp *vpt)=0
 
virtual CoreExport BOOL PickAnimatable (Animatable *anim)
 
virtual BOOL RightClick (IObjParam *ip, ViewExp *vpt)
 
virtual void EnterMode (IObjParam *ip)
 
virtual void ExitMode (IObjParam *ip)
 
virtual HCURSOR GetDefCursor (IObjParam *ip)
 
virtual HCURSOR GetHitCursor (IObjParam *ip)
 
virtual PickNodeCallbackGetFilter ()
 
virtual PickAnimatableCallbackGetAnimatableFilter ()
 
virtual BOOL AllowMultiSelect ()
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Public Attributes

PickerControlFilterpick_filter
 
MSTR msg
 
PickerControlpicker
 

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.
 

Constructor & Destructor Documentation

◆ PickerControlMode()

PickerControlMode ( PickerControlFilter ifilter,
const MCHAR imsg,
PickerControl ipick 
)

◆ ~PickerControlMode()

Member Function Documentation

◆ HitTest()

BOOL HitTest ( IObjParam ip,
HWND  hWnd,
ViewExp vpt,
IPoint2  m,
int  flags 
)
overridevirtual
Remarks
This method is called whenever the pick mode needs to hit test.
Parameters:
IObjParam *ip

An interface pointer available to call functions defined by 3ds Max.

HWND hWnd

The window handle.

ViewExp *vpt

An interface pointer that may be used to call methods associated with the viewports.

IPoint2 m

Point to check in screen coordinates.

int flags

Scene and Node Hit Testing Flags.
Returns
Return TRUE if something was hit; otherwise FALSE.
Sample Code:
// This implementation use the Interface::PickNode method

// to perform the hit test.

{
return ip->PickNode(hWnd,m,&thePickFilt)? TRUE:FALSE;
}

Implements PickModeCallback.

◆ Pick()

BOOL Pick ( IObjParam ip,
ViewExp vpt 
)
overridevirtual
Remarks
This method is called when the user picks something.
Parameters:
IObjParam *ip

An interface pointer available to call functions defined by 3ds Max.

ViewExp *vpt

An interface pointer that may be used to call methods associated with the viewports. The vpt should have the result of the hit test in it.
Returns
Return TRUE to end the pick mode; FALSE to stay in the pick mode. Note that returning TRUE will set the command mode to MOVE. When a plug-in is in the create branch, setting the command mode to move ends the creation process.

Implements PickModeCallback.

◆ GetFilter()

PickNodeCallback * GetFilter ( )
inlineoverridevirtual
Remarks
This method is called if the user hits the H key while in your pick mode. You can provide a filter to filter the name list. See Class PickNodeCallback.
Returns
A pointer to an instance of PickNodeCallback.
Default Implementation:
{return NULL;}

Reimplemented from PickModeCallback.

788{ return pick_filter; }
PickerControlFilter * pick_filter
Definition: rollouts.h:779

◆ RightClick()

BOOL RightClick ( IObjParam ip,
ViewExp vpt 
)
inlineoverridevirtual
Remarks
This method is called when the user right-clicks or presses ESC.
Parameters:
IObjParam *ip

An interface pointer available to call functions defined by 3ds Max.

ViewExp *vpt

An interface pointer that may be used to call methods associated with the viewports. The vpt should have the result of the hit test in it.
Returns
TRUE to end the pick mode, FALSE to continue picking.
Default Implementation:
{ return FALSE; }

Reimplemented from PickModeCallback.

789{ return TRUE; }

◆ EnterMode()

void EnterMode ( IObjParam ip)
overridevirtual
Remarks
Called when the mode is entered. The developer may provide any pre-processing here.
Parameters:
IObjParam *ip

An interface pointer available to call functions defined by 3ds Max.

Reimplemented from PickModeCallback.

◆ ExitMode()

void ExitMode ( IObjParam ip)
overridevirtual
Remarks
Called when the mode is exited. The developer may provide any post-processing here.
Parameters:
IObjParam *ip

An interface pointer available to call functions defined by 3ds Max.

Reimplemented from PickModeCallback.

Member Data Documentation

◆ pick_filter

PickerControlFilter* pick_filter

◆ msg

MSTR msg

◆ picker

PickerControl* picker