HOpSelectArea Class Reference

The HOpSelectArea class computes a selection list for objects inside a rectangular area. More...

#include <HOpSelectArea.h>

Public Member Functions
virtual HBaseOperator *	Clone ()
virtual const char *	GetName ()
	HOpSelectArea (HBaseView *view, int DoRepeat=0, int DoCapture=1)
virtual int	OnLButtonDown (HEventInfo &hevent)
virtual int	OnLButtonUp (HEventInfo &hevent)
Public Member Functions inherited from HOpConstructRectangle
	HOpConstructRectangle (HBaseView *view, int DoRepeat=0, int DoCapture=1, bool UseCenterMarker=true)
virtual int	OnLButtonDownAndMove (HEventInfo &hevent)
virtual int	OnRButtonUp (HEventInfo &hevent)
Public Member Functions inherited from HBaseOperator
int	Capture ()
	Returns whether we are currently in mouse capture mode. See this class' constructor for a more detailed description of what this means. This method has been deprecated.
HPoint const	GetFirstPoint ()
	Returns the initial selection point.
HPoint const	GetNewPoint ()
	Returns the current selection point.
HBaseView *	GetView ()
	Returns a pointer to the view that this operator is associated with.
	HBaseOperator (HBaseView *view, int DoRepeat=0, int DoCapture=1)
virtual int	OnKeyDown (HEventInfo &hevent)
virtual int	OnKeyUp (HEventInfo &hevent)
virtual int	OnLButtonDblClk (HEventInfo &hevent)
virtual int	OnLRButtonDownAndMove (HEventInfo &hevent)
virtual int	OnMButtonDblClk (HEventInfo &hevent)
virtual int	OnMButtonDown (HEventInfo &hevent)
virtual int	OnMButtonDownAndMove (HEventInfo &hevent)
virtual int	OnMButtonUp (HEventInfo &hevent)
virtual int	OnMouseMove (HEventInfo &hevent)
virtual int	OnMouseWheel (HEventInfo &hevent)
virtual int	OnNoButtonDownAndMove (HEventInfo &hevent)
virtual int	OnRButtonDblClk (HEventInfo &hevent)
virtual int	OnRButtonDown (HEventInfo &hevent)
virtual int	OnRButtonDownAndMove (HEventInfo &hevent)
virtual int	OnTimer (HEventInfo &hevent)
virtual int	OnTouchesDown (HEventInfo &hevent)
virtual int	OnTouchesMove (HEventInfo &hevent)
virtual int	OnTouchesUp (HEventInfo &hevent)
virtual bool	OperatorStarted ()
	Operator has been started if true, and has not been started if false.
int	Repeat ()
	Returns whether the operation is repeatable. This method has been deprecated.
void	SetFirstPoint (HPoint const &new_point)
	Sets the initial selection point.
void	SetMapTouchesToMouseEvents (bool val)
	Touch Events are mapped to mouse events if true, and are not if false.
void	SetNewPoint (HPoint const &new_point)
	Sets the current selection point.
void	SetOperatorStarted (bool val)
	Operator has been started if true, and has not been started if false.
void	SetView (HBaseView *new_view)
	Sets the view that this operator is associated with.

Additional Inherited Members
Protected Member Functions inherited from HBaseOperator
bool	IsSpecialKey (HC_KEY key)
Protected Attributes inherited from HOpConstructRectangle
bool	m_bRectangleExists
char	m_pSavedColor [MVO_BUFFER_SIZE]
char	m_pSavedVisibility [MVO_BUFFER_SIZE]
HPoint	m_ptRectangle [2]
Protected Attributes inherited from HBaseOperator
bool	m_bMapTouchesToMouseEvents
	Indicates if touch events are mapped to mouse events.
bool	m_bOpStarted
	Indicates whether the operator has already 'started'. More...
int	m_doCapture
	Integer indicating whether to capture mouse on button down and release on button up. This parameter has been deprecated.
int	m_doRepeat
	Integer indicating if the operator is repeatable . This parameter has been deprecated.
HPoint	m_ptFirst
	Initial selection point.
HPoint	m_ptNew
	Current selection point.
HBaseView *	m_pView
	The HOOPS view corresponding to this operator.
HCutGeometryVisibility	m_TempCutGeometryVisibility
	stores original cut geometry visibility
HShadowMode	m_TempShadowMode
	stores original shadow mode

Detailed Description

The HOpSelectArea class computes a selection list for objects inside a rectangular area.

HOpSelectArea employs all of the drawing functionality of HOpConstructRectangle to define a temporary, overlayed rectangular selection area, then maps the rectangle information to the HOOPS routine HC_Compute_Selection_By_Area. This class provides the basic functionality for window selection. The operation consists of the following steps:

1. Left Button Down: first point of rectangle
2. Left Button Down and Drag: rubberband rectangle to desired dimensions
3. Left Button Up: rectangled completed and flushed from scene, selection list computed, objects highlighted, operation ended

More Detailed Description: see event methods

Constructor & Destructor Documentation

HOpSelectArea()

HOpSelectArea::HOpSelectArea	(	HBaseView *	view,
		int	DoRepeat = 0,
		int	DoCapture = 1
	)

Constructs an HOpSelectArea object

Parameters

view	A pointer to an HBaseView object
DoRepeat	An integer denoting whether this is a repeatable operator. This parameter has been deprecated.
DoCapture	An integer denoting whether the mouse state should be captured, which means that all mouse events should be received after a mousedown, even if it leaves the window. This parameter has been deprecated.

Member Function Documentation

Clone()

virtual HBaseOperator* HOpSelectArea::Clone ( )

virtual

Creates a new operator which is associated with the same view as the current operator. The user is responsible for deleting the newly created operator.

Returns

A pointer to a copy of this operator

Reimplemented from HOpConstructRectangle.

Reimplemented in HOpSelectAreaOOC< SelectionSet >.

GetName()

virtual const char* HOpSelectArea::GetName ( )

virtual

Returns

A pointer to a character string denoting the name of the operator which is 'HOpSelectArea'.

Reimplemented from HOpConstructRectangle.

Reimplemented in HOpSelectAreaOOC< SelectionSet >.

OnLButtonDown()

virtual int HOpSelectArea::OnLButtonDown ( HEventInfo &  hevent )

virtual

This method calls through to HOpConstructRectangle's OnLButtonDown method to record the first point and initiates the rectangle drawing mechanism. Then it sets attribute values for color and visibility that are specific to the selection by area.

Parameters

hevent

An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

Reimplemented from HOpConstructRectangle.

Reimplemented in HOpSelectAreaOOC< SelectionSet >.

Referenced by HOpSelectAreaOOC< SelectionSet >::OnLButtonDown().

OnLButtonUp()

virtual int HOpSelectArea::OnLButtonUp ( HEventInfo &  hevent )

virtual

This method maps rectangle information from HOpConstructRectangle into the HOOPS routine HC_Compute_Selection_By_Area to update the selection set in the associated view. It also deselects any selection items that are not present in the current selection list.

Parameters

hevent

An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

Reimplemented from HOpConstructRectangle.

Reimplemented in HOpSelectAreaOOC< SelectionSet >.

Referenced by HOpSelectAreaOOC< SelectionSet >::OnLButtonUp().

---

The documentation for this class was generated from the following file:

• HOpSelectArea.h