PickObjectProc Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class IMtlParams, Class INode.

Description:

This class is available in release 2.0 and later only.

This is the callback object passed to IMtlParams::SetPickMode(). It gets set so the user can pick objects in the scene. Its methods allow for filtering the picks, changing cursors over valid hits, and allowing multiple picks.

All methods of this class are virtual.

#include <imtl.h>

Inheritance diagram for PickObjectProc:

List of all members.

Public Member Functions
virtual	~PickObjectProc ()
virtual BOOL	Pick (INode *node)=0
virtual BOOL	Filter (INode *node)=0
virtual void	EnterMode ()
virtual void	ExitMode ()
virtual HCURSOR	GetDefCursor ()
virtual HCURSOR	GetHitCursor ()
virtual BOOL	AllowMultiSelect ()

---

Constructor & Destructor Documentation

virtual ~PickObjectProc

(

)

[inline, virtual]

Remarks:

Destructor.

{;}

---

Member Function Documentation

virtual BOOL Pick

(

INode *

node

)

[pure virtual]

Search for all occurrences

Remarks:

This method is called when the user picks something.

Parameters:

INode *node

This is the node that was selected.

Returns:

Return TRUE to end the pick mode; FALSE to ignore the pick and to continue to allow the user to pick.

virtual BOOL Filter

(

INode *

node

)

[pure virtual]

Search for all occurrences

Remarks:

This method is called to allow the callback to filter hits. It should return TRUE if this is an acceptable hit; FALSE otherwise.

Parameters:

INode *node

This is the node that was selected.

virtual void EnterMode

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method is called when the pick mode has been entered. The developer may provide any pre-processing here.

Default Implementation:

{}

{}

virtual void ExitMode

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method is called when the pick mode has been exited. The developer may provide any post-processing here.

Default Implementation:

{}

{}

virtual HCURSOR GetDefCursor

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method is called to get the default (non-hit) cursor to use.

Returns:

The handle of the non-pickable object cursor or NULL if the default cursor should be used.

Default Implementation:

{return NULL;}

{return NULL;}

virtual HCURSOR GetHitCursor

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method is called to get the pickable object cursor to use.

Returns:

The handle of the pickable object cursor or NULL if the default cursor should be used.

Default Implementation:

{return NULL;}

{return NULL;}

virtual BOOL AllowMultiSelect

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method determines if multiple objects can be picked. Returning TRUE allows the user to pick more than one thing. In this case the Pick() method may be called more than once.

Default Implementation:

{return FALSE;}

{return FALSE;}